Sign in

v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Reports

Create payroll register report

When a Payroll Register Report is created, the report content will be created asynchronously. It may then be retrieved from GET /reports/{id}/download, or from GET /reports/{id} with an Accept: text/csv header.

post/reports/payroll-register

Request body

pay_schedule_idstring

Must be present when payroll_id is either empty or not set.

payroll_idstring

Must be present when pay_schedule_id is either empty or not set.

format'csv' | 'xlsx'

Sets the output format for /download: csv or xlsx. Required to use /download.

sheet'detail' | 'summary'

For multi-sheet reports, selects which sheet /download returns. Payroll Register supports summary or detail.

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

The type of the object in Nmbr ("report").