Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Pay Items

List Pay Items

Lists pay items for a company with optional filtering by employment, date range, and pagination.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage payroll runs (payroll)View pay items (pay_item:read)Manage pay items (pay_item:write)
get/v1/pay-items

Query parameters

employment_slugstring uuid

Identifier of the employment being terminated.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Filter by employment slug

effective_fromstring date

UTC date in ISO 8601 format

Example:2021-07-01

Filter pay items with effective_date >= given date (YYYY-MM-DD)

effective_tostring date

UTC date in ISO 8601 format

Example:2021-07-01

Filter pay items with effective_date <= given date (YYYY-MM-DD)

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "data": {
    "current_page": 1,
    "data": [
      {
        "amount": 7200,
        "code": "overtime",
        "effective_date": "2026-03-11",
        "employment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "provider_data": {
          "adjustment_effective_date": "2026-03-15",
          "hourly_rate": 2550,
          "hourly_rate_currency_code": "SGD",
          "is_deduction": false,
          "pay_rate": 1.5,
          "payout_amount": 1500000,
          "payout_currency_code": "SGD",
          "shift_code": "DAY",
          "work_day_duration": 28800
        }
      }
    ],
    "total_count": 1,
    "total_pages": 1
  }
}