Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Remote GL Reports API

The GL Reports API from Remote — 3 operation(s) for gl reports.

Remote GL Reports API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include GL Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

3 operations 3 paths 9 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote GL Reports API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
  • ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
  • CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
  • OAuth2 — Authenticate using OAuth 2.0 protocol.
  • OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
  • OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
  • OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

GL Reports 3
POST
/v1/payroll-runs/{payroll_run_id}/gl-reports
Create a GL report
post_v1_payroll-runs_payroll_run_id_gl-reports 1 param body → 200401404422
GET
/v1/payroll-runs/{payroll_run_id}/gl-reports/{gl_report_id}
Show a GL report
get_v1_payroll-runs_payroll_run_id_gl-reports_gl_report_id 2 params → 200401404
GET
/v1/payroll-runs/{payroll_run_id}/gl-reports/{gl_report_id}/download
Download a GL report
get_v1_payroll-runs_payroll_run_id_gl-reports_gl_report_id_download 2 params → 200401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are GLReport (4 properties), ActionError (3 properties), ParameterError (3 properties), NotFoundResponse (1 property). Each schema is shown below with its type and property counts.

ParameterError
object
3 properties 3 required
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property 1 required
GLReportResponse
object
1 property
UnprocessableEntityResponse
object
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
GenericFile
string
A file represented as a base64-encoded string.
CreateGLReportParams
object
1 property 1 required
ActionError
object
3 properties 3 required
GLReport
object
A General Ledger report generation request and its current status.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-gl-reports-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API