Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Opportunity → Get List

AI-generated

Summary

Retrieve a list of Opportunity records from Acumatica, applying optional filters on various Opportunity fields to narrow results.

Inputs

  • Amount Filter — Filter opportunities by their amount using operators like Equals, Greater Than, Less Than, etc.
  • Branch Filter — Filter opportunities by branch using string matching options like Equals, Contains, or Starts With.
  • Business Account Filter — Filter opportunities associated with a specific business account by string matching.
  • Class ID Filter — Filter opportunities by Class ID using string matching operators.
  • Contact Display Name Filter — Filter opportunities by contact display name with string matching options.
  • Contact ID Filter — Filter opportunities by contact ID number with comparison operators.
  • Converted Lead Display Name Filter — Filter by converted lead display name using string matching.
  • Converted Lead ID Filter — Filter by converted lead ID number using comparison operators.
  • Currency ID Filter — Filter by currency ID using string matching.
  • Currency View State Filter — Filter by boolean currency view state (equals true or false).
  • Details Filter — Filter opportunities by details text using string matching.
  • Discount Filter — Filter by discount amount with comparison operators.
  • Estimation Filter — Filter by estimation date/time using comparison operators like Before, After, or On.
  • Location Filter — Filter by location string using matching operators.
  • Manual Amount Filter — Filter by manual amount flag (boolean equality).
  • Opportunity ID Filter — Filter opportunities by their ID string using matching operators.
  • Override Filter — Filter by override flag (boolean equality).
  • Owner Filter — Filter opportunities by owner string using matching operators.
  • Owner Employee Name Filter — Filter by owner employee name string using matching operators.
  • Parent Account Filter — Filter by parent account string using matching operators.
  • Project Filter — Filter by project string using matching operators.
  • Reason Filter — Filter by reason string using matching operators.
  • Source Filter — Filter by source string using matching operators.
  • Source Campaign Filter — Filter by source campaign string using matching operators.
  • Stage Filter — Filter by stage string using matching operators.
  • Status Filter — Filter by status string using matching operators.
  • Subject Filter — Filter by subject string using matching operators.
  • Tax Zone Filter — Filter by tax zone string using matching operators.
  • Total Filter — Filter by total amount using comparison operators.
  • Weight Total Filter — Filter by weight total amount with comparison operators.
  • Workgroup Description Filter — Filter by workgroup description string using matching operators.
  • Workgroup ID Filter — Filter by workgroup ID string using matching operators.
  • Last Modified Date Time Filter — Filter by last modified date/time using comparison operators like Before, After, or On.
  • Custom Filter — Provide an advanced OData $filter expression string applied in addition to the UI filters to refine the query.

Output shape

A list of Opportunity records matching the specified filters, each as an object with Opportunity properties.

All filters are optional; the query will combine specified filters into an OData $filter expression. The Custom Filter string is applied additionally. Returned data shape corresponds to Acumatica Opportunity resource schema.

Links

Discussion