Skip to main content
POST
/
reports
/
payroll-register
Create payroll register report
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/reports/payroll-register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payroll_id": "<id>"
}
'
{
  "id": "<id>",
  "object": "report",
  "data": {
    "type": "payroll-register",
    "business_entity": null,
    "pay_schedule": null,
    "payroll": {
      "id": "<id>",
      "object": "payroll",
      "links": {
        "self": "/payrolls/<id>"
      }
    },
    "filters": {
      "payroll_type": [
        "regular",
        "off_cycle",
        "historical",
        "correction"
      ],
      "payroll_status": null,
      "pay_date_from": null,
      "pay_date_to": null,
      "year": null
    },
    "has_results": false,
    "format": null,
    "sheet": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/reports/<id>"
  }
}

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