Deel: List work statement payment policies — 200 response body — data item
List work statement payment policies: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: List work statement payment policies — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A work statement payment policy of the organization. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the payment policy. |
description (anyOf 2) | null | Alternative | Description of the payment policy. |
due_days | JSON | Required within parent | |
due_days (anyOf 1) | integer | Alternative | Number of days after cycle end before payment is released. |
due_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
due_type | string | Required within parent | How the payment due date is calculated relative to cycle end. Known values: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END |
end_day | JSON | Required within parent | |
end_day (anyOf 1) | integer | Alternative | Day the billing cycle ends. 1–31 when end_type is DAY_OF_MONTH, 1–7 when DAY_OF_WEEK or DAY_OF_LAST_WEEK. |
end_day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
end_type | string | Required within parent | How end_day is interpreted. Known values: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH |
end_week_parity | JSON | Optional | Week parity constraint for biweekly cycles. Null for non-biweekly scales. |
end_week_parity (anyOf 1) | string | Alternative | Week parity constraint for biweekly cycles. Null for non-biweekly scales. Known values: AUTO, ODD, EVEN |
end_week_parity (anyOf 2) | null | Alternative | |
id | string | Required within parent | The public ID (UUID) of the payment policy. Format: uuid |
name | string | Required within parent | Name of the payment policy. |
scale | string | Required within parent | Payment cycle frequency. Known values: WEEKLY, MONTHLY, BIWEEKLY, SEMIMONTHLY, CALENDAR_MONTH |
semimonthly_first_day | JSON | Optional | |
semimonthly_first_day (anyOf 1) | JSON | Alternative | |
semimonthly_first_day (anyOf 1) (anyOf 1) | integer | Alternative | First payment day of the month for semimonthly cycles. Null for other scales. |
semimonthly_first_day (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
semimonthly_first_day (anyOf 2) | null | Alternative | First payment day of the month for semimonthly cycles. Null for other scales. |
semimonthly_second_day | JSON | Optional | |
semimonthly_second_day (anyOf 1) | JSON | Alternative | |
semimonthly_second_day (anyOf 1) (anyOf 1) | integer | Alternative | Second payment day of the month for semimonthly cycles. Null for other scales. |
semimonthly_second_day (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
semimonthly_second_day (anyOf 2) | null | Alternative | Second payment day of the month for semimonthly cycles. Null for other scales. |
should_pay_before_weekends | boolean | Required within parent | Whether payment is moved earlier when the due date falls on a weekend. |