Acumatica API - Endpoint Default 25 200 001 icon

Acumatica API - Endpoint Default 25 200 001

Interact with Acumatica Endpoint Default/25.200.001

Actions478

Financial Period → Get List

AI-generated

Summary

Retrieve a filtered list of Financial Period records from the Acumatica ERP system.

Inputs

  • Created Date Time Filter — Filter results by the Created Date Time using operators like equals, after, before, etc.
  • Financial Year Filter — Filter results by the Financial Year with operators such as equals, contains, or starts with.
  • Last Modified Date Time Filter — Filter results by Last Modified Date Time using comparison operators.
  • Start Date Filter — Filter results by the Start Date using comparison operators like equals, after, before, etc.
  • User Defined Periods Filter — Filter results by whether periods are user-defined, only supports equality operator.
  • Custom Filter — Advanced OData $filter expression to apply alongside any other filters, e.g., "CustomerID/value eq 'CUST001'".

Output shape

a list of Financial Period records matching the applied filters

Supports filtering by multiple predefined fields and an advanced custom OData $filter string. Returns all records if no filters are applied.

Examples

Example 1: Filter Financial Periods by Financial Year equals '2023' and Start Date on or after '2023-01-01'

Set Financial Year Filter operator to 'Equals' with value '2023', set Start Date Filter operator to 'On or After' with value '2023-01-01' T00:00:00.

Example 2: Use a custom filter for complex queries

Specify a valid OData $filter string in 'Custom Filter' such as "contains(FinancialYear/value, '202') and StartDate/value ge 2023-01-01".

Links

Discussion