Deel: Get amendment by ID
Deel eorAmendments.getContractAmendmentById: arguments, response, policy and SDK examples.
← EOR amendments operations · Get started
Operation deel.eoramendments_getcontractamendmentbyid
Provider route: GET /eor/contracts/{contract_id}/amendments/{amendment_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["eorAmendments"]["getContractAmendmentById"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.eorAmendments.getContractAmendmentById(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.eor_amendments.get_contract_amendment_by_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.contract_id | string | Required within parent | Format: alphanumeric |
path.amendment_id | string | Required within parent | Format: uuid |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Accept amendment — 200 response body |
Referenced models: Accept amendment — 200 response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Accept amendment — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Accept amendment — 200 response body — data |
Referenced models: Accept amendment — 200 response body — data
Accept amendment — 200 response body — data amendment statuses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a specific amendment status in the lifecycle of the amendment. |
amendment_flow_status | Model | Optional | Expand Accept amendment — 200 response body — data amendment statuses item amendment flow status Metadata about the amendment status, including when it was created. |
friendly_name | string | Optional | Human-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED). |
name | string | Optional | Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses. |
Referenced models: Accept amendment — 200 response body — data amendment statuses item amendment flow status
Accept amendment — 200 response body — data custom items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Detailed description of the custom amendment item |
description (anyOf 2) | null | Alternative | Detailed description of the custom amendment item |
id | string | Required within parent | Unique identifier for the custom amendment item Format: uuid |
rejection_reason | JSON | Optional | |
rejection_reason (anyOf 1) | string | Alternative | Reason for rejection if the item was rejected |
rejection_reason (anyOf 2) | null | Alternative | Reason for rejection if the item was rejected |
status | string | Required within parent | Current status of the custom amendment item Known values: REJECTED, APPROVED, PENDING_REVIEW, PENDING_LEGAL |
type | string | Required within parent | Type/context of the custom amendment item |
Accept amendment — 200 response body — data fixed adjustments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp when the fixed adjustment was created. Format: date-time |
description | string | Required within parent | Description of the fixed adjustment. Maximum length: 256 Minimum length: 1 |
id | string | Required within parent | System-generated unique identifier for the fixed adjustment record in an amendment request. |
is_amended | boolean | Required within parent | Whether this fixed adjustment was amended from a previous one. |
is_country_specific | boolean | Required within parent | Whether this fixed adjustment applies only to a specific country. |
is_deleted | boolean | Optional | True if the fixed adjustment was deleted as part of the amendment; otherwise false. |
is_recurring | boolean | Required within parent | Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance. |
parent_fixed_adjustment_id | JSON | Optional | |
parent_fixed_adjustment_id (anyOf 1) | string | Alternative | Reference to the parent fixed adjustment, if applicable. |
parent_fixed_adjustment_id (anyOf 2) | null | Alternative | Reference to the parent fixed adjustment, if applicable. |
status | string | Required within parent | Current status of the fixed adjustment. Known values: WAITING_FOR_SIGNING, ACTIVE, OUTDATED, CANCELLED |
updated_at | string | Required within parent | Timestamp when the fixed adjustment was last updated. Format: date-time |
value | string | Required within parent | Value of the fixed adjustment. Pattern: ^(?!0+(\.0+)?$)\d+(?:\.\d+)?$ |
Accept amendment — 200 response body — data items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_point | string | Optional | The field that is selected for amendment. |
id | string | Optional | Id of amendment item Format: uuid |
item | string | Optional | Amendment item |
new_value | string | Optional | The new valid value after the attempted change. |
previous_value | string | Optional | The previous valid value before the attempted change. |
type | string | Optional | Type of amendment Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED |
Accept amendment — 200 response body — data legal context Additional details needed for legal input
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional details needed for legal input |
details | string | Optional | Details regarding the legal request |
jira_ticket | string | Optional | Jira ticket identifier linked to the legal context |
jira_web_url | string | Optional | Link to the Jira ticket for tracking Format: uri |
requested_at | string | Optional | Timestamp when legal review was requested Format: date-time |
status | string | Optional | Current status of the legal review process Known values: REQUEST_LEGAL_REVIEW, WAITING_FOR_ANOTHER_TEAM, WAITING_FOR_HRX_ACTION, DECLINED, SOLVED |
Accept amendment — 200 response body — data rejection context Additional details containing rejection reason
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional details containing rejection reason |
rejected_at | string | Optional | Timestamp of when the rejection occurred Format: date-time |
rejection_reason | JSON | Optional | |
rejection_reason (anyOf 1) | string | Alternative | Reason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin. |
rejection_reason (anyOf 2) | null | Alternative | Reason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin. |
Accept amendment — 200 response body — data variable compensation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended. |
amount | string | Required within parent | The value of the compensation. Shown as a string to keep the exact number of decimals. Format: decimal |
created_at | string | Required within parent | The date and time when this record was first created in the system. Format: date-time |
effective_date | string | Required within parent | The date when this compensation starts being valid. Format: date-time |
id | string | Required within parent | The unique ID assigned by the system to this variable compensation record. |
incentive_plan | Model | Optional | Expand Accept amendment — 200 response body — data variable compensation incentive plan Details of the incentive plan linked to this compensation, if any. |
is_amended | boolean | Optional | Shows whether this compensation has been changed as part of an amendment. |
is_deleted | boolean | Optional | Shows whether this compensation has been deleted. |
parent_id | JSON | Required within parent | |
parent_id (anyOf 1) | string | Alternative | Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation. |
parent_id (anyOf 2) | null | Alternative | Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation. |
timeline | string | Required within parent | How often the compensation is paid — for example monthly, quarterly, annually, or twice a year. Known values: MONTHLY, QUARTERLY, ANNUALLY, BIANNUALLY |
title | string | Required within parent | Title or name of the variable compensation. |
type | string | Required within parent | The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary. Known values: FIXED, PERCENTAGE |
updated_at | string | Required within parent | The date and time when this record was last updated. Format: date-time |
Referenced models: Accept amendment — 200 response body — data variable compensation incentive plan
Accept amendment — 200 response body — data amendment statuses item amendment flow status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata about the amendment status, including when it was created. |
created_at | string | Optional | The timestamp when this amendment status was created. Format: date-time |
Accept amendment — 200 response body — data variable compensation incentive plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the incentive plan linked to this compensation, if any. |
details | string | Optional | Extra details about the incentive plan, if any. |
employee_signature | string | Optional | The employee’s signature for the incentive plan, if collected. |
employee_signed_at | string | Optional | The date and time when the employee signed the incentive plan. Empty if not signed. Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eoramendments_getcontractamendmentbyid. Catalog operation: eoramendments_getcontractamendmentbyid. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["contracts:read"]
Pinned headers: {"X-Version": "2026-01-01"}