Skip to content

Deel: List invoice adjustments

Deel invoiceAdjustments.getInvoiceAdjustments: arguments, response, policy and SDK examples.

← Invoice adjustments operations · Get started

Operation deel.invoiceadjustments_getinvoiceadjustments

Provider route: GET /invoice-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["invoiceAdjustments"]["getInvoiceAdjustments"]>[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.getInvoiceAdjustments(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_adjustments(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.contract_idstringOptional
query.contract_typesarrayOptional
query.contract_types[]stringEach itemType of a contract
One of: ongoing_time_based, pay_as_you_go_time_based, payg_milestones, payg_tasks
query.typesarrayOptional
query.types[]ModelEach itemExpand List invoice adjustments — request body — query types item
query.statusesarrayOptional
query.statuses[]stringEach itemstatus of invoice adjustment
One of: approved, declined, new, not_payable, paid, pending, processing
query.invoice_idstringOptional
query.reporter_idstringOptionalFormat: uuid
query.date_fromstringOptionalFormat: date
query.date_tostringOptionalFormat: date
query.limitstringOptionalPattern: ^[1-9][0-9]?$|^100$
query.offsetstringOptional

Referenced models: List invoice adjustments — request body — query types item

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List invoice adjustments — 200 response body

Referenced models: List invoice adjustments — 200 response body

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

List invoice adjustments — request body — query types item
FieldTypePresenceDescription and constraints
$stringRootType of invoice adjustment.
One of: 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
List invoice adjustments — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of invoice adjustments returned for the request.
data[]ModelEach itemExpand List invoice adjustments — 200 response body — data item
pageModelRequired within parentExpand List invoice adjustments — 200 response body — page
Pagination metadata for the response.

Referenced models: List invoice adjustments — 200 response body — data item, List invoice adjustments — 200 response body — page

List invoice adjustments — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
attachmentJSONRequired within parentFile attachment linked to the invoice adjustment.
attachment (anyOf 1)ModelAlternativeExpand List invoice adjustments — 200 response body — data item attachment File attachment linked to the invoice adjustment
attachment (anyOf 2)nullAlternative
contractModelRequired within parentExpand List invoice adjustments — 200 response body — data item contract
Contract associated with this invoice adjustment.
created_atstringRequired within parentTimestamp when the adjustment was created (ISO-8601).
Format: date-time
currency_codeJSONRequired within parent
currency_code (anyOf 1)stringAlternativeISO 4217 currency code used for the amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
currency_code (anyOf 2)nullAlternativeISO 4217 currency code used for the amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_scaleJSONOptional
custom_scale (anyOf 1)stringAlternativeCustom scale label defined by the client.
custom_scale (anyOf 2)nullAlternativeCustom scale label defined by the client.
date_submittedJSONOptional
date_submitted (anyOf 1)stringAlternativeTimestamp when the adjustment was submitted for review.
Format: date-time
date_submitted (anyOf 2)nullAlternativeTimestamp when the adjustment was submitted for review.
Format: date-time
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeHuman-readable explanation of the invoice adjustment.
description (anyOf 2)nullAlternativeHuman-readable explanation of the invoice adjustment.
hourlyReportPresetJSONOptional
hourlyReportPreset (anyOf 1)ModelAlternativeExpand List invoice adjustments — 200 response body — data item hourly Report Preset id, rate, title
hourlyReportPreset (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier of this invoice adjustment.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of this invoice adjustment.
Format: uuid
invoice_idJSONOptional
invoice_id (anyOf 1)JSONAlternative
invoice_id (anyOf 1) (anyOf 1)numberAlternativeIdentifier of the generated invoice this adjustment belongs to.
Format: double
invoice_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
invoice_id (anyOf 2)nullAlternativeIdentifier of the generated invoice this adjustment belongs to.
Format: double
payment_cycleModelRequired within parentExpand List invoice adjustments — 200 response body — data item payment cycle
Payment cycle associated with this adjustment.
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity used to calculate the total amount.
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeQuantity used to calculate the total amount.
Format: double
reported_byModelRequired within parentExpand List invoice adjustments — 200 response body — data item reported by
User who reported the invoice adjustment.
reviewed_byJSONRequired within parentReviewer information if the adjustment has been reviewed.
reviewed_by (anyOf 1)ModelAlternativeExpand List invoice adjustments — 200 response body — data item reviewed by full name, id, remarks, reviewed at
reviewed_by (anyOf 2)nullAlternative
scaleJSONOptional
scale (anyOf 1)stringAlternativePredefined scale used to calculate the adjustment amount.
scale (anyOf 2)nullAlternativePredefined scale used to calculate the adjustment amount.
statusJSONRequired within parentCurrent processing status of the invoice adjustment.
status (anyOf 1)stringAlternativeCurrent processing status of the invoice adjustment.
Known values: approved, declined, new, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative
total_amountstringRequired within parentTotal monetary value of the invoice adjustment.
typeModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data type
Type of invoice adjustment.
worksheetJSONRequired within parentBreakdown of time used for time-based calculations.
worksheet (anyOf 1)ModelAlternativeExpand List invoice adjustments — 200 response body — data item worksheet Breakdown of time used for time-based calculations
worksheet (anyOf 2)nullAlternative

Referenced models: Retrieve invoice adjustment by ID — 200 response body — data type, List invoice adjustments — 200 response body — data item attachment File attachment linked to the invoice adjustment, List invoice adjustments — 200 response body — data item contract, List invoice adjustments — 200 response body — data item hourly Report Preset id, rate, title, List invoice adjustments — 200 response body — data item payment cycle, List invoice adjustments — 200 response body — data item reported by, List invoice adjustments — 200 response body — data item reviewed by full name, id, remarks, reviewed at, List invoice adjustments — 200 response body — data item worksheet Breakdown of time used for time-based calculations

List invoice adjustments — 200 response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination metadata for the response.
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeNumber of records returned per page.
Format: double
Maximum: 100
Minimum: 1
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)numberAlternativeIndex of the first record in the current page.
Format: double
Maximum: 999999999
Minimum: 0
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of records available.
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
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
List invoice adjustments — 200 response body — data item contract
FieldTypePresenceDescription and constraints
$objectRootContract associated with this invoice adjustment.
idstringRequired within parentUnique identifier of the contract.
titlestringRequired within parentHuman-readable contract title.
typestringRequired within parentType of the 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

SDK function policy ID: deel.invoiceadjustments_getinvoiceadjustments. Catalog operation: invoice-adjustments/list. 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"]

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.