Skip to main content
POST
Create payroll register report

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
pay_schedule_id
string

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

payroll_id
string

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

filters
object
format
enum<string>

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

Available options:
csv,
xlsx
sheet
enum<string>

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

Available options:
detail,
summary

Response

201 - application/json

Created

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

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

data
Report ยท object