Amendment Statuses
Amendment statuses
Amendments pass through multiple statuses from creation to completion. The API returns these statuses in an array within the response. Check the most recent status to determine the amendment’s current state.
Amendment status structure
Amendment statuses are hierarchical: each dot-separated segment in the name field adds a level of detail. The tables below document the possible name values, grouped by lifecycle stage. Use the name field for branching logic in your integration. See Status payload at the end of this page for the full object shape and the friendly_name field.
Draft stage
Amendments that are still being prepared and can be modified.
Preparing documents stage
Statuses related to document preparation and internal review. Documents are being created, reviewed, or paused for input before signatures can begin. No action required by you in this case, fetch the amendments to get the latest status.
PREPARING_DOCUMENTS.AMENDMENT_REQUESTED checkpoints
PREPARING_DOCUMENTS.PAUSED checkpoints
PREPARING_DOCUMENTS.WAITING_HRX_ACTION checkpoints
Signature stage
These statuses indicate the amendment is awaiting signature, either from Deel as countersign or from the client or employee. The flow splits into two tracks: EA (Employee Agreement) for changes the employee must sign, and SOW (Statement of Work) for changes the client must sign.
AWAITING_SIGNATURE.EA tracking checkpoints
AWAITING_SIGNATURE.SOW tracking checkpoints
Active or upcoming stage
Statuses when an amendment is in effect or scheduled for the future.
Canceled, rejected, or void stage
Statuses for amendments that were canceled, rejected, or voided.
How to read amendment statuses
Amendment statuses are structured in a hierarchical format, where each level provides increasing detail about the amendment’s progress.
1. Parent phase
- Represents the overall stage of the amendment, for example
PREPARING_DOCUMENTS. - Indicates the broad area of progress, such as document preparation, review, or approval.
2. Sub-step
- A more specific action within the parent phase, for example
PREPARING_DOCUMENTS.AMENDMENT_REQUESTED. - Helps identify what part of the larger process is currently active.
3. Detailed checkpoint
- Provides the most detailed level of the amendment’s status, for example
PREPARING_DOCUMENTS.AMENDMENT_REQUESTED.SOW.PENDING_DOCUMENT_SUBMIT. - Clarifies the current condition of the amendment, such as pending submission, under review, or awaiting approval.
By reading an amendment status from left to right, you can move from the broad phase to the precise checkpoint, making it easy to understand exactly where the amendment stands in the process.
Why this matters
- Each nested level gives increasing detail about the amendment’s progress.
- The high-level phase always represents the current overall state of the amendment, for example
PREPARING_DOCUMENTS,ACTIVE,UPCOMING, orCANCELLED. - Sub-steps and detailed checkpoints record the lifecycle progression of the amendment. This is useful for auditing, troubleshooting, and tracking how the amendment evolved over time.
The parent status is the single source of truth for the amendment’s current state. The history should not be used to infer the current status, for example by taking the last status in the array.
Status payload
Each entry in the status history array has the following shape:
The example below shows an amendment in the PREPARING_DOCUMENTS phase. The request is logged as PREPARING_DOCUMENTS.AMENDMENT_REQUESTED, and the amendment is waiting for Deel review at the PREPARING_DOCUMENTS.AMENDMENT_REQUESTED.SOW.PENDING_DOCUMENT_SUBMIT checkpoint: