Payslips

List payslips

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 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 type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage employment documents (employment_documents)	View payslips (payslip:read)	-
Company-scoped access token (assertion)	Manage employment documents (employment_documents)	View payslips (payslip:read)	-
Customer API token	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
- 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

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

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