Skip to content

Deel: Adjustments schemas

16 Deel schemas with complete fields and constraints.

← Adjustments operations · All schemas

Create a new adjustment — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
actual_end_cycle_datestringOptionalThe date of the actual end cycle date
actual_start_cycle_datestringOptionalThe date of the actual start cycle date
adjustment_category_idstringOptionalThe identifier of the adjustment category associated with the adjustment
amountstringOptionalThe amount of the adjustment
contract_idstringOptionalThe identifier of the contract associated with the adjustment
created_atstringOptionalThe date and time when the adjustment was created
Format: date-time
cycle_referenceJSONOptional
cycle_reference (anyOf 1)stringAlternativeThe reference to the cycle associated with the adjustment
cycle_reference (anyOf 2)nullAlternativeThe reference to the cycle associated with the adjustment
date_of_adjustmentstringOptionalThe date of the adjustment
Format: date-time
descriptionstringOptionalThe description of the adjustment
fileJSONOptionalAdjustment attachment
file (anyOf 1)ModelAlternativeExpand Create a new adjustment — 201 response body — data file Adjustment attachment
file (anyOf 2)nullAlternative
idstringOptionalThe unique identifier of the adjustment
move_next_cyclebooleanOptionalIf an adjustments can belong to another payroll cycle
odp_onlybooleanOptionalWhether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR
statusModelOptionalExpand Create a new adjustment — 201 response body — data status
The status of the adjustments
titlestringOptionalThe title of the adjustment
Maximum length: 255
Minimum length: 3
updated_atstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootAdjustment attachment
fileTypestringOptionalThe type of the file
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file

Create a new adjustment — 201 response body — data status

FieldTypePresenceDescription and constraints
$JSONRootThe status of the adjustments
$ (anyOf 1)stringAlternativeAdjustment status (when contract type is GP)
Known values: OPEN, PENDING_APPROVAL, OVERWRITTEN, FAILED, SUCCESS, AI_CHECK_IN_PROGRESS
$ (anyOf 2)stringAlternativeAdjustment 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

FieldTypePresenceDescription and constraints
$objectRootDetails of adjustment to create
adjustment_category_idstringRequired within parentAdjustment category id.
Minimum length: 25
amountModelRequired within parentExpand Create a new adjustment — request body — body data amount
Amount of adjustment.
contract_idstringRequired within parentThe identifier of the contract associated with the adjustment
Minimum length: 5
countrystringOptionalCountry 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_referencestringOptionalCycle reference of adjustment.
date_of_adjustmentstring or nullOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
descriptionstringRequired within parentDescription of adjustment.
Maximum length: 255
Minimum length: 3
move_next_cycleboolean or nullOptionalIf an adjustments can belong to another payroll cycle.
odp_onlybooleanOptionalEOR 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_idinteger or nullOptionalThe 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
titlestringRequired within parentTitle of adjustment.
Maximum length: 255
Minimum length: 3
vendorstringOptionalVendor 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

FieldTypePresenceDescription and constraints
$JSONRootAmount of adjustment.
$ (oneOf 1)stringAlternativeMinimum length: 1
$ (oneOf 2)numberAlternativeFormat: double
Minimum: 1

Retrieve adjustments — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve adjustments — 200 response body — data item

Referenced models: Retrieve adjustments — 200 response body — data item

Retrieve adjustments — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
actual_end_cycle_datestringOptionalThe date of the actual end cycle date
actual_start_cycle_datestringOptionalThe date of the actual start cycle date
adjustment_category_idstringOptionalThe identifier of the adjustment category associated with the adjustment
amountstringOptionalThe amount of the adjustment
contract_idstringOptionalThe identifier of the contract associated with the adjustment
created_atstringOptionalThe date and time when the adjustment was created
Format: date-time
cycle_referenceJSONOptional
cycle_reference (anyOf 1)stringAlternativeThe reference to the cycle associated with the adjustment
cycle_reference (anyOf 2)nullAlternativeThe reference to the cycle associated with the adjustment
date_of_adjustmentJSONOptional
date_of_adjustment (anyOf 1)stringAlternativeThe date of the adjustment
Format: date-time
date_of_adjustment (anyOf 2)nullAlternativeThe date of the adjustment
Format: date-time
descriptionstringOptionalThe description of the adjustment
fileJSONOptionalInfo for the attachment of adjustment
file (anyOf 1)ModelAlternativeExpand Retrieve adjustments — 200 response body — data item file Info for the attachment of adjustment
file (anyOf 2)nullAlternative
idstringOptionalThe unique identifier of the adjustment
move_next_cyclebooleanOptionalIf an adjustments can belong to another payroll cycle
odp_onlybooleanOptionalWhether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR
statusstringOptionalAdjustment 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
titlestringOptionalThe title of the adjustment
updated_atstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootInfo for the attachment of adjustment
fileTypestringOptionalThe type of the file
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file

Retrieve an adjustment — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve an adjustment — 200 response body — data

Referenced models: Retrieve an adjustment — 200 response body — data

Retrieve an adjustment — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
actual_end_cycle_datestringOptionalThe date of the actual end cycle date
actual_start_cycle_datestringOptionalThe date of the actual start cycle date
adjustment_category_idstringOptionalThe identifier of the adjustment category associated with the adjustment
amountstringOptionalThe amount of the adjustment
contract_idstringOptionalThe identifier of the contract associated with the adjustment
created_atstringOptionalThe date and time when the adjustment was created
Format: date-time
cycle_referenceJSONOptional
cycle_reference (anyOf 1)stringAlternativeThe reference to the cycle associated with the adjustment
cycle_reference (anyOf 2)nullAlternativeThe reference to the cycle associated with the adjustment
date_of_adjustmentstringOptionalThe date of the adjustment
Format: date-time
descriptionstringOptionalThe description of the adjustment
fileJSONOptionalInfo about the attachment of adjustment
file (anyOf 1)ModelAlternativeExpand Retrieve an adjustment — 200 response body — data file Info about the attachment of adjustment
file (anyOf 2)nullAlternative
idstringOptionalThe unique identifier of the adjustment
move_next_cyclebooleanOptionalIf an adjustments can belong to another payroll cycle
odp_onlybooleanOptionalWhether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR
statusstringOptionalAdjustment 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
titlestringOptionalThe title of the adjustment
updated_atstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootInfo about the attachment of adjustment
fileTypestringOptionalThe type of the file
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file

Retrieve categories — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve categories — 200 response body — data item

Referenced models: Retrieve categories — 200 response body — data item

Retrieve categories — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier of an adjustment category.
labelstringOptionalThe label of the adjustment category.
namestringOptionalThe name of the adjustment category.
unit_typestringOptionalThe unit type of the adjustment category.

Update an adjustment — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update an adjustment — 200 response body — data

Referenced models: Update an adjustment — 200 response body — data

Update an adjustment — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
updatedbooleanRequired within parentConfirms the update was successful.

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.