Payslips

List payslip files for the authenticated employee

Returns a paginated list of payslip files belonging to the current employee.

Authentication

This endpoint accepts any one of the following token types:

  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

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)
Employee-scoped access tokenManage employment documents (employment_documents)View payslips (payslip:read)-
Company-scoped access tokenManage employment documents (employment_documents)View payslips (payslip:read)-
get/v1/employee/payslip-files

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/employee/payslip-files
  • Auth
    • 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 OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/employment.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

Query parameters

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "payslip_files": [
    {
      "currency": {
        "code": "USD",
        "symbol": "$"
      },
      "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "name": "payslip.pdf",
      "net_salary": {
        "converted_amount": 460000,
        "converter": "Transferwise",
        "fee": "0.00",
        "rate": "0.92",
        "source_amount": 500000
      },
      "period_end": "2026-04-30",
      "period_start": "2026-04-01"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

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