Retrieve current On-Demand Payroll

GET

/on-demand-payroll/contract/:contract_id/current

GET

/rest/on-demand-payroll/contract/:contract_id/current

curl https://api.letsdeel.com/rest/on-demand-payroll/contract/con_abc123/current \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "id": "odp_abc123",
    "sla": {
      "payment_buffer": 1,
      "payment_processing": 2,
      "payment_settlement": 3,
      "payroll_processing": 1,
      "post_termination_buffer": 30
    },
    "status": "AWAITING_CLIENT_APPROVAL",
    "entries": [
      {
        "id": "adj_abc123",
        "uom": "CURRENCY",
        "type": "BONUS",
        "title": "Q1 performance bonus",
        "amount": 150.5,
        "currency": "USD",
        "metadata": {
          "type": "BONUS",
          "reviewed_at": "2026-01-06T10:00:00Z",
          "vendor_name": "Acme Inc.",
          "category_label": "Bonus",
          "submission_date": "2026-01-04T09:00:00Z",
          "category_group_label": "Compensation",
          "source_service_entry_id": "adj_abc123"
        },
        "submitter": {
          "id": "p_abc123",
          "name": "John Doe"
        },
        "description": "Bonus awarded for Q1 results",
        "date_of_entry": "2026-01-05"
      }
    ],
    "invoice_id": "inv_abc123",
    "submitted_at": "2026-01-01T00:00:00Z",
    "submitted_by": "Jane Doe",
    "deel_reviewed_at": "2026-01-08T12:00:00Z",
    "estimated_payday": "2026-01-10",
    "employee_payment_status": "PENDING",
    "next_available_payment_date": "2026-01-12"
  }
}

Retrieves the active On-Demand Payroll for a contract. Use it to check the current state of that payroll and to get the identifier needed to attach or detach entries, or to submit or cancel it.

Token scopes: on-demand-payroll: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.deel.training/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

Public ID (oid) of the contract.

Response

The active On-Demand Payroll for the contract.

dataobject

An On-Demand Payroll for a contract.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error