Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Payroll Batch → Get List

AI-generated

Summary

Fetch payroll batches with optional filters

Inputs

  • BatchIDFilter — Filter results by Batch ID
  • DescriptionFilter — Filter results by Description
  • HoldFilter — Filter results by Hold
  • LastModifiedDateTimeFilter — Filter results by Last Modified Date Time
  • NumberofEmployeesFilter — Filter results by Numberof Employees
  • PayGroupFilter — Filter results by Pay Group
  • PayPeriodFilter — Filter results by Pay Period
  • TotalEarningsFilter — Filter results by Total Earnings
  • TotalHourQtyFilter — Filter results by Total Hour Qty
  • PayrollTypeFilter — Filter results by Payroll Type
  • PeriodEndFilter — Filter results by Period End
  • PeriodStartFilter — Filter results by Period Start
  • StatusFilter — Filter results by Status
  • customFilter — Custom OData $filter string (e.g. "OrderDate/value gt 2024-01-01T00:00:00")

Output shape

a list of payroll batch records

Returns a list of payroll batch records; empty list if none match; no pagination support indicated

Examples

Example 1: List batches filtered by Batch ID contains '001'

Set BatchIDFilter operator 'contains' value '001'

Example 2: List batches with hold true and custom OData filter for recent TransactionDate

Enable HoldFilter value true; set customFilter string 'TransactionDate/value gt 2024-01-01T00:00:00'

Links

Discussion