Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootPayload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata.
amountnumberRequired within parentMonetary amount to apply for this invoice adjustment, expressed in the contract currency as a positive number.
Format: double
Minimum: 0
contract_idstringRequired within parentUnique Deel contract identifier (public id) that receives this invoice adjustment line item.
date_submittedstringRequired within parentSubmission date in ISO-8601 short-date format (YYYY-MM-DD) used for filtering, reporting, and approvals.
Format: date
descriptionstringRequired within parentDetailed human-readable explanation that appears on invoices and audit records visible to both parties.
Maximum length: 30000
group_keystring or nullOptionalWhen 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_idstring or nullOptionalIdentifier of an existing hourly report preset used to link standardized rate and scale metadata to this entry.
Format: uuid
is_auto_approvedbooleanOptionalWhen true, the created invoice adjustment skips manual approval and is approved immediately on creation.
paymentCycleIdstring or nullOptionalPublic id (UUID) of the active payment cycle required when creating VAT-related invoice adjustment entries against a specific cycle.
Format: uuid
typestringRequired within parentInvoice adjustment category that determines business rules and downstream invoicing behavior.
One of: bonus, commission, deduction, expense, other, overtime, time_off, vat

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.