Deel: Off cycle schemas
6 Deel schemas with complete fields and constraints.
← Off cycle operations · All schemas
Add off-cycle payment — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the newly created off-cycle payment. |
created | boolean | Required within parent | Indicates whether the off-cycle payment was successfully created. |
id | string | Optional | The unique identifier of the created off-cycle payment. Format: uuid |
Add off-cycle payment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The off-cycle payment data to submit. |
amount | number | Required within parent | The amount of the off-cycle payment. Format: double Minimum: 0 |
date_submitted | string | Required within parent | The date the off-cycle payment is submitted, in ISO-8601 format (YYYY-MM-DD). Format: date |
description | string | Required within parent | A description or reason for the off-cycle payment. |
hourly_report_preset_id | string or null | Optional | Id of an existing preset. Format: uuid |
is_auto_approved | boolean | Optional | If true, the off-cycle payment will be automatically approved as part of the request. |
payment_due_date | string or null | Optional | Due 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of off-cycle payments matching the requested contract. |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | The amount of the off-cycle payment. |
created_at | string | Required within parent | The timestamp when the off-cycle payment was created. Format: date-time |
currency_code | string | Required within parent | The three-letter ISO currency code for the payment amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
date_submitted | string | Required within parent | The timestamp when the off-cycle payment was submitted. Format: date-time |
description | string | Required within parent | A description or reason for the off-cycle payment. |
id | string | Required within parent | Unique identifier of the off-cycle payment. Format: uuid |
reported_by | Model | Required within parent | Expand List of off-cycle payments — 200 response body — data item reported by Details of the person who reported the off-cycle payment. |
status | JSON | Required within parent | The current status of the off-cycle payment. |
status (anyOf 1) | string | Alternative | The current status of the off-cycle payment. Known values: approved, declined, new, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the person who reported the off-cycle payment. |
full_name | string | Optional | Full name of the individual who reported the payment. |
id | string | Required within parent | Unique identifier of the reporter. Format: uuid |