v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

GL Reports

Create a GL report

Triggers generation of a General Ledger report for the given payroll run and type. Returns immediately with a pending report — poll show until status is completed, then call download.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage payroll runs (payroll)	View payroll runs (payroll_run:read)	-

post/v1/payroll-runs/{payroll_run_id}/gl-reports

Path parameters

payroll_run_idstring required

The payroll run's ID

Request body

type'summary' | 'by_department' | 'employee_detail' required

The type of GL report to generate.

Example request

{
  "type": "summary"
}

Response

Success

Example response

{
  "data": {
    "gl_report": {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "inserted_at": "2026-01-01T00:00:00Z",
      "status": "pending",
      "type": "summary"
    }
  }
}