Deel: Create an invoice adjustment — request body — body data
Create an invoice adjustment: request body, field body / data. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Create an invoice adjustment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata. |
amount | number | Required within parent | Monetary amount to apply for this invoice adjustment, expressed in the contract currency as a positive number. Format: double Minimum: 0 |
contract_id | string | Required within parent | Unique Deel contract identifier (public id) that receives this invoice adjustment line item. |
date_submitted | string | Required within parent | Submission date in ISO-8601 short-date format (YYYY-MM-DD) used for filtering, reporting, and approvals. Format: date |
description | string | Required within parent | Detailed human-readable explanation that appears on invoices and audit records visible to both parties. Maximum length: 30000 |
group_key | string or null | Optional | When provided, invoice adjustments sharing the same group_key within the same payment cycle are merged into a single aggregated line item on the invoice. Requires is_auto_approved to be true. Maximum length: 300 |
hourly_report_preset_id | string or null | Optional | Identifier of an existing hourly report preset used to link standardized rate and scale metadata to this entry. Format: uuid |
is_auto_approved | boolean | Optional | When true, the created invoice adjustment skips manual approval and is approved immediately on creation. |
paymentCycleId | string or null | Optional | Public id (UUID) of the active payment cycle required when creating VAT-related invoice adjustment entries against a specific cycle. Format: uuid |
type | string | Required within parent | Invoice adjustment category that determines business rules and downstream invoicing behavior. One of: bonus, commission, deduction, expense, other, overtime, time_off, vat |