Deel: Create a new contract — request body — body data type: payg milestones, who reports: both, client, contractor compensation details
Create a new contract: request body, field body / data / type: payg_milestones, who_reports: both, client, contractor / compensation_details. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation and invoicing configuration for the contract. |
amount | number | Optional | Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts. Format: double |
currency_code | string | Required within parent | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
cycle_end | number | Required within parent | Date invoice cycle ends. Format: double Maximum: 31 Minimum: 1 |
cycle_end_type | string | Required within parent | Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31. One of: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH |
first_payment | number | Optional | First payment amount. Default: 0 Format: double Minimum: 0 |
first_payment_date | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. |
frequency | string | Required within parent | Scale of the invoice cycle. One of: weekly, monthly, biweekly, semimonthly, calendar-month |
notice_period | number | Optional | Days before to notice the termination of contract for either party. Default: 10 Format: double Minimum: 0 |
pay_before_weekends | boolean | Optional | If the payment due is on a weekend, pay on Friday. |
payment_due_days | number | Required within parent | Number of days to pay the invoice. Format: double Maximum: 90 Minimum: 0 |
payment_due_type | string | Required within parent | Type of payment due. If the payment is due on the last day of month, enter ‘WITHIN_MONTH’. If the payment is due some days after the end of the month, enter ‘AFTER_MONTH’. If the payment is due before the end of the invoice cycle, enter ‘BEFORE_CYCLE_END’. Default: REGULAR One of: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END |