List Scheduled Rate Changes

GET

/contracts/:contractId/scheduled-rate-changes

GET

/contracts/:contractId/scheduled-rate-changes

curl https://api.getthera.com/contracts/contractId/scheduled-rate-changes \
     -H "X-Thera-API-Key: <apiKey>"

200Retrieved

{
  "changes": [
    {
      "id": "id",
      "changeType": "changeType",
      "effectiveDate": "2023-01-15",
      "status": "PENDING",
      "createdAt": "createdAt",
      "createdByUserId": "createdByUserId",
      "note": "note",
      "oldRate": 1000000,
      "newRate": 1000000,
      "newWageType": "HOURLY",
      "newCurrency": "newCurrency",
      "newPaymentDueDays": 1,
      "newCycleEnd": {
        "type": "weekly",
        "dayOfWeek": "MONDAY"
      },
      "paymentOption": "paymentOption",
      "confirmedAmount": 1000000,
      "oldWageType": "oldWageType",
      "oldAmount": 1000000,
      "oldPeriod": "oldPeriod",
      "newAmount": 1000000,
      "newPayScheduleId": "newPayScheduleId",
      "newPeriod": "newPeriod"
    },
    {
      "id": "id",
      "changeType": "changeType",
      "effectiveDate": "2023-01-15",
      "status": "PENDING",
      "createdAt": "createdAt",
      "createdByUserId": "createdByUserId",
      "note": "note",
      "oldRate": 1000000,
      "newRate": 1000000,
      "newWageType": "HOURLY",
      "newCurrency": "newCurrency",
      "newPaymentDueDays": 1,
      "newCycleEnd": {
        "type": "weekly",
        "dayOfWeek": "MONDAY"
      },
      "paymentOption": "paymentOption",
      "confirmedAmount": 1000000,
      "oldWageType": "oldWageType",
      "oldAmount": 1000000,
      "oldPeriod": "oldPeriod",
      "newAmount": 1000000,
      "newPayScheduleId": "newPayScheduleId",
      "newPeriod": "newPeriod"
    }
  ]
}

Returns all scheduled rate changes (PENDING, APPLIED, CANCELLED) for a contract.

Authentication

X-Thera-API-Keystring

API Key authentication via header

Path parameters

contractIdstringRequired

Response

This endpoint returns an object.

changeslist of objects