Deel: Retrieve invoice adjustment by ID
Deel invoiceAdjustments.getInvoiceAdjustmentById: arguments, response, policy and SDK examples.
← Invoice adjustments operations · Get started
Operation deel.invoiceadjustments_getinvoiceadjustmentbyid
Provider route: GET /invoice-adjustments/{id}. 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["invoiceAdjustments"]["getInvoiceAdjustmentById"]>[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.invoiceAdjustments.getInvoiceAdjustmentById(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.invoice_adjustments.get_invoice_adjustment_by_id(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.id | string | Required within parent |
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 invoice adjustment by ID — 200 response body |
Referenced models: Retrieve invoice adjustment by ID — 200 response body
Schemas
Section titled “Schemas”4 more schemas are linked from the tables above, on the schema pages.
Retrieve invoice adjustment by ID — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data |
Referenced models: Retrieve invoice adjustment by ID — 200 response body — data
Retrieve invoice adjustment by ID — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approvers | array | Optional | |
approvers[] | Model | Each item | Expand Retrieve invoice adjustment by ID — 200 response body — data approvers item |
attachment | JSON | Required within parent | File attachment linked to the invoice adjustment. |
attachment (anyOf 1) | Model | Alternative | Expand Retrieve invoice adjustment by ID — 200 response body — data attachment File attachment linked to the invoice adjustment |
attachment (anyOf 2) | null | Alternative | |
contract | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data contract |
created_at | string | Required within parent | Long date-time format following ISO-8601 Format: date-time |
currency_code | JSON | Required within parent | |
currency_code (anyOf 1) | string | Alternative | Three-letter ISO-4217 currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency_code (anyOf 2) | null | Alternative | Three-letter ISO-4217 currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_scale | JSON | Optional | |
custom_scale (anyOf 1) | string | Alternative | A custom unit of measurement if the standard 'scale' is not applicable. |
custom_scale (anyOf 2) | null | Alternative | A custom unit of measurement if the standard 'scale' is not applicable. |
date_submitted | JSON | Required within parent | |
date_submitted (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
date_submitted (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
description | string | Required within parent | Details or notes regarding the adjustment. |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier of this resource. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of this resource. Format: uuid |
invoice_id | JSON | Optional | |
invoice_id (anyOf 1) | JSON | Alternative | |
invoice_id (anyOf 1) (anyOf 1) | number | Alternative | Deprecated. No longer used Format: double |
invoice_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
invoice_id (anyOf 2) | null | Alternative | Deprecated. No longer used Format: double |
invoice_public_id | JSON | Optional | |
invoice_public_id (anyOf 1) | string | Alternative | Public Identifier for the associated invoice. |
invoice_public_id (anyOf 2) | null | Alternative | Public Identifier for the associated invoice. |
payment_cycle | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data payment cycle |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | The quantity/number of units applied. Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | The quantity/number of units applied. Format: double |
reported_by | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data reported by The user who reported/submitted the adjustment. |
reviewed_by | JSON | Required within parent | The user who reviewed the adjustment. |
reviewed_by (anyOf 1) | Model | Alternative | Expand Retrieve invoice adjustment by ID — 200 response body — data reviewed by The user who reviewed the adjustment |
reviewed_by (anyOf 2) | null | Alternative | |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | The scale used for calculation (e.g., hourly, daily). |
scale (anyOf 2) | null | Alternative | The scale used for calculation (e.g., hourly, daily). |
status | JSON | Required within parent | status of invoice adjustment |
status (anyOf 1) | string | Alternative | status of invoice adjustment Known values: approved, declined, new, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative | |
total_amount | string | Required within parent | The total monetary value of the adjustment. |
type | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data type Type of invoice adjustment. |
worksheet | JSON | Required within parent | Breakdown of the time/effort involved in the adjustment. |
worksheet (anyOf 1) | Model | Alternative | Expand Retrieve invoice adjustment by ID — 200 response body — data worksheet days, hours, minutes, weeks |
worksheet (anyOf 2) | null | Alternative |
Referenced models: Retrieve invoice adjustment by ID — 200 response body — data approvers item, Retrieve invoice adjustment by ID — 200 response body — data type, Retrieve invoice adjustment by ID — 200 response body — data attachment File attachment linked to the invoice adjustment, Retrieve invoice adjustment by ID — 200 response body — data contract, Retrieve invoice adjustment by ID — 200 response body — data payment cycle, Retrieve invoice adjustment by ID — 200 response body — data reported by, Retrieve invoice adjustment by ID — 200 response body — data reviewed by The user who reviewed the adjustment, Retrieve invoice adjustment by ID — 200 response body — data worksheet days, hours, minutes, weeks
Retrieve invoice adjustment by ID — 200 response body — data approvers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approved | boolean | Required within parent | Whether the specific approver has approved the adjustment. |
email | string | Optional | Email address of the approver. |
full_name | string | Optional | Full name of the approver. |
Retrieve invoice adjustment by ID — 200 response body — data type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Type of invoice adjustment. Known values: accrued_holiday, additional_fee, allowance, bonus, commission, deduction, deposit, deposit_refund, employer_cost, expense, health_allowance, health_benefit, health_insurance_fee, legal_fee, management_fee, milestone, offcycle, other, overtime, pension, pro_rata, setup_fee, severance, shield_service, signing_bonus, signing_bonus_employer_cost, refund, task, time_off, vat, withholding_tax, work |
Retrieve invoice adjustment by ID — 200 response body — data attachment File attachment linked to the invoice adjustment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | File attachment linked to the invoice adjustment. |
download_url | JSON | Optional | |
download_url (anyOf 1) | string | Alternative | URL used to download the uploaded attachment file. |
download_url (anyOf 2) | null | Alternative | URL used to download the uploaded attachment file. |
filename | string | Required within parent | Original filename of the uploaded attachment |
key | string | Required within parent | Deprecated. Legacy storage key; empty when the attachment is held by the file service. Use download_url to retrieve the file. |
Retrieve invoice adjustment by ID — 200 response body — data contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the contract. |
title | string | Required within parent | The display title of the contract. |
type | string | Required within parent | Type of a contract Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, employee, global_payroll, gp_client_agreement, shield_msa, hris_direct_employee, peo |
Retrieve invoice adjustment by ID — 200 response body — data payment cycle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
end_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
start_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.invoiceadjustments_getinvoiceadjustmentbyid. Catalog operation: invoiceadjustments_getinvoiceadjustmentbyid. 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: ["invoice-adjustments:read", "worker:read"]
Pinned headers: {"X-Version": "2026-01-01"}