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 → Insert/Update

AI-generated

Summary

Insert or update Payroll Batch records in Acumatica via the API by providing detailed payroll batch data including deductions and benefits, earnings, employee summaries, and overtime rules.

Inputs

  • Deductions And Benefits Details — Multiple detailed items describing individual deductions and benefits within the payroll batch, such as amounts, codes, percentages, and related metadata.
  • Earning Details — Multiple detailed earning entries for the payroll batch including employee, amounts, accounts, dates, and classification details.
  • Employee Summary — Multiple employee summary items containing aggregated payroll data per employee, including amounts, hours, rates, and paycheck references.
  • Overtime Rules — Configuration to apply overtime rules to the payroll batch with details such as days of week, multipliers, and thresholds.
  • Additional Fields — Optional fields to specify additional payroll batch details such as batch ID, description, hold status, pay group and period, total earnings and hours, payroll type, status, and transaction dates.

Output shape

A single record representing the created or updated payroll batch object from Acumatica.

The operation accepts multiple complex nested collections, and the returned record reflects the corresponding resource as handled by Acumatica API. There is no pagination for this operation as it acts on single resource instances per execution.

Examples

Example 1: Create a new payroll batch with detailed earning and deduction info for multiple employees.

Provide the Payroll Batch fields including Deductions And Benefits Details, Earning Details, and Employee Summary with appropriate values per item, optionally configuring overtime rules and additional metadata fields.

Links

Discussion