v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

GL Reports

Show a GL report

Returns the current status of a GL report. Poll 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)	-

get/v1/payroll-runs/{payroll_run_id}/gl-reports/{gl_report_id}

Path parameters

payroll_run_idstring required

The payroll run's ID

gl_report_idstring required

The GL report's ID

Response

Success

Example response

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