Skip to main content
POST
Request a payslip bundle

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Body

application/json

POST body for requesting a payslip bundle.

period_end
string<date>
required

Last pay date to include (inclusive).

period_start
string<date>
required

First pay date to include (inclusive).

pay_group_ids
string[] | null

Pay groups whose payruns are bundled. Omit or pass null to include all pay groups for the organisation. Pass at least one ID to filter; an empty list is invalid. All matched payruns must be approved (APPROVED or PAID).

Minimum array length: 1

Response

Successful Response

POST 202 and GET 200 response.

download_url is a presigned GCS link; it is None until status reaches READY. The client polls GET with the bundle_id it received from POST.

bundle_id
string
required
payrun_ids
string[]
required
status
enum<string>
required

Report lifecycle, independent of the underlying Document's status.

Available options:
PENDING,
GENERATING,
READY,
FAILED
download_url
string | null