Skip to main content
POST
Calculate payroll for multiple employees

Authorizations

Authorization
string
header
required

API key authentication. Send your API key as: Authorization: Bearer <your_api_key>

Body

application/json

Request body for POST /v1/payroll/batch.

Processes up to 500 employees in one request. Employees ≤ 50 are processed synchronously. Above 50 employees, set options.async=true to receive a job ID for polling.

country
string
required
Pattern: ^[A-Z]{2}$
Example:

"MX"

scheme
string
required
Example:

"ordinario"

year
integer
required
Required range: 2020 <= x <= 2030
Example:

2024

period
Period · object
required

Payroll period definition.

employer
EmployerInput · object
required

Employer-side inputs for a payroll calculation.

employees
BatchEmployeeInput · object[]
required

List of employees to calculate. 1–500 employees per request.

Required array length: 1 - 500 elements
options
BatchOptions · object

Options specific to batch requests.

Response

Batch completed synchronously.

Synchronous batch calculation response (≤50 employees).

id
string
required

Batch job ID (ULID).

country
string
required
scheme
string
required
year
integer
required
total_requested
integer
required
total_succeeded
integer
required
total_failed
integer
required
results
BatchEmployeeResult · object[]
required
computed_at
string<date-time>
required
status
string
default:completed
Allowed value: "completed"