Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Invoice → Get List

AI-generated

Summary

Retrieve a list of invoices from the Acumatica API, optionally filtering the results by various invoice fields.

Inputs

  • Amount Filter — Filter invoices by their Amount using comparison operators (equals, greater than, less than, etc.).
  • Balance Filter — Filter invoices by their Balance using comparison operators.
  • Billing Printed Filter — Filter invoices based on whether the Billing Printed flag is set (boolean, equals).
  • Bill To Contact Override Filter — Filter invoices where Bill To Contact Override flag matches the boolean value.
  • Created Date Time Filter — Filter invoices by their Created Date Time using comparison operators (equals, after, before, etc.).
  • Customer Filter — Filter invoices by Customer ID using operators like equals, contains, or starts with.
  • Customer Order Filter — Filter invoices by Customer Order using string matching operators.
  • Date Filter — Filter invoices by Date using comparison operators.
  • Description Filter — Filter invoices by Description using string matching operators.
  • Due Date Filter — Filter invoices by Due Date using comparison operators.
  • Hold Filter — Filter invoices based on the Hold boolean flag.
  • Last Modified Date Time Filter — Filter invoices by their last modified date and time.
  • Link AR Account Filter — Filter invoices by Link AR Account with string matching operators.
  • Link Branch Filter — Filter invoices by Link Branch with string matching operators.
  • Location ID Filter — Filter invoices by Location ID with string matching operators.
  • Post Period Filter — Filter invoices by Post Period with string matching operators.
  • Project Filter — Filter invoices by Project with string matching operators.
  • Reference Nbr Filter — Filter invoices by Reference Number with string matching operators.
  • Status Filter — Filter invoices by Status with string matching operators.
  • Ship To Contact Override Filter — Filter invoices where Ship To Contact Override boolean flag matches the value.
  • Is Tax Valid Filter — Filter invoices based on whether the tax is valid (boolean).
  • Tax Total Filter — Filter invoices by Tax Total using comparison operators.
  • Terms Filter — Filter invoices by Terms with string matching operators.
  • Type Filter — Filter invoices by Type with string matching operators.
  • Custom Filter — Apply an advanced OData $filter expression string for custom filtering beyond the provided filter parameters.

Output shape

a list of invoice objects matching the applied filters

Supports filtering by multiple invoice fields via fixedCollections for operator and value pairs as well as an advanced custom OData filter string. Returns all invoices matching the combined filter criteria.

Examples

Example 1: Retrieve all invoices with 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'.

Links

Discussion