v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Reports

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

post/v1/payrolls/{payroll_uuid}/reports/general_ledger

Path parameters

payroll_uuidstring required

The UUID of the payroll

Headers

X-Gusto-API-Version'2026-06-15'

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

Request body

aggregation'default' | 'job' | 'department' | 'integration' required

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

integration_type'xero' | 'qbo' nullable

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

Response

payroll_uuidstring uuid

The UUID of the payroll record for which the report was generated.

aggregation'default' | 'job' | 'department' | 'integration'

The breakdown level used for the report.

integration_typestring nullable

The integration_type used for the report when aggregation is 'integration' (e.g., xero, qbo). Otherwise, this will be null or an empty string.

request_uuidstring uuid

UUID to use for polling the report status.