Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Financial Period → Get List

AI-generated

Summary

Retrieves a list of Financial Period records from Acumatica, applying optional filters.

Inputs

  • CreatedDateTimeFilter — Filter by the record's Created Date Time. Includes an operator (Equals, After, On or After, Before, On or Before) and a date‑time value.
  • FinancialYearFilter — Filter by the Financial Year. Includes an operator (Equals, Contains, Starts With) and a string value.
  • LastModifiedDateTimeFilter — Filter by the record's Last Modified Date Time. Includes an operator (Equals, After, On or After, Before, On or Before) and a date‑time value.
  • StartDateFilter — Filter by the period's Start Date. Includes an operator (Equals, After, On or After, Before, On or Before) and a date‑time value.
  • UserDefinedPeriodsFilter — Filter by the User Defined Periods flag. Includes an operator (Equals) and a boolean value.
  • customFilter — Advanced OData $filter expression (e.g. FinancialPeriodID/value eq 'FP2024') that is applied in addition to any of the filter fields above.

Output shape

array

Returns an array of Financial Period objects as supplied by the Acumatica API. Each object contains the fields defined for the Financial Period entity (e.g. FinancialPeriodID, Description, StartDate, EndDate, etc.).

Examples

Example 1: Get all financial periods for FY 2024 that started after 2024-01-01

Set FinancialYearFilter.operator = Equals, value = '2024'; set StartDateFilter.operator = gt, value = '2024-01-01T00:00:00'.

Links

Discussion