Deel: Update an adjustment

← adjustments operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.adjustments_updatecontractadjustment

Provider route: PATCH /adjustments/{id}. Alter supplies the connection’s credentials and routing.

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["adjustments"]["updateContractAdjustment"]>[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.adjustments.updateContractAdjustment(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.adjustments.update_contract_adjustment(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent
body	object	Optional
body.data	object	Required within parent	Details of adjustment to update
body.data.adjustment_category_id	string	Optional	Adjustment category id. Minimum length: 25
body.data.amount	JSON	Optional	Amount of adjustment.
body.data.amount (oneOf 1)	string	Alternative
body.data.amount (oneOf 2)	number	Alternative	Format: double
body.data.country	string	Optional	Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$
body.data.date_of_adjustment	string	Optional	Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date
body.data.description	string	Optional	Description of adjustment. Maximum length: 255 Minimum length: 3
body.data.file	object	Optional	File of adjustment. Accepted file types: JPEG, PNG, HEIC, WebP, GIF, BMP, TIFF, HEIF images and PDF documents. Additional keys: not allowed
body.data.file.filename	string	Required within parent	Minimum length: 1
body.data.file.content_type	string	Required within parent	Minimum length: 1
body.data.file.content_base64	string	Required within parent
body.data.odp_only	boolean	Optional	EOR contracts only. Restrict the adjustment to on-demand payroll: when true it is never attached to a regular payroll cycle, and it is automatically denied if it is still not part of an on-demand payroll 30 days after creation. Sending it for any other contract type is rejected, because on-demand payroll does not exist there. Editable only through this API, and it forces move_next_cycle to false.
body.data.title	string	Optional	Title of adjustment. Maximum length: 255 Minimum length: 3
body.data.vendor_name	string	Optional	Vendor name of adjustment. Maximum length: 255 Minimum length: 1

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 Update an adjustment — 200 response body

Referenced models: Update an adjustment — 200 response body

Policy, approvals and errors

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

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source