Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Purchase Order → Get List

AI-generated

Summary

Retrieve a filtered list of Purchase Orders from the Acumatica API using various optional criteria.

Inputs

  • Base Currency ID Filter — Filter results by Base Currency ID using operators Equals, Contains, or Starts With.
  • Branch Filter — Filter results by Branch using operators Equals, Contains, or Starts With.
  • Control Total Filter — Filter results by Control Total with numeric comparison operators (Equals, Greater Than, Greater Than or Equal, Less Than, Less Than or Equal).
  • Currency ID Filter — Filter results by Currency ID with string operators Equals, Contains, or Starts With.
  • Currency Effective Date Filter — Filter results by Currency Effective Date using date/time comparison operators (Equals, After, On or After, Before, On or Before).
  • Currency Rate Filter — Filter results by Currency Rate with numeric comparison operators.
  • Currency Rate Type ID Filter — Filter results by Currency Rate Type ID with string comparison operators.
  • Currency Reciprocal Rate Filter — Filter results by Currency Reciprocal Rate with numeric comparison operators.
  • Date Filter — Filter results by Date using date/time comparison operators.
  • Description Filter — Filter results by Description with string comparison operators.
  • Hold Filter — Filter results by Hold status (boolean, only Equals operator).
  • Is Tax Valid Filter — Filter results by tax validity status (boolean, only Equals operator).
  • Last Modified Date Time Filter — Filter results by Last Modified Date Time using date/time comparison operators.
  • Line Total Filter — Filter results by Line Total with numeric comparison operators.
  • Location Filter — Filter results by Location with string comparison operators.
  • Order Nbr Filter — Filter results by Order Number with string comparison operators.
  • Order Total Filter — Filter results by Order Total with numeric comparison operators.
  • Owner Filter — Filter results by Owner with string comparison operators.
  • Project Filter — Filter results by Project with string comparison operators.
  • Promised On Filter — Filter results by Promised On date using date/time comparison operators.
  • Status Filter — Filter results by Status with string comparison operators.
  • Tax Total Filter — Filter results by Tax Total with numeric comparison operators.
  • Terms Filter — Filter results by Terms with string comparison operators.
  • Type Filter — Filter results by Type with string comparison operators.
  • Vendor ID Filter — Filter results by Vendor ID with string comparison operators.
  • Vendor Ref Filter — Filter results by Vendor Reference with string comparison operators.
  • Vendor Tax Zone Filter — Filter results by Vendor Tax Zone with string comparison operators.
  • Custom Filter — Advanced OData $filter expression to apply additional filtering criteria beyond the predefined filters.

Output shape

a list of Purchase Order records matching the specified filters

The list includes Purchase Order fields matching the applied filters. Multiple filter criteria are combined with logical AND. The custom OData filter expression is applied in addition to other filters. Pagination or limits are not specified; the output depends on API behavior.

Examples

Example 1: Filter Purchase Orders by Vendor ID equals 'VEND001' and Status contains 'Open'

User sets 'Vendor ID Filter' with operator 'Equals' and value 'VEND001', sets 'Status Filter' with operator 'Contains' and value 'Open'. The operation returns all Purchase Orders matching these criteria.

Links

Discussion