Deel: List invoice adjustments — 200 response body — data item
List invoice adjustments: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: List invoice adjustments — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachment | JSON | Required within parent | File attachment linked to the invoice adjustment. |
attachment (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item attachment File attachment linked to the invoice adjustment |
attachment (anyOf 2) | null | Alternative | |
contract | Model | Required within parent | Expand List invoice adjustments — 200 response body — data item contract Contract associated with this invoice adjustment. |
created_at | string | Required within parent | Timestamp when the adjustment was created (ISO-8601). Format: date-time |
currency_code | string | Required within parent | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_scale | JSON | Optional | |
custom_scale (anyOf 1) | string | Alternative | Custom scale label defined by the client. |
custom_scale (anyOf 2) | null | Alternative | Custom scale label defined by the client. |
date_submitted | JSON | Optional | |
date_submitted (anyOf 1) | string | Alternative | Timestamp when the adjustment was submitted for review. Format: date-time |
date_submitted (anyOf 2) | null | Alternative | Timestamp when the adjustment was submitted for review. Format: date-time |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Human-readable explanation of the invoice adjustment. |
description (anyOf 2) | null | Alternative | Human-readable explanation of the invoice adjustment. |
hourlyReportPreset | JSON | Optional | |
hourlyReportPreset (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item hourly Report Preset id, rate, title |
hourlyReportPreset (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier of this invoice adjustment. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of this invoice adjustment. Format: uuid |
invoice_id | JSON | Optional | |
invoice_id (anyOf 1) | JSON | Alternative | |
invoice_id (anyOf 1) (anyOf 1) | number | Alternative | Identifier of the generated invoice this adjustment belongs to. Format: double |
invoice_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
invoice_id (anyOf 2) | null | Alternative | Identifier of the generated invoice this adjustment belongs to. Format: double |
payment_cycle | Model | Required within parent | Expand List invoice adjustments — 200 response body — data item payment cycle Payment cycle associated with this adjustment. |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity used to calculate the total amount. Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | Quantity used to calculate the total amount. Format: double |
reported_by | Model | Required within parent | Expand List invoice adjustments — 200 response body — data item reported by User who reported the invoice adjustment. |
reviewed_by | JSON | Required within parent | Reviewer information if the adjustment has been reviewed. |
reviewed_by (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item reviewed by full name, id, remarks, reviewed at |
reviewed_by (anyOf 2) | null | Alternative | |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | Predefined scale used to calculate the adjustment amount. |
scale (anyOf 2) | null | Alternative | Predefined scale used to calculate the adjustment amount. |
status | JSON | Required within parent | Current processing status of the invoice adjustment. |
status (anyOf 1) | string | Alternative | Current processing status of the invoice adjustment. Known values: approved, declined, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative | |
total_amount | string | Required within parent | Total monetary value of the invoice adjustment. |
type | Model | Required within parent | Expand Invoice line item by Id — 200 response body — data type Type of invoice adjustment. |
worksheet | JSON | Required within parent | Breakdown of time used for time-based calculations. |
worksheet (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item worksheet Breakdown of time used for time-based calculations |
worksheet (anyOf 2) | null | Alternative |
Referenced models: List invoice adjustments — 200 response body — data item attachment File attachment linked to the invoice adjustment, Invoice line item by Id — 200 response body — data type, List invoice adjustments — 200 response body — data item contract, List invoice adjustments — 200 response body — data item hourly Report Preset id, rate, title, List invoice adjustments — 200 response body — data item payment cycle, List invoice adjustments — 200 response body — data item reported by, List invoice adjustments — 200 response body — data item reviewed by full name, id, remarks, reviewed at, List invoice adjustments — 200 response body — data item worksheet Breakdown of time used for time-based calculations