Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Pay Period → Get List

AI-generated

Summary

Fetch a list of Pay Period records filtered by optional date, group, year, and custom OData expressions.

Inputs

  • lastModifiedDateTimeFilter — Filter results by Last Modified Date Time using an operator and value (e.g., After, On or After).
  • overrideFilter — Filter results by Override with an operator (currently only Equals) and a boolean value.
  • payGroupFilter — Filter results by Pay Group using an operator (Equals, Contains, Starts With) and a string value.
  • startDateFilter — Filter results by Start Date using an operator and a dateTime value.
  • yearFilter — Filter results by Year using an operator (Equals, Contains, Starts With) and a string value.
  • customFilter — Advanced OData $filter expression applied in addition to the above filters.

Output shape

a list of Pay Period records

Results may be paginated and include only fields defined in the schema; optional fields may be omitted.

Examples

Example 1: Retrieve pay periods modified after a specific date

Set LastModifiedDateTimeFilter operator to 'gt' and value to '2024-01-01T00:00:00'

Example 2: Apply a custom OData filter for active pay periods

Enter customFilter 'IsActive/value eq true' alongside any other filter fields

Example 3: Filter by year and override status

Set Year Filter value to '2024' and Override Filter value to true

Links

Discussion