Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Sales Order → Get List

AI-generated

Summary

Retrieve sales order list with optional filters

Inputs

  • ApprovedFilter — Filter results by Approved
  • BaseCurrencyIDFilter — Filter results by Base Currency ID
  • BillToAddressOverrideFilter — Filter results by Bill To Address Override
  • BillToAddressValidatedFilter — Filter results by Bill To Address Validated
  • BillToContactOverrideFilter — Filter results by Bill To Contact Override
  • BillToContactValidatedFilter — Filter results by Bill To Contact Validated
  • BranchFilter — Filter results by Branch
  • CashAccountFilter — Filter results by Cash Account
  • ContactIDFilter — Filter results by Contact ID
  • ControlTotalFilter — Filter results by Control Total
  • CreditHoldFilter — Filter results by Credit Hold
  • CurrencyIDFilter — Filter results by Currency ID
  • CurrencyRateFilter — Filter results by Currency Rate
  • CurrencyRateTypeIDFilter — Filter results by Currency Rate Type ID
  • CustomerIDFilter — Filter results by Customer ID
  • CustomerOrderFilter — Filter results by Customer Order
  • DateFilter — Filter results by Date
  • DescriptionFilter — Filter results by Description
  • DestinationWarehouseIDFilter — Filter results by Destination Warehouse ID
  • DisableAutomaticDiscountUpdateFilter — Filter results by Disable Automatic Discount Update
  • DisableAutomaticTaxCalculationFilter — Filter results by Disable Automatic Tax Calculation
  • EffectiveDateFilter — Filter results by Effective Date
  • ExternalRefFilter — Filter results by External Ref
  • HoldFilter — Filter results by Hold
  • IsTaxValidFilter — Filter results by Is Tax Valid
  • LastModifiedFilter — Filter results by Last Modified
  • LocationIDFilter — Filter results by Location ID
  • MaxRiskScoreFilter — Filter results by Max Risk Score
  • OrderedQtyFilter — Filter results by Ordered Qty
  • OrderNbrFilter — Filter results by Order Nbr
  • OrderTotalFilter — Filter results by Order Total
  • OrderTypeFilter — Filter results by Order Type
  • PaymentMethodFilter — Filter results by Payment Method
  • PreferredWarehouseIDFilter — Filter results by Preferred Warehouse ID
  • ProjectFilter — Filter results by Project
  • ReciprocalRateFilter — Filter results by Reciprocal Rate
  • RequestedOnFilter — Filter results by Requested On
  • ShipToAddressOverrideFilter — Filter results by Ship To Address Override
  • ShipToAddressValidatedFilter — Filter results by Ship To Address Validated
  • ShipToContactOverrideFilter — Filter results by Ship To Contact Override
  • ShipToContactValidatedFilter — Filter results by Ship To Contact Validated
  • ShipViaFilter — Filter results by Ship Via
  • StatusFilter — Filter results by Status
  • TaxTotalFilter — Filter results by Tax Total
  • VATExemptTotalFilter — Filter results by VAT Exempt Total
  • VATTaxableTotalFilter — Filter results by VAT Taxable Total
  • ExternalOrderOriginalFilter — Filter results by External Order Original
  • ExternalRefundRefFilter — Filter results by External Refund Ref
  • WillCallFilter — Filter results by Will Call
  • PaymentRefFilter — Filter results by Payment Ref
  • UsrExternalOrderOriginalFilter — Filter results by Usr External Order Original
  • ExternalOrderOriginFilter — Filter results by External Order Origin
  • ExternalOrderSourceFilter — Filter results by External Order Source
  • TaxCalcModeFilter — Filter results by Tax Calc Mode
  • CreatedDateFilter — Filter results by Created Date
  • customFilter — Custom OData $filter expression (e.g., CustomerID/value eq 'CUST001' or OrderDate/value gt 2024-01-01T00:00:00).

Output shape

a list of Sales Order records

Pagination may be required for large result sets; response contains only fields defined in the Sales Order schema.

Examples

Example 1: Filter by order status and date

Set StatusFilter operator eq 'Open' and EffectiveDateFilter value 2024-01-01T00:00:00; optionally add customFilter 'Status eq "Open" and CreatedDate/value ge 2024-01-01T00:00:00'.

Example 2: Retrieve all sales orders

Leave all filter fields empty; the node returns the full list, subject to server pagination.

Example 3: Get orders for a specific customer

Set CustomerIDFilter operator eq and Value 'CUST001'.

Links

Discussion