Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Payroll Batch → Get List

AI-generated

Summary

Retrieve a list of Payroll Batches from the Acumatica API, optionally filtering the results by various Payroll Batch fields using precise or partial matching.

Inputs

  • Batch ID Filter — Filter results by exact match, containment, or starting substring of the Batch ID.
  • Description Filter — Filter results by exact match, containment, or starting substring of the Description field.
  • Hold Filter — Filter results by whether the Hold flag is set (true or false).
  • Last Modified Date Time Filter — Filter results by last modified date and time, using operators like equals, after, on or after, before, or on or before a specified datetime.
  • Numberof Employees Filter — Filter results based on the number of employees, supporting comparison operators such as equals, greater than, greater than or equal, less than, or less than or equal.
  • Pay Group Filter — Filter results by the Pay Group field with options to match exactly, contain, or start with a string.
  • Pay Period Filter — Filter results by the Pay Period with exact, contains, or starts with string matching.
  • Total Earnings Filter — Filter results by the Total Earnings amount, supporting numeric comparison operators (equals, greater than, etc.).
  • Total Hour Qty Filter — Filter results by the total hour quantity, using numeric operators such as equals, greater than, and less than.
  • Payroll Type Filter — Filter results by Payroll Type with exact, contains, or starts with matching.
  • Period End Filter — Filter results by Period End date with operators for equals, before, after, on or before, and on or after.
  • Period Start Filter — Filter results by Period Start date using date operators similar to Period End.
  • Status Filter — Filter results by Status string field with exact, contains, or starts with matching.
  • Transaction Date Filter — Filter results by Transaction Date with date comparison operators (equals, greater than, less than, etc.).
  • Custom Filter — Provide an advanced OData $filter expression string to further refine the query beyond the predefined filters.

Output shape

a list of Payroll Batch records

The response contains zero or more Payroll Batch entries matching all specified filters combined. Advanced filtering can be achieved with the Custom Filter input as an OData $filter expression.

Links

Discussion