Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent
bodyobjectOptional
body.dataModelRequired within parentExpand Create On-Demand Payroll — request body — body data

Referenced models: Create On-Demand Payroll — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create On-Demand Payroll — 201 response body

Referenced models: Create On-Demand Payroll — 201 response body

1 more schema is linked from the tables above, on the schema pages.

Create On-Demand Payroll — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
existing_entry_idsarrayOptionalPublic IDs of existing entries (adjustments) to attach to the ODP.
existing_entry_ids[]stringEach item
salary_advancenumberOptionalSalary advance amount to include in the ODP, in the contract currency.
Format: double
Create On-Demand Payroll — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootAn On-Demand Payroll for a contract.
deel_reviewed_atJSONOptional
deel_reviewed_at (anyOf 1)stringAlternativeTimestamp when Deel reviewed the ODP, when reviewed.
Format: date-time
deel_reviewed_at (anyOf 2)nullAlternativeTimestamp when Deel reviewed the ODP, when reviewed.
Format: date-time
employee_payment_statusJSONOptionalWhether 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)stringAlternativeWhether 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)nullAlternative
entriesarrayRequired within parentEntries currently attached to the ODP.
entries[]ModelEach itemExpand Create On-Demand Payroll — 201 response body — data entries item
estimated_paydayJSONOptional
estimated_payday (anyOf 1)stringAlternativeEstimated payday for the ODP (YYYY-MM-DD).
Format: date
estimated_payday (anyOf 2)nullAlternativeEstimated payday for the ODP (YYYY-MM-DD).
Format: date
idstringRequired within parentPublic ID of the On-Demand Payroll.
invoice_idJSONOptional
invoice_id (anyOf 1)stringAlternativePublic 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)nullAlternativePublic ID of the invoice associated with the ODP, when one has been generated. Use the Invoices API to fetch its details.
next_available_payment_dateJSONOptional
next_available_payment_date (anyOf 1)stringAlternativeNext available payment date for the EOR contract (YYYY-MM-DD), when applicable.
Format: date
next_available_payment_date (anyOf 2)nullAlternativeNext available payment date for the EOR contract (YYYY-MM-DD), when applicable.
Format: date
slaModelRequired within parentExpand Create On-Demand Payroll — 201 response body — data sla
Processing SLAs (in days) configured for the contract EOR entity.
statusstringRequired within parentLifecycle 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_atJSONOptional
submitted_at (anyOf 1)stringAlternativeTimestamp when the ODP was submitted, when submitted.
Format: date-time
submitted_at (anyOf 2)nullAlternativeTimestamp when the ODP was submitted, when submitted.
Format: date-time
submitted_byJSONOptional
submitted_by (anyOf 1)stringAlternativeName of the person who submitted the ODP, when submitted.
submitted_by (anyOf 2)nullAlternativeName 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
FieldTypePresenceDescription and constraints
$objectRootAn On-Demand Payroll entry (an adjustment attached to the ODP).
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeThe entry amount in the contract currency.
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentISO 4217 currency code of the entry amount.
date_of_entryJSONOptional
date_of_entry (anyOf 1)stringAlternativeDate the entry applies to (YYYY-MM-DD). Null when not available for the entry.
Format: date
date_of_entry (anyOf 2)nullAlternativeDate the entry applies to (YYYY-MM-DD). Null when not available for the entry.
Format: date
descriptionJSONOptional
description (anyOf 1)stringAlternativeFree-text description of the entry.
description (anyOf 2)nullAlternativeFree-text description of the entry.
idstringRequired within parentPublic ID of the On-Demand Payroll entry.
metadataModelRequired within parentExpand Create On-Demand Payroll — 201 response body — data entries item metadata
Additional, non-contractual metadata about the entry.
submitterJSONOptionalThe person who submitted the entry.
submitter (anyOf 1)ModelAlternativeExpand Create On-Demand Payroll — 201 response body — data entries item submitter The person who submitted the entry
submitter (anyOf 2)nullAlternative
titlestringRequired within parentShort human-readable title of the entry.
typestringRequired within parentThe adjustment type of the entry.
uomstringRequired within parentUnit 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
FieldTypePresenceDescription and constraints
$objectRootProcessing SLAs (in days) configured for the contract EOR entity.
payment_bufferJSONOptional
payment_buffer (anyOf 1)JSONAlternative
payment_buffer (anyOf 1) (anyOf 1)integerAlternativePayment buffer in days.
payment_buffer (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payment_buffer (anyOf 2)nullAlternativePayment buffer in days.
payment_processingJSONOptional
payment_processing (anyOf 1)JSONAlternative
payment_processing (anyOf 1) (anyOf 1)integerAlternativePayment processing SLA in days.
payment_processing (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payment_processing (anyOf 2)nullAlternativePayment processing SLA in days.
payment_settlementJSONOptional
payment_settlement (anyOf 1)JSONAlternative
payment_settlement (anyOf 1) (anyOf 1)integerAlternativePayment settlement SLA in days.
payment_settlement (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payment_settlement (anyOf 2)nullAlternativePayment settlement SLA in days.
payroll_processingJSONOptional
payroll_processing (anyOf 1)JSONAlternative
payroll_processing (anyOf 1) (anyOf 1)integerAlternativePayroll processing SLA in days.
payroll_processing (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payroll_processing (anyOf 2)nullAlternativePayroll processing SLA in days.
post_termination_bufferJSONOptional
post_termination_buffer (anyOf 1)JSONAlternative
post_termination_buffer (anyOf 1) (anyOf 1)integerAlternativePost-termination buffer in days during which an ODP is still allowed.
post_termination_buffer (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
post_termination_buffer (anyOf 2)nullAlternativePost-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
FieldTypePresenceDescription and constraints
$objectRootThe person who submitted the entry.
idJSONOptional
id (anyOf 1)stringAlternativePublic ID of the submitter, when available.
id (anyOf 2)nullAlternativePublic ID of the submitter, when available.
namestringOptionalFull name of the submitter.

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.