Skip to content

Deel: Milestones schemas

15 Deel schemas with complete fields and constraints.

← Milestones operations · All schemas

Create a Milestone — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a Milestone — 201 response body — data

Referenced models: Create a Milestone — 201 response body — data

Create a Milestone — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
createdbooleanRequired within parentIndicates whether the milestone was successfully created.

Create a Milestone — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Create a Milestone — request body — body data amount
descriptionstringRequired within parentA detailed description of the milestone.
titlestringRequired within parentThe title of the milestone.

Referenced models: Create a Milestone — request body — body data amount

Create a Milestone — request body — body data amount

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)stringAlternative
$ (oneOf 2)numberAlternativeFormat: double

Delete a Milestone — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Delete a Milestone — 200 response body — data

Referenced models: Delete a Milestone — 200 response body — data

Delete a Milestone — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
deletedbooleanRequired within parentConfirms that the milestone was successfully deleted.

Retrieve Milestones by Contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentAn array of milestone objects associated with the contract.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentThe amount to be paid for completing this milestone.
approval_requestedbooleanRequired within parentIndicates whether approval has been requested for the milestone.
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeThe 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)nullAlternativeThe 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})?)?$
descriptionstringRequired within parentA detailed description of the milestone.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id
reported_byModelRequired within parentExpand Retrieve Milestones by Contract — 200 response body — data item reported by
Information about the creator of the milestone.
reviewed_byJSONRequired within parentInformation about the person who reviewed the milestone.
reviewed_by (anyOf 1)ModelAlternativeExpand Retrieve Milestones by Contract — 200 response body — data item reviewed by full name, id
reviewed_by (anyOf 2)nullAlternative
statusstringRequired within parentThe current status of the milestone, such as 'Pending Approval', 'Approved', or 'Completed'.
titlestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootInformation about the creator of the milestone.
full_namestringOptionalThe full name of the person who reported the milestone.
idModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootInformation about the person who reviewed the milestone.
full_namestringOptionalThe full name of the person who reviewed the milestone.
idModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentAmount to be paid for the milestone.
approval_requestedbooleanRequired within parentIndicates if the contractor has requested the approval for the milestone.
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeLong 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)nullAlternativeLong 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})?)?$
descriptionstringRequired within parentDescription of milestone.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id
reported_byModelRequired within parentExpand Retrieve a single milestone — 200 response body — data reported by
Milestone creator.
reviewed_byJSONRequired within parentReviewer's information.
reviewed_by (anyOf 1)ModelAlternativeExpand Retrieve a single milestone — 200 response body — data reviewed by Reviewer's information
reviewed_by (anyOf 2)nullAlternative
statusstringRequired within parentCurrent status of milestone.
titlestringRequired within parentTitle 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternativeFormat: int64
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a single milestone — 200 response body — data reported by

FieldTypePresenceDescription and constraints
$objectRootMilestone creator.
full_namestringOptionalReporter's full name.
idModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootReviewer's information.
full_namestringOptionalReviewer's full name.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id

Referenced models: Retrieve a single milestone — 200 response body — data id

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.