Skip to content

Deel: Update contract

Deel contractorAmendments.createContractAmendment: arguments, response, policy and SDK examples.

← Contractor amendments operations · Get started

Operation deel.contractoramendments_createcontractamendment

Provider route: POST /contracts/{contract_id}/amendments. 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["contractorAmendments"]["createContractAmendment"]>[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.contractorAmendments.createContractAmendment(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.contractor_amendments.create_contract_amendment(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 parent
bodyobjectOptional
body.dataModelRequired within parentExpand Update contract — request body — body data

Referenced models: Update contract — request body — body data

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Update contract — 201 response body

Referenced models: Update contract — 201 response body

5 more schemas are linked from the tables above, on the schema pages.

Update contract — request body — body data
FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom
$ (oneOf 2)ModelAlternativeExpand Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct

Referenced models: Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom, Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct

Update contract — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update contract — 201 response body — data

Referenced models: Update contract — 201 response body — data

Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom
FieldTypePresenceDescription and constraints
$objectRootYou can specify any combination of data points that need changing.
amountnumberOptionalAmount to be paid per scale.
Format: double
Minimum: 1
currency_codestringOptionalCurrency code in ISO 4217 format.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
cycle_endnumberOptionalDay of the month when the cycle ends.
Format: double
Maximum: 31
Minimum: 1
cycle_end_typestringOptionalCycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
One of: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH
effective_datestringOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
first_paymentnumberOptionalAmount to be paid as the first payment.
Format: double
Minimum: 0
first_payment_datestringOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
frequencystringOptionalScale of the invoice cycle.
One of: weekly, monthly, biweekly, semimonthly, calendar-month
job_title_idModelOptionalExpand Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom job title id
job_title_namestringOptionalYou can enter new job title.
pay_before_weekendsbooleanOptionalIf the payment due is on a weekend, pay on Friday.
payment_due_daysnumberOptionalNumber of days after the invoice is sent that the payment is due.
Format: double
Maximum: 90
Minimum: 0
payment_due_typestringOptionalType of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'.
Default: REGULAR
One of: REGULAR, WITHIN_MONTH
scalestringOptionalDefines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
One of: hourly, daily, weekly, monthly, biweekly, semimonthly, custom
scope_of_workstringOptionalText to describe the scope of work of the contract.
seniority_idModelOptionalExpand Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom job title id
special_clausestringOptionalText to describe any special clause in contract.
start_datestringOptionalThe contract start date in ISO-8601 format (YYYY-MM-DD). Updates the contract's effective date.
Format: date

Referenced models: Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom job title id

Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct
FieldTypePresenceDescription and constraints
$objectRootYou can specify any combination of data points that need changing for a Global Payroll amendment, alongside the required effective_date.
amountnumberOptionalBase compensation amount to be paid per scale.
Format: double
Maximum: 1000000000
Minimum: 0
base_compensation_custom_namestringOptionalCustom display name for the base compensation.
Maximum length: 255
base_compensation_typestringOptionalType of base compensation. Defaults to salaried if base compensation fields are provided and this is omitted.
Default: salaried
One of: salaried, hourly, unpaid, commission_only
change_reasonstringOptionalThe unique identifier (oid) of a modification reason configured for the organization, not free text. Required by organizations that have modification reasons configured.
Format: uuid
contract_start_datestringOptionalShort date in format ISO-8601 (YYYY-MM-DD). The contract start date.
Format: date
contract_termstringOptionalWhether the contract has a fixed end date. 'end_date' is required when this is 'definite'.
One of: definite, indefinite
currency_codestringOptionalCurrency code in ISO 4217 format.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_fieldsarrayOptionalCustom field values to update.
custom_fields[]ModelEach itemExpand Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct custom fields item
effective_datestringRequired within parentShort date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Required — the amendment cannot be signed without it.
Format: date
end_datestringOptionalShort date in format ISO-8601 (YYYY-MM-DD). Required when contract_term is 'definite'.
Format: date
pay_slip_currencystringOptionalCurrency shown on the payslip.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
payout_currencystringOptionalCurrency the worker is paid out in.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
scalestringOptionalDefines the scale at which the base compensation amount is paid.
One of: hourly, daily, weekly, monthly, annually, two_weekly, bi_monthly, custom, one_off
type_of_editstringOptionalWhether the change requires a signature. 'amendment' (default) creates a pending amendment that must be signed via POST /contracts/{contract_id}/amendments/{amendment_id}/sign before it takes effect. 'direct' applies the change immediately, with no signature required.
Default: amendment
One of: amendment, direct
variable_compensationsarrayOptionalVariable compensations to add or update alongside the base compensation change.
variable_compensations[]ModelEach itemExpand Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct variable compensations item

Referenced models: Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct custom fields item, Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct variable compensations item

Update contract — 201 response body — data
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update contract — 201 response body — data / status: initial, pending, active, outdated, approved, declined
$ (anyOf 2)ModelAlternativeExpand Update contract — 201 response body — data base compensation type, created, created at, currency code, effective date, id, rate, scale, status, updated at

Referenced models: Update contract — 201 response body — data / status: initial, pending, active, outdated, approved, declined, Update contract — 201 response body — data base compensation type, created, created at, currency code, effective date, id, rate, scale, status, updated at

Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom job title id
FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)stringAlternative
$ (oneOf 2)integerAlternativeFormat: int64

SDK function policy ID: deel.contractoramendments_createcontractamendment. Catalog operation: contractoramendments_createcontractamendment. 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:write"]

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.