Pay & Compensation
Payslips

Download payslip in the PDF format

Changed on

Given a Payslip ID, downloads a payslip. 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 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 employment documents (employment_documents)View payslips (payslip:read)-
get/v1/payslips/{payslip_id}/pdf

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/payslips/{payslip_id}/pdf
  • 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, payslip:read, employment_documents, all:write, all:read)

Path parameters

payslip_idstring required

Payslip ID

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

string binary required

The binary content of the payslip file.

Example response

"UGVyaW9kIEVuZCBEYXRlLFBheSBEYXRlLEVtcG...5jZSBPZiBSZXNpZGVuYdXJyZW50LEFsbG93"

Changes

  • 09a7e24e0df5Revision changes
    • info

      the security scope employment_documents was added to the endpoint's security scheme CustomerAPIToken

    • info

      the security scope employment_documents was added to the endpoint's security scheme OAuth2AuthorizationCode

    • info

      the security scope payroll was removed from the endpoint's security scheme CustomerAPIToken

    • info

      the security scope payroll was removed from the endpoint's security scheme OAuth2AuthorizationCode

  • 9302e7966d16Revision changes
    • info

      the security scope payroll was added to the endpoint's security scheme CustomerAPIToken

    • info

      the security scope payroll was added to the endpoint's security scheme OAuth2AuthorizationCode

    • info

      the security scope employment_documents was removed from the endpoint's security scheme CustomerAPIToken

    • info

      the security scope employment_documents was removed from the endpoint's security scheme OAuth2AuthorizationCode