REremote-com
Payslips

Download a payslip file

Given a Payslip ID, downloads the payslip file as raw bytes. Payslips are usually PDFs; the Content-Type header gives the file's type. The user the token acts for must have one role that can view payroll, open files and open payslip files, even when your integration doesn't enforce role permissions; otherwise the request answers 403. A payslip of an employee outside the data scope of every role that holds those permissions answers 404. It is important to note that each country has a different payslip format and they are not authored by Remote.

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 typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employment documents (employment_documents)View payslips (payslip:read)-
Company-scoped access token (assertion)Manage employment documents (employment_documents)View payslips (payslip:read)-
Customer API tokenManage employment documents (employment_documents)View payslips (payslip:read)-
get/v1/payslips/{payslip_id}/download

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/payslips/{payslip_id}/download
  • 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: payslip: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: payslip: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

payslip_idstring required

Payslip ID

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Response

Success

Changes

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