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.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage payroll runs (payroll)	View payroll runs (payroll_run:read)	-
Company-scoped access token (assertion)	Manage payroll runs (payroll)	View payroll runs (payroll_run:read)	-
Customer API token	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
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: payroll_run:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: payroll_run:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

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

No recorded changes to this operation across all 1 revision of this API.