Deel: Create On-Demand Payroll
Deel onDemandPayroll.createOnDemandPayroll: arguments, response, policy and SDK examples.
← On demand payroll operations · Get started
Operation deel.ondemandpayroll_createondemandpayroll_v2026_07_28
Provider route: POST /on-demand-payroll/contract/{contract_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["onDemandPayroll"]["createOnDemandPayroll"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.onDemandPayroll.createOnDemandPayroll(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.on_demand_payroll.create_on_demand_payroll(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.contract_id | string | Required within parent | |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create On-Demand Payroll — request body — body data |
Referenced models: Create On-Demand Payroll — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create On-Demand Payroll — 201 response body |
Referenced models: Create On-Demand Payroll — 201 response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Create On-Demand Payroll — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
existing_entry_ids | array | Optional | Public IDs of existing entries (adjustments) to attach to the ODP. |
existing_entry_ids[] | string | Each item | |
salary_advance | number | Optional | Salary advance amount to include in the ODP, in the contract currency. Format: double |
Create On-Demand Payroll — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create On-Demand Payroll — 201 response body — data An On-Demand Payroll for a contract. |
Referenced models: Create On-Demand Payroll — 201 response body — data
Create On-Demand Payroll — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An On-Demand Payroll for a contract. |
deel_reviewed_at | JSON | Optional | |
deel_reviewed_at (anyOf 1) | string | Alternative | Timestamp when Deel reviewed the ODP, when reviewed. Format: date-time |
deel_reviewed_at (anyOf 2) | null | Alternative | Timestamp when Deel reviewed the ODP, when reviewed. Format: date-time |
employee_payment_status | JSON | Optional | Whether the employee has received the On-Demand Payroll payment. Null when payment tracking is not yet available for this contract. |
employee_payment_status (anyOf 1) | string | Alternative | Whether the employee has received the On-Demand Payroll payment. Null when payment tracking is not yet available for this contract. Known values: PENDING, COMPLETED |
employee_payment_status (anyOf 2) | null | Alternative | |
entries | array | Required within parent | Entries currently attached to the ODP. |
entries[] | Model | Each item | Expand Create On-Demand Payroll — 201 response body — data entries item |
estimated_payday | JSON | Optional | |
estimated_payday (anyOf 1) | string | Alternative | Estimated payday for the ODP (YYYY-MM-DD). Format: date |
estimated_payday (anyOf 2) | null | Alternative | Estimated payday for the ODP (YYYY-MM-DD). Format: date |
id | string | Required within parent | Public ID of the On-Demand Payroll. |
invoice_id | JSON | Optional | |
invoice_id (anyOf 1) | string | Alternative | Public ID of the invoice associated with the ODP, when one has been generated. Use the Invoices API to fetch its details. |
invoice_id (anyOf 2) | null | Alternative | Public ID of the invoice associated with the ODP, when one has been generated. Use the Invoices API to fetch its details. |
next_available_payment_date | JSON | Optional | |
next_available_payment_date (anyOf 1) | string | Alternative | Next available payment date for the EOR contract (YYYY-MM-DD), when applicable. Format: date |
next_available_payment_date (anyOf 2) | null | Alternative | Next available payment date for the EOR contract (YYYY-MM-DD), when applicable. Format: date |
sla | Model | Required within parent | Expand Create On-Demand Payroll — 201 response body — data sla Processing SLAs (in days) configured for the contract EOR entity. |
status | string | Required within parent | Lifecycle status of the ODP. Known values: AWAITING_CLIENT_APPROVAL, AWAITING_CLIENT_SUBMISSION, AWAITING_ADJUSTMENTS_TO_BE_READY, AWAITING_DEEL_PROCESSING, DEEL_PROCESSING, REJECTED, CANCELLED, PARTIALLY_APPROVED, APPROVED |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | Timestamp when the ODP was submitted, when submitted. Format: date-time |
submitted_at (anyOf 2) | null | Alternative | Timestamp when the ODP was submitted, when submitted. Format: date-time |
submitted_by | JSON | Optional | |
submitted_by (anyOf 1) | string | Alternative | Name of the person who submitted the ODP, when submitted. |
submitted_by (anyOf 2) | null | Alternative | Name of the person who submitted the ODP, when submitted. |
Referenced models: Create On-Demand Payroll — 201 response body — data entries item, Create On-Demand Payroll — 201 response body — data sla
Create On-Demand Payroll — 201 response body — data entries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An On-Demand Payroll entry (an adjustment attached to the ODP). |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | The entry amount in the contract currency. Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | ISO 4217 currency code of the entry amount. |
date_of_entry | JSON | Optional | |
date_of_entry (anyOf 1) | string | Alternative | Date the entry applies to (YYYY-MM-DD). Null when not available for the entry. Format: date |
date_of_entry (anyOf 2) | null | Alternative | Date the entry applies to (YYYY-MM-DD). Null when not available for the entry. Format: date |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Free-text description of the entry. |
description (anyOf 2) | null | Alternative | Free-text description of the entry. |
id | string | Required within parent | Public ID of the On-Demand Payroll entry. |
metadata | Model | Required within parent | Expand Create On-Demand Payroll — 201 response body — data entries item metadata Additional, non-contractual metadata about the entry. |
submitter | JSON | Optional | The person who submitted the entry. |
submitter (anyOf 1) | Model | Alternative | Expand Create On-Demand Payroll — 201 response body — data entries item submitter The person who submitted the entry |
submitter (anyOf 2) | null | Alternative | |
title | string | Required within parent | Short human-readable title of the entry. |
type | string | Required within parent | The adjustment type of the entry. |
uom | string | Required within parent | Unit of measure of the entry amount. Always CURRENCY. Known values: CURRENCY |
Referenced models: Create On-Demand Payroll — 201 response body — data entries item metadata, Create On-Demand Payroll — 201 response body — data entries item submitter The person who submitted the entry
Create On-Demand Payroll — 201 response body — data sla
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Processing SLAs (in days) configured for the contract EOR entity. |
payment_buffer | JSON | Optional | |
payment_buffer (anyOf 1) | JSON | Alternative | |
payment_buffer (anyOf 1) (anyOf 1) | integer | Alternative | Payment buffer in days. |
payment_buffer (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_buffer (anyOf 2) | null | Alternative | Payment buffer in days. |
payment_processing | JSON | Optional | |
payment_processing (anyOf 1) | JSON | Alternative | |
payment_processing (anyOf 1) (anyOf 1) | integer | Alternative | Payment processing SLA in days. |
payment_processing (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_processing (anyOf 2) | null | Alternative | Payment processing SLA in days. |
payment_settlement | JSON | Optional | |
payment_settlement (anyOf 1) | JSON | Alternative | |
payment_settlement (anyOf 1) (anyOf 1) | integer | Alternative | Payment settlement SLA in days. |
payment_settlement (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_settlement (anyOf 2) | null | Alternative | Payment settlement SLA in days. |
payroll_processing | JSON | Optional | |
payroll_processing (anyOf 1) | JSON | Alternative | |
payroll_processing (anyOf 1) (anyOf 1) | integer | Alternative | Payroll processing SLA in days. |
payroll_processing (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payroll_processing (anyOf 2) | null | Alternative | Payroll processing SLA in days. |
post_termination_buffer | JSON | Optional | |
post_termination_buffer (anyOf 1) | JSON | Alternative | |
post_termination_buffer (anyOf 1) (anyOf 1) | integer | Alternative | Post-termination buffer in days during which an ODP is still allowed. |
post_termination_buffer (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
post_termination_buffer (anyOf 2) | null | Alternative | Post-termination buffer in days during which an ODP is still allowed. |
Create On-Demand Payroll — 201 response body — data entries item submitter The person who submitted the entry
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The person who submitted the entry. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Public ID of the submitter, when available. |
id (anyOf 2) | null | Alternative | Public ID of the submitter, when available. |
name | string | Optional | Full name of the submitter. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.ondemandpayroll_createondemandpayroll_v2026_07_28. Catalog operation: ondemandpayroll_createondemandpayroll_v2026_07_28. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["on-demand-payroll:write"]
Pinned headers: {"X-Version": "2026-07-28"}