Payment runs represent the execution of payroll processing for a specific payroll period. Each payment run tracks when it was created and closed/authorised
Create a payment run for a payroll
Triggers a payment run for the specified payroll identified by payrollGuid.
SecuritybearerAuth
Request
Responses
202
Payment run job has been successfully queued for processing.
The response includes a batch job resource.
Poll the batch job endpoint (/batch-jobs/{jobId}) to check for completion.
default
General Error
post/payment-runs/{payrollGuid}/paymentrun
Request samples
- Payload
- curl
- C#
- Java
- PHP
application/vnd.api+json
{- "data": {
- "type": "payment-runs",
- "attributes": {
- "payDate": "2025-12-20T00:00:00Z"
}
}
}Response samples
- 202
- default
application/vnd.api+json
{- "data": {
- "type": "batch-jobs",
- "id": "c9f53621-86c3-4e5a-97f7-56165388cf41",
- "attributes": {
- "status": "queued",
- "lastUpdatedDateTime": "2025-12-17T10:30:00Z",
- "retryAfterSeconds": 5,
- "location": null
},
}
}Get payment runs for a payroll
Retrieves payment runs for a specified payroll. By default, returns payment runs for the current payroll period. A different period can be specified using the payrollPeriod query parameter.
SecuritybearerAuth
Request
path Parameters
Responses
200
Payment Runs Response - Array
default
General Error
get/payrolls/{payrollGUID}/paymentruns
Request samples
- curl
- C#
- Java
- PHP
Response samples
- 200
- default
application/vnd.api+json
{- "data": [
- {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
- "type": "paymentRuns",
- "attributes": {
- "payrollPeriodId": 12345,
- "payrollName": "Monthly Payroll",
- "payrollGUID": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5",
- "taxPeriod": "2025/01",
- "createdDateTime": "2025-01-15T10:30:00Z",
- "closedDateTime": "2025-01-20T14:45:00Z"
},
}
]
}