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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| 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 |
entries | array | Required within parent | Entries currently attached to the ODP. |
entries[] | Model | Each item | Expand Attach entries to On-Demand Payroll — 200 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 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
| 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. |
metadata | Model | Required within parent | Expand Attach entries to On-Demand Payroll — 200 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 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional, non-contractual metadata about the entry. |
category_group_label | JSON | Optional | |
category_group_label (anyOf 1) | string | Alternative | Label of the adjustment category group. |
category_group_label (anyOf 2) | null | Alternative | Label of the adjustment category group. |
category_label | JSON | Optional | |
category_label (anyOf 1) | string | Alternative | Label of the adjustment category. |
category_label (anyOf 2) | null | Alternative | Label of the adjustment category. |
public_id | string | Optional | Public ID of the underlying adjustment. |
reviewed_at | JSON | Optional | |
reviewed_at (anyOf 1) | string | Alternative | Timestamp of the last review of the entry. Format: date-time |
reviewed_at (anyOf 2) | null | Alternative | Timestamp of the last review of the entry. Format: date-time |
submission_date | JSON | Optional | |
submission_date (anyOf 1) | string | Alternative | Timestamp when the entry was submitted. Format: date-time |
submission_date (anyOf 2) | null | Alternative | Timestamp when the entry was submitted. Format: date-time |
type | string | Optional | The adjustment type of the entry. |
vendor_name | JSON | Optional | |
vendor_name (anyOf 1) | string | Alternative | Vendor associated with the entry, when applicable. |
vendor_name (anyOf 2) | null | Alternative | Vendor associated with the entry, when applicable. |
Cancel On-Demand Payroll — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
move_to_regular | array | Optional | Public IDs of the entries to move to the regular payroll cycle instead of cancelling them with the ODP. |
move_to_regular[] | string | Each item |
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 entries item metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional, non-contractual metadata about the entry. |
category_group_label | JSON | Optional | |
category_group_label (anyOf 1) | string | Alternative | Label of the adjustment category group. |
category_group_label (anyOf 2) | null | Alternative | Label of the adjustment category group. |
category_label | JSON | Optional | |
category_label (anyOf 1) | string | Alternative | Label of the adjustment category. |
category_label (anyOf 2) | null | Alternative | Label of the adjustment category. |
reviewed_at | JSON | Optional | |
reviewed_at (anyOf 1) | string | Alternative | Timestamp of the last review of the entry. Format: date-time |
reviewed_at (anyOf 2) | null | Alternative | Timestamp of the last review of the entry. Format: date-time |
source_service_entry_id | string | Optional | Public 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_date | JSON | Optional | |
submission_date (anyOf 1) | string | Alternative | Timestamp when the entry was submitted. Format: date-time |
submission_date (anyOf 2) | null | Alternative | Timestamp when the entry was submitted. Format: date-time |
type | string | Optional | The adjustment type of the entry. |
vendor_name | JSON | Optional | |
vendor_name (anyOf 1) | string | Alternative | Vendor associated with the entry, when applicable. |
vendor_name (anyOf 2) | null | Alternative | Vendor associated with the entry, when applicable. |
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. |
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 — 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 |
Detach entries from On-Demand Payroll — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entries_to_delete | array | Optional | Public IDs of the entries to permanently delete from the ODP. |
entries_to_delete[] | string | Each item | |
move_to_regular | array | Optional | Public IDs of the entries to remove from the ODP and move to the regular payroll cycle. |
move_to_regular[] | string | Each item |
List On-Demand Payroll entries — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of contracts with their eligible entries. |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A contract and its entries eligible for On-Demand Payroll. |
contract_id | string | Required within parent | Public ID (oid) of the contract. |
currency | string | Required within parent | ISO 4217 currency code of the contract. |
employee_name | string | Optional | Full name of the employee. |
entries | array | Required within parent | Eligible entries for the contract. |
entries[] | Model | Each item | Expand Create On-Demand Payroll — 201 response body — data entries item |
has_pending_items | boolean | Required within parent | Whether the contract has entries in a pending state. |
is_odp_enabled | boolean | Required within parent | Whether On-Demand Payroll is enabled for the contract. |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | Job title of the employee. |
job_title (anyOf 2) | null | Alternative | Job title of the employee. |
odp_limit | JSON | Optional | |
odp_limit (anyOf 1) | number | Alternative | Maximum total ODP amount allowed, in the contract currency. Format: double |
odp_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
odp_warning_limit | JSON | Optional | |
odp_warning_limit (anyOf 1) | number | Alternative | Amount above which the client is warned (3x the salary per cycle). Format: double |
odp_warning_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ongoing_odp | JSON | Optional | The ongoing ODP for the contract, if one exists. |
ongoing_odp (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
salary_advance_limit | JSON | Optional | |
salary_advance_limit (anyOf 1) | number | Alternative | Maximum salary advance allowed, in the contract currency. Format: double |
salary_advance_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
team | JSON | Optional | Team the contract belongs to. |
team (anyOf 1) | Model | Alternative | Expand List On-Demand Payroll entries — 200 response body — data item team Team the contract belongs to |
team (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ongoing ODP for the contract, if one exists. |
status | string | Optional | Status 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Team the contract belongs to. |
id | string | Optional | Public ID of the team. |
name | string | Optional | Name of the team. |