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

# Create liability report

`POST /reports/liability`

When a Liability Report is created, the report content will be created asynchronously. It may then be retrieved asynchronously from the GET endpoint using an "accept: text/csv" header.

To filter which payrolls should be included in the report, you may pass a filters object here, which may contain: `payroll_type`: One or more valid payroll `type`, as array or comma separated values. `payroll_status`: One or more valid payroll `status`, as array or comma separated values. `pay_date_from`: Limits payrolls to only from this pay-date and after. `pay_date_to`: Limits payrolls to only from this pay-date and before.

## Request body

- object
  - `business_entity_id` string — One of `business_entity_id`, `pay_schedule_id` or `payroll_id` must be set. Must be present when `pay_schedule_id` and `payroll_id` is either empty or not set.
  - `pay_schedule_id` string — One of `business_entity_id`, `pay_schedule_id` or `payroll_id` must be set. Must be present when `business_entity_id` and `payroll_id` is either empty or not set.
  - `payroll_id` string — One of `business_entity_id`, `pay_schedule_id` or `payroll_id` must be set. Must be present when `business_entity_id` and `pay_schedule_id` is either empty or not set.
  - `filters` object — Options to allow filtering the content of the report
    - `payroll_type` union
      - 'correction' | 'historical' | 'off_cycle' | 'regular'
      - string[]
    - `payroll_status` union
      - 'approved' | 'draft' | 'failed' | 'paid' | 'partially_paid' | 'processing'
      - string[]
    - `pay_date_from` string, date
    - `pay_date_to` string, date

## 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)