Acumatica API - Endpoint Default 25 200 001 icon

Acumatica API - Endpoint Default 25 200 001

Interact with Acumatica Endpoint Default/25.200.001

Actions478

Payroll Batch → Get List

AI-generated

Summary

Retrieve a filtered list of Payroll Batch records from the Acumatica API using various filter criteria.

Inputs

  • Batch ID Filter — Filter results by the Batch ID field using operators Equals, Contains, or Starts With.
  • Description Filter — Filter results by the Description field using operators Equals, Contains, or Starts With.
  • Hold Filter — Filter results by the Hold boolean field using the Equals operator.
  • Last Modified Date Time Filter — Filter results by the Last Modified Date Time using operators Equals, After, On or After, Before, or On or Before.
  • Numberof Employees Filter — Filter results by the Number of Employees using operators Equals, Greater Than, Greater Than or Equal, Less Than, or Less Than or Equal.
  • Pay Group Filter — Filter results by the Pay Group field using operators Equals, Contains, or Starts With.
  • Pay Period Filter — Filter results by the Pay Period field using operators Equals, Contains, or Starts With.
  • Total Earnings Filter — Filter results by the Total Earnings numeric field using operators Equals, Greater Than, Greater Than or Equal, Less Than, or Less Than or Equal.
  • Total Hour Qty Filter — Filter results by the Total Hour Quantity numeric field using operators Equals, Greater Than, Greater Than or Equal, Less Than, or Less Than or Equal.
  • Payroll Type Filter — Filter results by the Payroll Type field using operators Equals, Contains, or Starts With.
  • Period End Filter — Filter results by the Period End date/time using operators Equals, After, On or After, Before, or On or Before.
  • Period Start Filter — Filter results by the Period Start date/time using operators Equals, After, On or After, Before, or On or Before.
  • Status Filter — Filter results by the Status field using operators Equals, Contains, or Starts With.
  • Transaction Date Filter — Filter results by the Transaction Date date/time using operators Equals, After, On or After, Before, or On or Before.
  • Custom Filter — Provide an advanced OData $filter expression string to apply in addition to any specified filters.

Output shape

a list of PayrollBatch records returned from the Acumatica API matching the specified filter criteria

Filters are constructed into an OData $filter string and applied server-side; empty or default filter inputs are ignored. Custom OData filter expressions can be used for complex queries beyond the standard filters. Pagination details are not explicitly specified.

Links

Discussion