Deel: Create a new adjustment
Deel adjustments.createContractAdjustment: arguments, response, policy and SDK examples.
← Adjustments operations · Get started
Operation deel.adjustments_createcontractadjustment
Provider route: POST /adjustments. 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["adjustments"]["createContractAdjustment"]>[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.createContractAdjustment(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.adjustments.create_contract_adjustment(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create a new adjustment — request body — body data Details of adjustment to create |
Referenced models: Create a new adjustment — request body — body data
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 Create a new adjustment — 201 response body |
Referenced models: Create a new adjustment — 201 response body
Schemas
Section titled “Schemas”Create a new adjustment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of adjustment to create |
adjustment_category_id | string | Required within parent | Adjustment category id. Minimum length: 25 |
amount | Model | Required within parent | Expand Create a new adjustment — request body — body data amount Amount of adjustment. |
contract_id | string | Required within parent | The identifier of the contract associated with the adjustment Minimum length: 5 |
country | string | Optional | Country the expense was incurred in, which is not necessarily the contract country. Conditionally required: for adjustment categories configured to require a country, which is typically an expense category, and for Global Payroll contracts whenever the organization has the compliance check enabled, which applies to any category. Leave the field out entirely when it does not apply - sending it empty is rejected, because the pattern still applies to a value that is present. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
cycle_reference | string | Optional | Cycle reference of adjustment. |
date_of_adjustment | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date |
description | string | Required within parent | Description of adjustment. Maximum length: 255 Minimum length: 3 |
move_next_cycle | boolean or null | Optional | If an adjustments can belong to another payroll cycle. |
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. |
submitter_profile_id | integer or null | Optional | The identifier of the profile that submits the adjustment. Must be a profile authorized on the target contract. When omitted, the adjustment is attributed to the profile resolved from the API token. Minimum: 1 |
title | string | Required within parent | Title of adjustment. Maximum length: 255 Minimum length: 3 |
vendor | string | Optional | Vendor of adjustment. Conditionally required: for adjustment categories configured to require a vendor, which is typically an expense category, and for Global Payroll contracts whenever the organization has the compliance check enabled, which applies to any category. Leave the field out entirely when it does not apply - sending it empty is rejected, because the length constraint still applies to a value that is present. Minimum length: 3 |
Referenced models: Create a new adjustment — request body — body data amount
Create a new adjustment — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a new adjustment — 201 response body — data |
Referenced models: Create a new adjustment — 201 response body — data
Create a new adjustment — request body — body data amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Amount of adjustment. |
$ (oneOf 1) | string | Alternative | Minimum length: 1 |
$ (oneOf 2) | number | Alternative | Format: double Minimum: 1 |
Create a new adjustment — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actual_end_cycle_date | string | Optional | The date of the actual end cycle date |
actual_start_cycle_date | string | Optional | The date of the actual start cycle date |
adjustment_category_id | string | Optional | The identifier of the adjustment category associated with the adjustment |
amount | string | Optional | The amount of the adjustment |
contract_id | string | Optional | The identifier of the contract associated with the adjustment |
created_at | string | Optional | The date and time when the adjustment was created Format: date-time |
cycle_reference | JSON | Optional | |
cycle_reference (anyOf 1) | string | Alternative | The reference to the cycle associated with the adjustment |
cycle_reference (anyOf 2) | null | Alternative | The reference to the cycle associated with the adjustment |
date_of_adjustment | string | Optional | The date of the adjustment Format: date-time |
description | string | Optional | The description of the adjustment |
file | JSON | Optional | Adjustment attachment |
file (anyOf 1) | Model | Alternative | Expand Create a new adjustment — 201 response body — data file Adjustment attachment |
file (anyOf 2) | null | Alternative | |
id | string | Optional | The unique identifier of the adjustment |
move_next_cycle | boolean | Optional | If an adjustments can belong to another payroll cycle |
odp_only | boolean | Optional | Whether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR |
status | Model | Optional | Expand Create a new adjustment — 201 response body — data status The status of the adjustments |
title | string | Optional | The title of the adjustment Maximum length: 255 Minimum length: 3 |
updated_at | string | Optional | The date and time when the adjustment was last updated Format: date-time |
Referenced models: Create a new adjustment — 201 response body — data file Adjustment attachment, Create a new adjustment — 201 response body — data status
Create a new adjustment — 201 response body — data file Adjustment attachment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Adjustment attachment |
fileType | string | Optional | The type of the file |
id | string | Optional | The unique identifier of the file |
name | string | Optional | The name of the file |
Create a new adjustment — 201 response body — data status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The status of the adjustments |
$ (anyOf 1) | string | Alternative | Adjustment status (when contract type is GP) Known values: OPEN, PENDING_APPROVAL, OVERWRITTEN, FAILED, SUCCESS, AI_CHECK_IN_PROGRESS |
$ (anyOf 2) | string | Alternative | Adjustment status (when contract type is EOR) Known values: DRAFT, PENDING, ERRORS_FOUND, APPROVED, DENIED, DISBURSE_SCHEDULED, REIMBURSED, UNDER_REVIEW, PENDING_DEEL_REVIEW |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.adjustments_createcontractadjustment. Catalog operation: adjustments_createcontractadjustment. 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"}