List of off-cycle payments

GET

/contracts/:contract_id/off-cycle-payments

GET

/rest/contracts/:contract_id/off-cycle-payments

curl https://api.letsdeel.com/rest/contracts/abcdefg/off-cycle-payments \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": "500.00",
      "status": "approved",
      "created_at": "2024-11-25T14:30:00.000Z",
      "description": "Reimbursement for travel expenses",
      "reported_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "full_name": "Jane Doe"
      },
      "currency_code": "USD",
      "date_submitted": "2024-11-20T09:00:00.000Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": "1500.00",
      "status": "pending",
      "created_at": "2024-11-22T10:15:00.000Z",
      "description": "Bonus payment",
      "reported_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "full_name": "John Smith"
      },
      "currency_code": "EUR",
      "date_submitted": "2024-11-21T15:45:00.000Z"
    }
  ]
}

Retrieves all off-cycle payments for a specified contract. Off-cycle payments represent payments made outside the regular payment schedule, such as exceptional or one-time expenses.

Token scopes: off-cycle-payments:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired

The unique identifier (ID) of the Deel contract for which to retrieve off-cycle payments.

Response

Successful retrieval of off-cycle payments.

datalist of objects

List of off-cycle payments matching the requested contract.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error