Skip to content

Deel: Off cycle schemas

6 Deel schemas with complete fields and constraints.

← Off cycle operations · All schemas

Add off-cycle payment — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add off-cycle payment — 201 response body — data
Details of the newly created off-cycle payment.

Referenced models: Add off-cycle payment — 201 response body — data

Add off-cycle payment — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootDetails of the newly created off-cycle payment.
createdbooleanRequired within parentIndicates whether the off-cycle payment was successfully created.
idstringOptionalThe unique identifier of the created off-cycle payment.
Format: uuid

Add off-cycle payment — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe off-cycle payment data to submit.
amountnumberRequired within parentThe amount of the off-cycle payment.
Format: double
Minimum: 0
date_submittedstringRequired within parentThe date the off-cycle payment is submitted, in ISO-8601 format (YYYY-MM-DD).
Format: date
descriptionstringRequired within parentA description or reason for the off-cycle payment.
hourly_report_preset_idstring or nullOptionalId of an existing preset.
Format: uuid
is_auto_approvedbooleanOptionalIf true, the off-cycle payment will be automatically approved as part of the request.
payment_due_datestring or nullOptionalDue date of the resulting one-off invoice, in ISO-8601 format (YYYY-MM-DD) in the contract timezone. Defaults to today when omitted or null. Must be today or later and, when the contract is active and has an end date, not after that end date.
Format: date

List of off-cycle payments — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of off-cycle payments matching the requested contract.
data[]ModelEach itemExpand List of off-cycle payments — 200 response body — data item

Referenced models: List of off-cycle payments — 200 response body — data item

List of off-cycle payments — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentThe amount of the off-cycle payment.
created_atstringRequired within parentThe timestamp when the off-cycle payment was created.
Format: date-time
currency_codestringRequired within parentThe three-letter ISO currency code for the payment amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
date_submittedstringRequired within parentThe timestamp when the off-cycle payment was submitted.
Format: date-time
descriptionstringRequired within parentA description or reason for the off-cycle payment.
idstringRequired within parentUnique identifier of the off-cycle payment.
Format: uuid
reported_byModelRequired within parentExpand List of off-cycle payments — 200 response body — data item reported by
Details of the person who reported the off-cycle payment.
statusJSONRequired within parentThe current status of the off-cycle payment.
status (anyOf 1)stringAlternativeThe current status of the off-cycle payment.
Known values: approved, declined, new, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative

Referenced models: List of off-cycle payments — 200 response body — data item reported by

List of off-cycle payments — 200 response body — data item reported by

FieldTypePresenceDescription and constraints
$objectRootDetails of the person who reported the off-cycle payment.
full_namestringOptionalFull name of the individual who reported the payment.
idstringRequired within parentUnique identifier of the reporter.
Format: uuid

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.