Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Pro Forma Invoice → Get List

AI-generated

Summary

Retrieve a filtered list of Pro Forma Invoice records from Acumatica using various optional filter criteria and an advanced custom OData filter expression.

Inputs

  • Amount Due Filter — Filter invoices by Amount Due using operators like equals, greater than, less than, etc.
  • Currency ID Filter — Filter invoices by Currency ID with operators equals, contains, or starts with.
  • Customer ID Filter — Filter invoices by Customer ID with operators equals, contains, or starts with.
  • Description Filter — Filter invoices by Description with operators equals, contains, or starts with.
  • Effective Date Filter — Filter invoices by Effective Date using date comparison operators.
  • External Ref Nbr Filter — Filter invoices by External Reference Number with operators equals, contains, or starts with.
  • Hold Filter — Filter invoices based on Hold status (boolean).
  • Invoice Date Filter — Filter invoices by Invoice Date using date comparison operators.
  • Invoice Total Filter — Filter invoices by Invoice Total using numeric comparison operators.
  • Last Modified Date Time Filter — Filter invoices by last modification date and time using date comparison operators.
  • Location Filter — Filter invoices by Location with operators equals, contains, or starts with.
  • Post Period Filter — Filter invoices by Post Period with operators equals, contains, or starts with.
  • Progress Billing Total Filter — Filter invoices by Progress Billing Total using numeric comparison operators.
  • Project ID Filter — Filter invoices by Project ID with operators equals, contains, or starts with.
  • Ref Nbr Filter — Filter invoices by Reference Number with operators equals, contains, or starts with.
  • Retainage Total Filter — Filter invoices by Retainage Total using numeric comparison operators.
  • Status Filter — Filter invoices by Status with operators equals, contains, or starts with.
  • Tax Total Filter — Filter invoices by Tax Total using numeric comparison operators.
  • Time And Material Total Filter — Filter invoices by Time and Material Total using numeric comparison operators.
  • Custom Filter — Apply an advanced OData $filter expression string to further filter the list of Pro Forma Invoices.

Output shape

a list of Pro Forma Invoice records matching the specified filters

Filters are applied in combination to construct an OData $filter query string. The returned data shape corresponds to Acumatica's Pro Forma Invoice resource representation.

Examples

Example 1: Get all Pro Forma Invoices with Amount Due greater than 1000 and Status containing 'Open'

Set Amount Due Filter operator to 'Greater Than' and value to 1000; set Status Filter operator to 'Contains' and value to 'Open'. Leave other filters empty.

Example 2: Get Pro Forma Invoices with Invoice Date on or after 2024-01-01 and Customer ID starting with 'CUST'

Set Invoice Date Filter operator to 'On or After' and value to 2024-01-01; set Customer ID Filter operator to 'Starts With' and value to 'CUST'.

Links

Discussion