---
title: "Create payroll register report"
method: POST
path: "/reports/payroll-register"
tags: ["Reports"]
---

# Create payroll register report

`POST /reports/payroll-register`

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.

## Request body

- object
  - `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
    - `pay_date_from` string, date
    - `pay_date_to` string, date
    - `work_assignment_ids` object[]
  - `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 `201`

Created

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"report"`).
  - `data` Report
    - `type` 'cra-remittance' | 'ei-cpp-balance' | 'ei-qpp-qpip-balance' | 'employer-health-tax' | 'journal-entry' | 'journal-entry-line-item' | 'liability' | 'payroll-register' | 'rl1-preview' | 'rq-remittance' | 't4-preview' | 'vacation-accrual' | 'workers-compensation' | 'year-end-forms' | 'year-to-date'
    - `business_entity` unknown
    - `pay_schedule` unknown
    - `payroll` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"payroll"`).
    - `filters` object, nullable
    - `has_results` boolean
    - `format` 'csv' | 'pdf' | 'xlsx', nullable — The output format set at creation for `/download`. One of `csv` or `xlsx`. `null` when no format was specified — required to use `/download`.
    - `sheet` string, nullable — The sheet selected at creation for multi-sheet reports (e.g. `summary` or `detail` for Payroll Register). `null` when the report has a single sheet or no sheet was specified.
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/revisions/01cd9c45a923/schema)