v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Payslips

List payslips

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

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employment documents (employment_documents)	View payslips (payslip:read)	-

get/v1/payslips

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
}