Deel: Retrieve adjustments
Deel adjustments.getContractAdjustments: arguments, response, policy and SDK examples.
← Adjustments operations · Get started
Operation deel.adjustments_getcontractadjustments
Provider route: GET /contracts/{contract_id}/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"]["getContractAdjustments"]>[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.getContractAdjustments(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.get_contract_adjustments(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 | |
query | object | Optional | Additional keys: not allowed |
query.from | string | Optional | Format: date |
query.to | string | Optional | Format: date |
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 Retrieve adjustments — 200 response body |
Referenced models: Retrieve adjustments — 200 response body
Schemas
Section titled “Schemas”Retrieve adjustments — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve adjustments — 200 response body — data item |
Referenced models: Retrieve adjustments — 200 response body — data item
Retrieve adjustments — 200 response body — data item
| 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 | JSON | Optional | |
date_of_adjustment (anyOf 1) | string | Alternative | The date of the adjustment Format: date-time |
date_of_adjustment (anyOf 2) | null | Alternative | The date of the adjustment Format: date-time |
description | string | Optional | The description of the adjustment |
file | JSON | Optional | Info for the attachment of adjustment |
file (anyOf 1) | Model | Alternative | Expand Retrieve adjustments — 200 response body — data item file Info for the attachment of adjustment |
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 | string | Optional | Adjustment status Known values: open, pending_approval, overwritten, failed, success, DRAFT, PENDING, APPROVED, DENIED, DISBURSE_SCHEDULED, REIMBURSED, UNDER_REVIEW, ERRORS_FOUND, PENDING_DEEL_REVIEW, AI_CHECK_IN_PROGRESS |
title | string | Optional | The title of the adjustment |
updated_at | string | Optional | The date and time when the adjustment was last updated Format: date-time |
Referenced models: Retrieve adjustments — 200 response body — data item file Info for the attachment of adjustment
Retrieve adjustments — 200 response body — data item file Info for the attachment of adjustment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info for the attachment of adjustment |
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.adjustments_getcontractadjustments. Catalog operation: adjustments_getcontractadjustments. 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:read"]
Pinned headers: {"X-Version": "2026-01-01"}