Pay & Compensation
GL Reports

Create a GL report

Changed on

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.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage payroll runs (payroll)View payroll runs (payroll_run:read)-
post/v1/payroll-runs/{payroll_run_id}/gl-reports

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/payroll-runs/{payroll_run_id}/gl-reports
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, payroll_run:read, payroll, all:write, all:read)

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"
    }
  }
}

Changes