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)-
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Payslip ID

Headers
string
enum
Defaults to application/json

Generated from available response content types

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/msword
application/pdf
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/jpeg
image/png
application/json