Skip to main content
POST
Calculate Payrun

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Headers

X-Include-Execution-History
boolean
default:false

Path Parameters

organization_id
string
required
payrun_id
string
required

Body

application/json
employee_ids
string[] | null

The employees to calculate, each one of the run's employees. Omit to calculate all of them. A SUPPLEMENTARY run's employees are those holding pay items in it, and so are a positive pay MAIN run's. A net change MAIN run's are those holding pay items in it and the members of its pay group that no supplementary run of the period pays instead, paid from standing compensation.

Minimum array length: 1
message
string | null

Employer message for this payrun, shown on every payslip it produces. Omit to keep the message of the run's current payslips (the most recently calculated one's, if they differ).

Maximum string length: 500

Response

Successful Response

payroll_status_id
string
required
status
enum<string>
required

Payrun status

Available options:
DRAFT,
PROCESSING,
APPROVED,
PAID,
CANCELLED
task_id
string
required