Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Opportunity → Get List

AI-generated

Summary

Retrieves a list of Opportunity records filtered by supplied criteria.

Inputs

  • amountFilter — Filter results by Amount
  • branchFilter — Filter results by Branch
  • businessAccountFilter — Filter results by Business Account
  • classIDFilter — Filter results by Class ID
  • contactDisplayNameFilter — Filter results by Contact Display Name
  • contactIDFilter — Filter results by Contact ID
  • convertedLeadDisplayNameFilter — Filter results by Converted Lead Display Name
  • convertedLeadIDFilter — Filter results by Converted Lead ID
  • currencyIDFilter — Filter results by Currency ID
  • currencyViewStateFilter — Filter results by Currency View State
  • detailsFilter — Filter results by Details
  • discountFilter — Filter results by Discount
  • estimationFilter — Filter results by Estimation
  • locationFilter — Filter results by Location
  • manualAmountFilter — Filter results by Manual Amount
  • opportunityIDFilter — Filter results by Opportunity ID
  • overrideFilter — Filter results by Override
  • ownerFilter — Filter results by Owner
  • ownerEmployeeNameFilter — Filter results by Owner Employee Name
  • parentAccountFilter — Filter results by Parent Account
  • projectFilter — Filter results by Project
  • reasonFilter — Filter results by Reason
  • sourceFilter — Filter results by Source
  • sourceCampaignFilter — Filter results by Source Campaign
  • stageFilter — Filter results by Stage
  • statusFilter — Filter results by Status
  • subjectFilter — Filter results by Subject
  • taxZoneFilter — Filter results by Tax Zone
  • totalFilter — Filter results by Total
  • weightTotalFilter — Filter results by Weight Total
  • workgroupDescriptionFilter — Filter results by Workgroup Description
  • workgroupIDFilter — Filter results by Workgroup ID
  • lastModifiedDateTimeFilter — Filter results by Last Modified Date Time
  • customFilter — Advanced OData $filter expression (e.g. CustomerID/value eq 'CUST001'). Applied in addition to any filter fields above.

Output shape

list of Opportunity records

May be paginated; empty list if no matches; successful response contains HTTP 200 with record array.

Examples

Example 1: Get all active opportunities with amount greater than 5000

Set AmountFilter operator to gt and value to 5000; optionally set StatusFilter to eq 'Active'

Example 2: Export opportunities created in the last month

Use EstimationFilter with operator ge and value set to date one month ago; add CustomFilter if needed

Example 3: Retrieve a single opportunity by its ID

Set OpportunityIDFilter operator eq and value to the desired ID

Links

Discussion