NMnmbr
Reports

Retrieve a report

Changed on

This endpoint allows you to retrieve the data associated with a specific report. Use the ULID provided when the report was originally generated to make the request.

To download the report in CSV format, include the Accept header with the value text/csv in your request. Alternatively, the rendered file can be retrieved from GET /reports/{id}/download using the format and sheet supplied at creation.

get/reports/{report}

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Path parameters

reportstring required

Query parameters

sheetstring

Specify the report sheet you want to retrieve when requesting the CSV format. When sheet was supplied at creation, that value takes precedence and this query param is ignored. Multi-sheet reports whose sheets hold unrelated data (Year-End Forms) require it for a CSV request.

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes