Deel: Add external Id — 200 response body — compensation details

Add external Id: 200 response body, field compensation_details. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Add external Id — 200 response body — compensation details

Field	Type	Presence	Description and constraints
`$`	object	Root	Compensation and payment configuration for the contract.
`amount`	JSON	Optional
`amount (anyOf 1)`	string	Alternative	Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
`amount (anyOf 2)`	null	Alternative	Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
`currency_code`	JSON	Optional
`currency_code (anyOf 1)`	string	Alternative	Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$
`currency_code (anyOf 2)`	null	Alternative	Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$
`cycle_end`	JSON	Optional
`cycle_end (anyOf 1)`	JSON	Alternative
`cycle_end (anyOf 1) (anyOf 1)`	number	Alternative	Day of the cycle end Format: double
`cycle_end (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`cycle_end (anyOf 2)`	null	Alternative	Day of the cycle end Format: double
`cycle_end_type`	JSON	Optional	Cycle end type
`cycle_end_type (anyOf 1)`	string	Alternative	Cycle end type Known values: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH
`cycle_end_type (anyOf 2)`	null	Alternative
`first_payment`	JSON	Optional
`first_payment (anyOf 1)`	string	Alternative	First payment amount.
`first_payment (anyOf 2)`	null	Alternative	First payment amount.
`first_payment_date`	JSON	Optional
`first_payment_date (anyOf 1)`	string	Alternative	First payment date.
`first_payment_date (anyOf 2)`	null	Alternative	First payment date.
`frequency`	string	Optional	Scale of the invoice cycle.
`gross_annual_salary`	JSON	Optional
`gross_annual_salary (anyOf 1)`	string	Alternative	Gross annual salary.
`gross_annual_salary (anyOf 2)`	null	Alternative	Gross annual salary.
`gross_signing_bonus`	JSON	Optional
`gross_signing_bonus (anyOf 1)`	string	Alternative	Gross signing bonus.
`gross_signing_bonus (anyOf 2)`	null	Alternative	Gross signing bonus.
`gross_variable_bonus`	JSON	Optional
`gross_variable_bonus (anyOf 1)`	string	Alternative	Gross variable bonus.
`gross_variable_bonus (anyOf 2)`	null	Alternative	Gross variable bonus.
`scale`	JSON	Optional
`scale (anyOf 1)`	string	Alternative	Scale of the payment.
`scale (anyOf 2)`	null	Alternative	Scale of the payment.

Report an issue with this page