Pay & Compensation
Payslips

List payslips

Changed on

Lists all payslips belonging to a company. Can also filter for a single employment belonging to that company.

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

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/payslips
  • 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)

Query parameters

employment_idstring

Employment ID

start_datestring

Filters by payslips issued_at field, after or on the same day than the given date

end_datestring

Filters by payslips issued_at field, before or or the same day than the given date

expected_payout_start_datestring

Filters by payslips expected_payout_date field, after or on the same day than the given date

expected_payout_end_datestring

Filters by payslips expected_payout_date field, before or or the same day than the given date

pageinteger

Starts fetching records after the given page

page_sizeinteger

Change the amount of records returned per page, defaults to 20, limited to 100

Response

Success

Example response

{
  "current_page": 1,
  "payslips": [
    {
      "employment_id": "98d3f-employment-id-1oi45n",
      "expected_payout_date": "2021-07-01",
      "id": "93t3j-employment-id-9suej43",
      "issued_at": "2021-07-01",
      "net_pay_converted_amount": 1500000,
      "net_pay_source_amount": 1000000
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

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

  • a7aa0c0e220bRevision changes
    • breaking

      the response property /// became nullable for the status