Skip to content

Deel: On demand payroll schemas

17 Deel schemas with complete fields and constraints.

← On demand payroll operations · All schemas

Attach entries to On-Demand Payroll — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Attach entries to On-Demand Payroll — 200 response body — data
An On-Demand Payroll for a contract.

Referenced models: Attach entries to On-Demand Payroll — 200 response body — data

Attach entries to On-Demand Payroll — 200 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
entriesarrayRequired within parentEntries currently attached to the ODP.
entries[]ModelEach itemExpand Attach entries to On-Demand Payroll — 200 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 sla, Attach entries to On-Demand Payroll — 200 response body — data entries item

Attach entries to On-Demand Payroll — 200 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.
metadataModelRequired within parentExpand Attach entries to On-Demand Payroll — 200 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 submitter The person who submitted the entry, Attach entries to On-Demand Payroll — 200 response body — data entries item metadata

Attach entries to On-Demand Payroll — 200 response body — data entries item metadata

FieldTypePresenceDescription and constraints
$objectRootAdditional, non-contractual metadata about the entry.
category_group_labelJSONOptional
category_group_label (anyOf 1)stringAlternativeLabel of the adjustment category group.
category_group_label (anyOf 2)nullAlternativeLabel of the adjustment category group.
category_labelJSONOptional
category_label (anyOf 1)stringAlternativeLabel of the adjustment category.
category_label (anyOf 2)nullAlternativeLabel of the adjustment category.
public_idstringOptionalPublic ID of the underlying adjustment.
reviewed_atJSONOptional
reviewed_at (anyOf 1)stringAlternativeTimestamp of the last review of the entry.
Format: date-time
reviewed_at (anyOf 2)nullAlternativeTimestamp of the last review of the entry.
Format: date-time
submission_dateJSONOptional
submission_date (anyOf 1)stringAlternativeTimestamp when the entry was submitted.
Format: date-time
submission_date (anyOf 2)nullAlternativeTimestamp when the entry was submitted.
Format: date-time
typestringOptionalThe adjustment type of the entry.
vendor_nameJSONOptional
vendor_name (anyOf 1)stringAlternativeVendor associated with the entry, when applicable.
vendor_name (anyOf 2)nullAlternativeVendor associated with the entry, when applicable.

Cancel On-Demand Payroll — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
move_to_regulararrayOptionalPublic IDs of the entries to move to the regular payroll cycle instead of cancelling them with the ODP.
move_to_regular[]stringEach item

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 entries item metadata

FieldTypePresenceDescription and constraints
$objectRootAdditional, non-contractual metadata about the entry.
category_group_labelJSONOptional
category_group_label (anyOf 1)stringAlternativeLabel of the adjustment category group.
category_group_label (anyOf 2)nullAlternativeLabel of the adjustment category group.
category_labelJSONOptional
category_label (anyOf 1)stringAlternativeLabel of the adjustment category.
category_label (anyOf 2)nullAlternativeLabel of the adjustment category.
reviewed_atJSONOptional
reviewed_at (anyOf 1)stringAlternativeTimestamp of the last review of the entry.
Format: date-time
reviewed_at (anyOf 2)nullAlternativeTimestamp of the last review of the entry.
Format: date-time
source_service_entry_idstringOptionalPublic ID of the entry in the service it originates from (for example, the adjustment ID for an adjustment entry). Use it to correlate the entry with the source resource.
submission_dateJSONOptional
submission_date (anyOf 1)stringAlternativeTimestamp when the entry was submitted.
Format: date-time
submission_date (anyOf 2)nullAlternativeTimestamp when the entry was submitted.
Format: date-time
typestringOptionalThe adjustment type of the entry.
vendor_nameJSONOptional
vendor_name (anyOf 1)stringAlternativeVendor associated with the entry, when applicable.
vendor_name (anyOf 2)nullAlternativeVendor associated with the entry, when applicable.

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.

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 — 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

Detach entries from On-Demand Payroll — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
entries_to_deletearrayOptionalPublic IDs of the entries to permanently delete from the ODP.
entries_to_delete[]stringEach item
move_to_regulararrayOptionalPublic IDs of the entries to remove from the ODP and move to the regular payroll cycle.
move_to_regular[]stringEach item

List On-Demand Payroll entries — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of contracts with their eligible entries.
data[]ModelEach itemExpand List On-Demand Payroll entries — 200 response body — data item

Referenced models: List On-Demand Payroll entries — 200 response body — data item

List On-Demand Payroll entries — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRootA contract and its entries eligible for On-Demand Payroll.
contract_idstringRequired within parentPublic ID (oid) of the contract.
currencystringRequired within parentISO 4217 currency code of the contract.
employee_namestringOptionalFull name of the employee.
entriesarrayRequired within parentEligible entries for the contract.
entries[]ModelEach itemExpand Create On-Demand Payroll — 201 response body — data entries item
has_pending_itemsbooleanRequired within parentWhether the contract has entries in a pending state.
is_odp_enabledbooleanRequired within parentWhether On-Demand Payroll is enabled for the contract.
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeJob title of the employee.
job_title (anyOf 2)nullAlternativeJob title of the employee.
odp_limitJSONOptional
odp_limit (anyOf 1)numberAlternativeMaximum total ODP amount allowed, in the contract currency.
Format: double
odp_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
odp_warning_limitJSONOptional
odp_warning_limit (anyOf 1)numberAlternativeAmount above which the client is warned (3x the salary per cycle).
Format: double
odp_warning_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ongoing_odpJSONOptionalThe ongoing ODP for the contract, if one exists.
ongoing_odp (anyOf 1)ModelAlternativeExpand List On-Demand Payroll entries — 200 response body — data item ongoing odp The ongoing ODP for the contract, if one exists
ongoing_odp (anyOf 2)nullAlternative
salary_advance_limitJSONOptional
salary_advance_limit (anyOf 1)numberAlternativeMaximum salary advance allowed, in the contract currency.
Format: double
salary_advance_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
teamJSONOptionalTeam the contract belongs to.
team (anyOf 1)ModelAlternativeExpand List On-Demand Payroll entries — 200 response body — data item team Team the contract belongs to
team (anyOf 2)nullAlternative

Referenced models: List On-Demand Payroll entries — 200 response body — data item team Team the contract belongs to, Create On-Demand Payroll — 201 response body — data entries item, List On-Demand Payroll entries — 200 response body — data item ongoing odp The ongoing ODP for the contract, if one exists

List On-Demand Payroll entries — 200 response body — data item ongoing odp The ongoing ODP for the contract, if one exists

FieldTypePresenceDescription and constraints
$objectRootThe ongoing ODP for the contract, if one exists.
statusstringOptionalStatus of the ongoing ODP.
Known values: AWAITING_CLIENT_APPROVAL, AWAITING_CLIENT_SUBMISSION, AWAITING_ADJUSTMENTS_TO_BE_READY, AWAITING_DEEL_PROCESSING, DEEL_PROCESSING, REJECTED, CANCELLED, PARTIALLY_APPROVED, APPROVED

List On-Demand Payroll entries — 200 response body — data item team Team the contract belongs to

FieldTypePresenceDescription and constraints
$objectRootTeam the contract belongs to.
idstringOptionalPublic ID of the team.
namestringOptionalName of the team.

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.