Retrieve a list of supplemental pay integrations

GET 
/odata/v2/SupplementalPayIntegration

Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.

Request

Query Parameters

$skip number

Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip

Responses

200

OK

application/json

Schema

Schema

value

object[]

nullable

required

Array [

supplementalPayId stringnullable

version int32

employeeId stringnullable

supplementalPayCodeName stringnullable

transDate date-time

payrollUpdateStatus int32

payrollDateTime date-timenullable

correction boolean

rate double

note stringnullable

description stringnullable

externalStatus int32

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

employee

object

employeeId stringnullable

externalReference stringnullable

initials stringnullable

email stringnullable

nameFirstName stringnullable

nameMiddleName stringnullable

nameLastName stringnullable

nameFullName stringnullable

hiredDate date-timenullable

seniorityDate date-timenullable

terminatedDate date-timenullable

position

object

positionId stringnullable

employeeId stringnullable

title stringnullable

locationId stringnullable

organizationId stringnullable

employmentCategoryName stringnullable

dimension1Id stringnullable

dimension2Id stringnullable

dimension3Id stringnullable

dimension4Id stringnullable

externalReference stringnullable

]

@odata.context stringnullable
@odata.count int32nullable
@odata.nextLink stringnullable

Example (from schema)

{
  "value": [
    {
      "supplementalPayId": "string",
      "version": 0,
      "employeeId": "string",
      "supplementalPayCodeName": "string",
      "transDate": "2026-09-10T18:14:26.860Z",
      "payrollUpdateStatus": 0,
      "payrollDateTime": "2026-09-10T18:14:26.860Z",
      "correction": true,
      "rate": 0,
      "note": "string",
      "description": "string",
      "externalStatus": 0,
      "rowNumber": 0,
      "createdBy": "string",
      "createdDateTime": "2026-09-10T18:14:26.860Z",
      "modifiedBy": "string",
      "modifiedDateTime": "2026-09-10T18:14:26.860Z",
      "versionStamp": 0,
      "documentsExists": true,
      "employee": {
        "employeeId": "string",
        "externalReference": "string",
        "initials": "string",
        "email": "string",
        "nameFirstName": "string",
        "nameMiddleName": "string",
        "nameLastName": "string",
        "nameFullName": "string",
        "hiredDate": "2026-09-10T18:14:26.860Z",
        "seniorityDate": "2026-09-10T18:14:26.860Z",
        "terminatedDate": "2026-09-10T18:14:26.860Z",
        "position": {
          "positionId": "string",
          "employeeId": "string",
          "title": "string",
          "locationId": "string",
          "organizationId": "string",
          "employmentCategoryName": "string",
          "dimension1Id": "string",
          "dimension2Id": "string",
          "dimension3Id": "string",
          "dimension4Id": "string",
          "externalReference": "string"
        }
      }
    }
  ],
  "@odata.context": "string",
  "@odata.count": 0,
  "@odata.nextLink": "string"
}

400

Bad request. Occurs if the request payload or querystring contains invalid data

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

Unauthorized

Loading...