Payroll

Reading only. Nothing on this surface creates or changes a payslip.

Amounts carry their currency. A payslip that carries none — one built from a salary filed before the field was required — answers the company's own currency rather than null, so you do not have to invent that fallback yourself.

The line items are here: additions, deductions and allowances, each with its title, value and pre_tax, which is what decides whether an amount lands before tax is worked out.

loan_repaid is what was taken back against an advance. An advance is not a deduction: it becomes a loan and is repaid on scheduled days, so it never appears in deductions and a caller subtracting the line items from the total will be out by exactly this amount. The figure folds together loan repayments and one-off loan adjustments, because that is how the calculation records them.

The parts do not add up to take_home, and are not meant to. Taxes and the gross figure are not published here, so what you get is what was added, taken off and repaid — not a derivation of the total.

updated_since matters more here than anywhere: a payslip is recalculated and moves from draft to approved to paid, so without it a caller re-reads every month forever. months is YYYY-MM, and takes a list, so a quarter is one request.

get/company/v3/payroll/payslips

Request

  • Base URL: https://api.clockster.com
  • URL: https://api.clockster.com/company/v3/payroll/payslips
  • Auth: HTTP bearer

Query parameters

per_pageinteger

How many rows one page holds. Defaults to 50.

cursorstring nullable

The meta.next_cursor of the previous page. Omit it for the first. A cursor is bound to the filters it was issued under — change them and start again.

usersinteger[] nullable

Only rows belonging to these people, by id.

statusesstring[] nullable

Only rows in these states.

monthsstring[] nullable

Only these months, as YYYY-MM.

updated_sincestring date-time nullable

Only rows changed at or after this instant (ISO 8601). The cheap way to sync: ask for what moved, not for everything.

Response

Success

Changes

    • info

      the endpoint scheme security companyToken was added to the API

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the /// response's property type changed from integer to null number for status