Deel: Adjustments schemas
16 Deel schemas with complete fields and constraints.
← Adjustments operations · All schemas
Create a new adjustment — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a new adjustment — 201 response body — data |
Referenced models: Create a new adjustment — 201 response body — data
Create a new adjustment — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actual_end_cycle_date | string | Optional | The date of the actual end cycle date |
actual_start_cycle_date | string | Optional | The date of the actual start cycle date |
adjustment_category_id | string | Optional | The identifier of the adjustment category associated with the adjustment |
amount | string | Optional | The amount of the adjustment |
contract_id | string | Optional | The identifier of the contract associated with the adjustment |
created_at | string | Optional | The date and time when the adjustment was created Format: date-time |
cycle_reference | JSON | Optional | |
cycle_reference (anyOf 1) | string | Alternative | The reference to the cycle associated with the adjustment |
cycle_reference (anyOf 2) | null | Alternative | The reference to the cycle associated with the adjustment |
date_of_adjustment | string | Optional | The date of the adjustment Format: date-time |
description | string | Optional | The description of the adjustment |
file | JSON | Optional | Adjustment attachment |
file (anyOf 1) | Model | Alternative | Expand Create a new adjustment — 201 response body — data file Adjustment attachment |
file (anyOf 2) | null | Alternative | |
id | string | Optional | The unique identifier of the adjustment |
move_next_cycle | boolean | Optional | If an adjustments can belong to another payroll cycle |
odp_only | boolean | Optional | Whether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR |
status | Model | Optional | Expand Create a new adjustment — 201 response body — data status The status of the adjustments |
title | string | Optional | The title of the adjustment Maximum length: 255 Minimum length: 3 |
updated_at | string | Optional | The date and time when the adjustment was last updated Format: date-time |
Referenced models: Create a new adjustment — 201 response body — data file Adjustment attachment, Create a new adjustment — 201 response body — data status
Create a new adjustment — 201 response body — data file Adjustment attachment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Adjustment attachment |
fileType | string | Optional | The type of the file |
id | string | Optional | The unique identifier of the file |
name | string | Optional | The name of the file |
Create a new adjustment — 201 response body — data status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The status of the adjustments |
$ (anyOf 1) | string | Alternative | Adjustment status (when contract type is GP) Known values: OPEN, PENDING_APPROVAL, OVERWRITTEN, FAILED, SUCCESS, AI_CHECK_IN_PROGRESS |
$ (anyOf 2) | string | Alternative | Adjustment status (when contract type is EOR) Known values: DRAFT, PENDING, ERRORS_FOUND, APPROVED, DENIED, DISBURSE_SCHEDULED, REIMBURSED, UNDER_REVIEW, PENDING_DEEL_REVIEW |
Create a new adjustment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of adjustment to create |
adjustment_category_id | string | Required within parent | Adjustment category id. Minimum length: 25 |
amount | Model | Required within parent | Expand Create a new adjustment — request body — body data amount Amount of adjustment. |
contract_id | string | Required within parent | The identifier of the contract associated with the adjustment Minimum length: 5 |
country | string | Optional | Country the expense was incurred in, which is not necessarily the contract country. Conditionally required: for adjustment categories configured to require a country, which is typically an expense category, and for Global Payroll contracts whenever the organization has the compliance check enabled, which applies to any category. Leave the field out entirely when it does not apply - sending it empty is rejected, because the pattern still applies to a value that is present. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
cycle_reference | string | Optional | Cycle reference of adjustment. |
date_of_adjustment | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date |
description | string | Required within parent | Description of adjustment. Maximum length: 255 Minimum length: 3 |
move_next_cycle | boolean or null | Optional | If an adjustments can belong to another payroll cycle. |
odp_only | boolean | Optional | EOR contracts only. Restrict the adjustment to on-demand payroll: when true it is never attached to a regular payroll cycle, and it is automatically denied if it is still not part of an on-demand payroll 30 days after creation. Sending it for any other contract type is rejected, because on-demand payroll does not exist there. Editable only through this API, and it forces move_next_cycle to false. |
submitter_profile_id | integer or null | Optional | The identifier of the profile that submits the adjustment. Must be a profile authorized on the target contract. When omitted, the adjustment is attributed to the profile resolved from the API token. Minimum: 1 |
title | string | Required within parent | Title of adjustment. Maximum length: 255 Minimum length: 3 |
vendor | string | Optional | Vendor of adjustment. Conditionally required: for adjustment categories configured to require a vendor, which is typically an expense category, and for Global Payroll contracts whenever the organization has the compliance check enabled, which applies to any category. Leave the field out entirely when it does not apply - sending it empty is rejected, because the length constraint still applies to a value that is present. Minimum length: 3 |
Referenced models: Create a new adjustment — request body — body data amount
Create a new adjustment — request body — body data amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Amount of adjustment. |
$ (oneOf 1) | string | Alternative | Minimum length: 1 |
$ (oneOf 2) | number | Alternative | Format: double Minimum: 1 |
Retrieve adjustments — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve adjustments — 200 response body — data item |
Referenced models: Retrieve adjustments — 200 response body — data item
Retrieve adjustments — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actual_end_cycle_date | string | Optional | The date of the actual end cycle date |
actual_start_cycle_date | string | Optional | The date of the actual start cycle date |
adjustment_category_id | string | Optional | The identifier of the adjustment category associated with the adjustment |
amount | string | Optional | The amount of the adjustment |
contract_id | string | Optional | The identifier of the contract associated with the adjustment |
created_at | string | Optional | The date and time when the adjustment was created Format: date-time |
cycle_reference | JSON | Optional | |
cycle_reference (anyOf 1) | string | Alternative | The reference to the cycle associated with the adjustment |
cycle_reference (anyOf 2) | null | Alternative | The reference to the cycle associated with the adjustment |
date_of_adjustment | JSON | Optional | |
date_of_adjustment (anyOf 1) | string | Alternative | The date of the adjustment Format: date-time |
date_of_adjustment (anyOf 2) | null | Alternative | The date of the adjustment Format: date-time |
description | string | Optional | The description of the adjustment |
file | JSON | Optional | Info for the attachment of adjustment |
file (anyOf 1) | Model | Alternative | Expand Retrieve adjustments — 200 response body — data item file Info for the attachment of adjustment |
file (anyOf 2) | null | Alternative | |
id | string | Optional | The unique identifier of the adjustment |
move_next_cycle | boolean | Optional | If an adjustments can belong to another payroll cycle |
odp_only | boolean | Optional | Whether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR |
status | string | Optional | Adjustment status Known values: open, pending_approval, overwritten, failed, success, DRAFT, PENDING, APPROVED, DENIED, DISBURSE_SCHEDULED, REIMBURSED, UNDER_REVIEW, ERRORS_FOUND, PENDING_DEEL_REVIEW, AI_CHECK_IN_PROGRESS |
title | string | Optional | The title of the adjustment |
updated_at | string | Optional | The date and time when the adjustment was last updated Format: date-time |
Referenced models: Retrieve adjustments — 200 response body — data item file Info for the attachment of adjustment
Retrieve adjustments — 200 response body — data item file Info for the attachment of adjustment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info for the attachment of adjustment |
fileType | string | Optional | The type of the file |
id | string | Optional | The unique identifier of the file |
name | string | Optional | The name of the file |
Retrieve an adjustment — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve an adjustment — 200 response body — data |
Referenced models: Retrieve an adjustment — 200 response body — data
Retrieve an adjustment — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actual_end_cycle_date | string | Optional | The date of the actual end cycle date |
actual_start_cycle_date | string | Optional | The date of the actual start cycle date |
adjustment_category_id | string | Optional | The identifier of the adjustment category associated with the adjustment |
amount | string | Optional | The amount of the adjustment |
contract_id | string | Optional | The identifier of the contract associated with the adjustment |
created_at | string | Optional | The date and time when the adjustment was created Format: date-time |
cycle_reference | JSON | Optional | |
cycle_reference (anyOf 1) | string | Alternative | The reference to the cycle associated with the adjustment |
cycle_reference (anyOf 2) | null | Alternative | The reference to the cycle associated with the adjustment |
date_of_adjustment | string | Optional | The date of the adjustment Format: date-time |
description | string | Optional | The description of the adjustment |
file | JSON | Optional | Info about the attachment of adjustment |
file (anyOf 1) | Model | Alternative | Expand Retrieve an adjustment — 200 response body — data file Info about the attachment of adjustment |
file (anyOf 2) | null | Alternative | |
id | string | Optional | The unique identifier of the adjustment |
move_next_cycle | boolean | Optional | If an adjustments can belong to another payroll cycle |
odp_only | boolean | Optional | Whether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR |
status | string | Optional | Adjustment status Known values: open, pending_approval, overwritten, failed, success, DRAFT, PENDING, APPROVED, DENIED, DISBURSE_SCHEDULED, REIMBURSED, UNDER_REVIEW, ERRORS_FOUND, PENDING_DEEL_REVIEW, AI_CHECK_IN_PROGRESS |
title | string | Optional | The title of the adjustment |
updated_at | string | Optional | The date and time when the adjustment was last updated Format: date-time |
Referenced models: Retrieve an adjustment — 200 response body — data file Info about the attachment of adjustment
Retrieve an adjustment — 200 response body — data file Info about the attachment of adjustment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info about the attachment of adjustment |
fileType | string | Optional | The type of the file |
id | string | Optional | The unique identifier of the file |
name | string | Optional | The name of the file |
Retrieve categories — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve categories — 200 response body — data item |
Referenced models: Retrieve categories — 200 response body — data item
Retrieve categories — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier of an adjustment category. |
label | string | Optional | The label of the adjustment category. |
name | string | Optional | The name of the adjustment category. |
unit_type | string | Optional | The unit type of the adjustment category. |
Update an adjustment — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update an adjustment — 200 response body — data |
Referenced models: Update an adjustment — 200 response body — data
Update an adjustment — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
updated | boolean | Required within parent | Confirms the update was successful. |