Deel: Milestones schemas
15 Deel schemas with complete fields and constraints.
← Milestones operations · All schemas
Create a Milestone — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a Milestone — 201 response body — data |
Referenced models: Create a Milestone — 201 response body — data
Create a Milestone — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | boolean | Required within parent | Indicates whether the milestone was successfully created. |
Create a Milestone — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Create a Milestone — request body — body data amount |
description | string | Required within parent | A detailed description of the milestone. |
title | string | Required within parent | The title of the milestone. |
Referenced models: Create a Milestone — request body — body data amount
Create a Milestone — request body — body data amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | number | Alternative | Format: double |
Delete a Milestone — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Delete a Milestone — 200 response body — data |
Referenced models: Delete a Milestone — 200 response body — data
Delete a Milestone — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Required within parent | Confirms that the milestone was successfully deleted. |
Retrieve Milestones by Contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | An array of milestone objects associated with the contract. |
data[] | Model | Each item | Expand Retrieve Milestones by Contract — 200 response body — data item |
Referenced models: Retrieve Milestones by Contract — 200 response body — data item
Retrieve Milestones by Contract — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | The amount to be paid for completing this milestone. |
approval_requested | boolean | Required within parent | Indicates whether approval has been requested for the milestone. |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | The creation date of the milestone in ISO-8601 format. Pattern: ^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$ |
created_at (anyOf 2) | null | Alternative | The creation date of the milestone in ISO-8601 format. Pattern: ^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$ |
description | string | Required within parent | A detailed description of the milestone. |
id | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data id |
reported_by | Model | Required within parent | Expand Retrieve Milestones by Contract — 200 response body — data item reported by Information about the creator of the milestone. |
reviewed_by | JSON | Required within parent | Information about the person who reviewed the milestone. |
reviewed_by (anyOf 1) | Model | Alternative | Expand Retrieve Milestones by Contract — 200 response body — data item reviewed by full name, id |
reviewed_by (anyOf 2) | null | Alternative | |
status | string | Required within parent | The current status of the milestone, such as 'Pending Approval', 'Approved', or 'Completed'. |
title | string | Required within parent | The title of the milestone. |
Referenced models: Retrieve a single milestone — 200 response body — data id, Retrieve Milestones by Contract — 200 response body — data item reported by, Retrieve Milestones by Contract — 200 response body — data item reviewed by full name, id
Retrieve Milestones by Contract — 200 response body — data item reported by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the creator of the milestone. |
full_name | string | Optional | The full name of the person who reported the milestone. |
id | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data id |
Referenced models: Retrieve a single milestone — 200 response body — data id
Retrieve Milestones by Contract — 200 response body — data item reviewed by full name, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the person who reviewed the milestone. |
full_name | string | Optional | The full name of the person who reviewed the milestone. |
id | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data id |
Referenced models: Retrieve a single milestone — 200 response body — data id
Retrieve a single milestone — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data |
Referenced models: Retrieve a single milestone — 200 response body — data
Retrieve a single milestone — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Amount to be paid for the milestone. |
approval_requested | boolean | Required within parent | Indicates if the contractor has requested the approval for the milestone. |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Pattern: ^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$ |
created_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Pattern: ^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$ |
description | string | Required within parent | Description of milestone. |
id | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data id |
reported_by | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data reported by Milestone creator. |
reviewed_by | JSON | Required within parent | Reviewer's information. |
reviewed_by (anyOf 1) | Model | Alternative | Expand Retrieve a single milestone — 200 response body — data reviewed by Reviewer's information |
reviewed_by (anyOf 2) | null | Alternative | |
status | string | Required within parent | Current status of milestone. |
title | string | Required within parent | Title of milestone. |
Referenced models: Retrieve a single milestone — 200 response body — data id, Retrieve a single milestone — 200 response body — data reported by, Retrieve a single milestone — 200 response body — data reviewed by Reviewer's information
Retrieve a single milestone — 200 response body — data id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | integer | Alternative | Format: int64 |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a single milestone — 200 response body — data reported by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Milestone creator. |
full_name | string | Optional | Reporter's full name. |
id | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data id |
Referenced models: Retrieve a single milestone — 200 response body — data id
Retrieve a single milestone — 200 response body — data reviewed by Reviewer's information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reviewer's information. |
full_name | string | Optional | Reviewer's full name. |
id | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data id |
Referenced models: Retrieve a single milestone — 200 response body — data id