Skip to content

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.

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 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.invoice_adjustments.get_invoice_adjustment_by_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve invoice adjustment by ID — 200 response body

Referenced models: Retrieve invoice adjustment by ID — 200 response body

4 more schemas are linked from the tables above, on the schema pages.

Retrieve invoice adjustment by ID — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
approversarrayOptional
approvers[]ModelEach itemExpand Retrieve invoice adjustment by ID — 200 response body — data approvers item
attachmentJSONRequired within parentFile attachment linked to the invoice adjustment.
attachment (anyOf 1)ModelAlternativeExpand Retrieve invoice adjustment by ID — 200 response body — data attachment File attachment linked to the invoice adjustment
attachment (anyOf 2)nullAlternative
contractModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data contract
created_atstringRequired within parentLong date-time format following ISO-8601
Format: date-time
currency_codeJSONRequired within parent
currency_code (anyOf 1)stringAlternativeThree-letter ISO-4217 currency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
currency_code (anyOf 2)nullAlternativeThree-letter ISO-4217 currency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_scaleJSONOptional
custom_scale (anyOf 1)stringAlternativeA custom unit of measurement if the standard 'scale' is not applicable.
custom_scale (anyOf 2)nullAlternativeA custom unit of measurement if the standard 'scale' is not applicable.
date_submittedJSONRequired within parent
date_submitted (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
date_submitted (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
descriptionstringRequired within parentDetails or notes regarding the adjustment.
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier of this resource.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of this resource.
Format: uuid
invoice_idJSONOptional
invoice_id (anyOf 1)JSONAlternative
invoice_id (anyOf 1) (anyOf 1)numberAlternativeDeprecated. No longer used
Format: double
invoice_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
invoice_id (anyOf 2)nullAlternativeDeprecated. No longer used
Format: double
invoice_public_idJSONOptional
invoice_public_id (anyOf 1)stringAlternativePublic Identifier for the associated invoice.
invoice_public_id (anyOf 2)nullAlternativePublic Identifier for the associated invoice.
payment_cycleModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data payment cycle
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeThe quantity/number of units applied.
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeThe quantity/number of units applied.
Format: double
reported_byModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data reported by
The user who reported/submitted the adjustment.
reviewed_byJSONRequired within parentThe user who reviewed the adjustment.
reviewed_by (anyOf 1)ModelAlternativeExpand Retrieve invoice adjustment by ID — 200 response body — data reviewed by The user who reviewed the adjustment
reviewed_by (anyOf 2)nullAlternative
scaleJSONOptional
scale (anyOf 1)stringAlternativeThe scale used for calculation (e.g., hourly, daily).
scale (anyOf 2)nullAlternativeThe scale used for calculation (e.g., hourly, daily).
statusJSONRequired within parentstatus of invoice adjustment
status (anyOf 1)stringAlternativestatus of invoice adjustment
Known values: approved, declined, new, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative
total_amountstringRequired within parentThe total monetary value of the adjustment.
typeModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data type
Type of invoice adjustment.
worksheetJSONRequired within parentBreakdown of the time/effort involved in the adjustment.
worksheet (anyOf 1)ModelAlternativeExpand Retrieve invoice adjustment by ID — 200 response body — data worksheet days, hours, minutes, weeks
worksheet (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
approvedbooleanRequired within parentWhether the specific approver has approved the adjustment.
emailstringOptionalEmail address of the approver.
full_namestringOptionalFull name of the approver.
Retrieve invoice adjustment by ID — 200 response body — data type
FieldTypePresenceDescription and constraints
$stringRootType 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
FieldTypePresenceDescription and constraints
$objectRootFile attachment linked to the invoice adjustment.
download_urlJSONOptional
download_url (anyOf 1)stringAlternativeURL used to download the uploaded attachment file.
download_url (anyOf 2)nullAlternativeURL used to download the uploaded attachment file.
filenamestringRequired within parentOriginal filename of the uploaded attachment
keystringRequired within parentDeprecated. 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
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier of the contract.
titlestringRequired within parentThe display title of the contract.
typestringRequired within parentType 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
FieldTypePresenceDescription and constraints
$objectRoot
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
end_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
start_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time

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

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.