Acumatica API - Endpoint Default 25 200 001 icon

Acumatica API - Endpoint Default 25 200 001

Interact with Acumatica Endpoint Default/25.200.001

Actions478

Opportunity → Get List

AI-generated

Summary

Retrieve a filtered list of Opportunity records from the Acumatica API using various optional criteria.

Inputs

  • Amount Filter — Filter opportunities by Amount using operators like equals, greater than, less than, etc.
  • Branch Filter — Filter opportunities by Branch with operators such as equals, contains, or starts with.
  • Business Account Filter — Filter opportunities by Business Account with string matching operators.
  • Class ID Filter — Filter opportunities by Class ID using string match operators.
  • Contact Display Name Filter — Filter by Contact Display Name with string operators.
  • Contact ID Filter — Filter by Contact ID using numeric comparison operators.
  • Converted Lead Display Name Filter — Filter by Converted Lead Display Name with string operators.
  • Converted Lead ID Filter — Filter by Converted Lead ID using numeric comparison operators.
  • Currency ID Filter — Filter by Currency ID using string operators.
  • Currency View State Filter — Filter by Currency View State (boolean exact match).
  • Details Filter — Filter by Details text using string operators.
  • Discount Filter — Filter by Discount amount using numeric comparison operators.
  • Estimation Filter — Filter by Estimation date/time using date comparison operators.
  • Location Filter — Filter by Location using string matching operators.
  • Manual Amount Filter — Filter by Manual Amount (boolean exact match).
  • Opportunity ID Filter — Filter by Opportunity ID using string operators.
  • Override Filter — Filter by Override flag (boolean exact match).
  • Owner Filter — Filter by Owner with string match operators.
  • Owner Employee Name Filter — Filter by Owner Employee Name using string matching operators.
  • Parent Account Filter — Filter by Parent Account with string operators.
  • Project Filter — Filter by Project using string match operators.
  • Reason Filter — Filter by Reason with string matching operators.
  • Source Filter — Filter by Source using string match operators.
  • Source Campaign Filter — Filter by Source Campaign with string operators.
  • Stage Filter — Filter by Stage using string matching operators.
  • Status Filter — Filter by Status with string operators.
  • Subject Filter — Filter by Subject text using string matching operators.
  • Tax Zone Filter — Filter by Tax Zone with string operators.
  • Total Filter — Filter by Total amount using numeric comparison operators.
  • Weight Total Filter — Filter by Weight Total amount using numeric comparison operators.
  • Workgroup Description Filter — Filter by Workgroup Description using string operators.
  • Workgroup ID Filter — Filter by Workgroup ID with string matching operators.
  • Last Modified Date Time Filter — Filter by Last Modified Date Time using date/time comparison operators.
  • Custom Filter — Apply an advanced OData $filter expression string for more complex filtering criteria in addition to filters above.

Output shape

a list of Opportunity records matching the provided filters

Supports combining multiple structured filters and an optional custom OData $filter string; the returned data conforms to the Acumatica Opportunity schema.

Examples

Example 1: Retrieve all opportunities with an Amount greater than 1000 and Status containing 'Open'

Set Amount Filter operator to 'gt' and value to 1000; set Status Filter operator to 'contains' and value to 'Open'. Optionally add a customFilter for other OData expressions.

Links

Discussion