Create a general ledger report

Create a general ledger report for a payroll. The report can be aggregated by different dimensions such as job or department.

Use the request_uuid in the response with the report GET endpoint to poll for the status and report URL upon completion. The retrieved report will be generated in a JSON format.

scope: company_reports:write OR company_reports:write:general_ledger

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The UUID of the payroll

Body Params
string
enum
required

The breakdown of the report. Use 'default' for no split.

Allowed:
string | null
enum

The kind of integration set up for the company. Required when aggregation is 'integration'. Must be null if aggregation is not 'integration'.

Allowed:
Headers
string
enum
Defaults to 2026-02-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:
Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json