Skip to content

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.

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 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.get_contract_adjustments(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
queryobjectOptionalAdditional keys: not allowed
query.fromstringOptionalFormat: date
query.tostringOptionalFormat: date

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve adjustments — 200 response body

Referenced models: Retrieve adjustments — 200 response body

Retrieve adjustments — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve adjustments — 200 response body — data item

Referenced models: Retrieve adjustments — 200 response body — data item

Retrieve adjustments — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
actual_end_cycle_datestringOptionalThe date of the actual end cycle date
actual_start_cycle_datestringOptionalThe date of the actual start cycle date
adjustment_category_idstringOptionalThe identifier of the adjustment category associated with the adjustment
amountstringOptionalThe amount of the adjustment
contract_idstringOptionalThe identifier of the contract associated with the adjustment
created_atstringOptionalThe date and time when the adjustment was created
Format: date-time
cycle_referenceJSONOptional
cycle_reference (anyOf 1)stringAlternativeThe reference to the cycle associated with the adjustment
cycle_reference (anyOf 2)nullAlternativeThe reference to the cycle associated with the adjustment
date_of_adjustmentJSONOptional
date_of_adjustment (anyOf 1)stringAlternativeThe date of the adjustment
Format: date-time
date_of_adjustment (anyOf 2)nullAlternativeThe date of the adjustment
Format: date-time
descriptionstringOptionalThe description of the adjustment
fileJSONOptionalInfo for the attachment of adjustment
file (anyOf 1)ModelAlternativeExpand Retrieve adjustments — 200 response body — data item file Info for the attachment of adjustment
file (anyOf 2)nullAlternative
idstringOptionalThe unique identifier of the adjustment
move_next_cyclebooleanOptionalIf an adjustments can belong to another payroll cycle
odp_onlybooleanOptionalWhether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle. Always false for contract types other than EOR
statusstringOptionalAdjustment 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
titlestringOptionalThe title of the adjustment
updated_atstringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootInfo for the attachment of adjustment
fileTypestringOptionalThe type of the file
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file

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

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.