Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parentFormat: alphanumeric
path.amendment_idstringRequired within parentFormat: uuid

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Accept amendment — 200 response body

Referenced models: Accept amendment — 200 response body

1 more schema is linked from the tables above, on the schema pages.

Accept amendment — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Accept amendment — 200 response body — data

Referenced models: Accept amendment — 200 response body — data

Accept amendment — 200 response body — data amendment statuses item
FieldTypePresenceDescription and constraints
$objectRootDetails of a specific amendment status in the lifecycle of the amendment.
amendment_flow_statusModelOptionalExpand Accept amendment — 200 response body — data amendment statuses item amendment flow status
Metadata about the amendment status, including when it was created.
friendly_namestringOptionalHuman-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED).
namestringOptionalLogical, 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
FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDetailed description of the custom amendment item
description (anyOf 2)nullAlternativeDetailed description of the custom amendment item
idstringRequired within parentUnique identifier for the custom amendment item
Format: uuid
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeReason for rejection if the item was rejected
rejection_reason (anyOf 2)nullAlternativeReason for rejection if the item was rejected
statusstringRequired within parentCurrent status of the custom amendment item
Known values: REJECTED, APPROVED, PENDING_REVIEW, PENDING_LEGAL
typestringRequired within parentType/context of the custom amendment item
Accept amendment — 200 response body — data fixed adjustments item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp when the fixed adjustment was created.
Format: date-time
descriptionstringRequired within parentDescription of the fixed adjustment.
Maximum length: 256
Minimum length: 1
idstringRequired within parentSystem-generated unique identifier for the fixed adjustment record in an amendment request.
is_amendedbooleanRequired within parentWhether this fixed adjustment was amended from a previous one.
is_country_specificbooleanRequired within parentWhether this fixed adjustment applies only to a specific country.
is_deletedbooleanOptionalTrue if the fixed adjustment was deleted as part of the amendment; otherwise false.
is_recurringbooleanRequired within parentWhether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.
parent_fixed_adjustment_idJSONOptional
parent_fixed_adjustment_id (anyOf 1)stringAlternativeReference to the parent fixed adjustment, if applicable.
parent_fixed_adjustment_id (anyOf 2)nullAlternativeReference to the parent fixed adjustment, if applicable.
statusstringRequired within parentCurrent status of the fixed adjustment.
Known values: WAITING_FOR_SIGNING, ACTIVE, OUTDATED, CANCELLED
updated_atstringRequired within parentTimestamp when the fixed adjustment was last updated.
Format: date-time
valuestringRequired within parentValue of the fixed adjustment.
Pattern: ^(?!0+(\.0+)?$)\d+(?:\.\d+)?$
Accept amendment — 200 response body — data items item
FieldTypePresenceDescription and constraints
$objectRoot
data_pointstringOptionalThe field that is selected for amendment.
idstringOptionalId of amendment item
Format: uuid
itemstringOptionalAmendment item
new_valuestringOptionalThe new valid value after the attempted change.
previous_valuestringOptionalThe previous valid value before the attempted change.
typestringOptionalType of amendment
Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED
Accept amendment — 200 response body — data legal context Additional details needed for legal input
FieldTypePresenceDescription and constraints
$objectRootAdditional details needed for legal input
detailsstringOptionalDetails regarding the legal request
jira_ticketstringOptionalJira ticket identifier linked to the legal context
jira_web_urlstringOptionalLink to the Jira ticket for tracking
Format: uri
requested_atstringOptionalTimestamp when legal review was requested
Format: date-time
statusstringOptionalCurrent 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
FieldTypePresenceDescription and constraints
$objectRootAdditional details containing rejection reason
rejected_atstringOptionalTimestamp of when the rejection occurred
Format: date-time
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeReason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin.
rejection_reason (anyOf 2)nullAlternativeReason 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
amountstringRequired within parentThe value of the compensation. Shown as a string to keep the exact number of decimals.
Format: decimal
created_atstringRequired within parentThe date and time when this record was first created in the system.
Format: date-time
effective_datestringRequired within parentThe date when this compensation starts being valid.
Format: date-time
idstringRequired within parentThe unique ID assigned by the system to this variable compensation record.
incentive_planModelOptionalExpand Accept amendment — 200 response body — data variable compensation incentive plan
Details of the incentive plan linked to this compensation, if any.
is_amendedbooleanOptionalShows whether this compensation has been changed as part of an amendment.
is_deletedbooleanOptionalShows whether this compensation has been deleted.
parent_idJSONRequired within parent
parent_id (anyOf 1)stringAlternativeReference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.
parent_id (anyOf 2)nullAlternativeReference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.
timelinestringRequired within parentHow often the compensation is paid — for example monthly, quarterly, annually, or twice a year.
Known values: MONTHLY, QUARTERLY, ANNUALLY, BIANNUALLY
titlestringRequired within parentTitle or name of the variable compensation.
typestringRequired within parentThe 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_atstringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRootMetadata about the amendment status, including when it was created.
created_atstringOptionalThe timestamp when this amendment status was created.
Format: date-time
Accept amendment — 200 response body — data variable compensation incentive plan
FieldTypePresenceDescription and constraints
$objectRootDetails of the incentive plan linked to this compensation, if any.
detailsstringOptionalExtra details about the incentive plan, if any.
employee_signaturestringOptionalThe employee’s signature for the incentive plan, if collected.
employee_signed_atstringOptionalThe date and time when the employee signed the incentive plan. Empty if not signed.
Format: date-time

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"}

Official provider source

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.