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.
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"]["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 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_adjustments(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.contract_id | string | Optional | |
query.contract_types | array | Optional | |
query.contract_types[] | string | Each item | Type of a contract One of: ongoing_time_based, pay_as_you_go_time_based, payg_milestones, payg_tasks |
query.types | array | Optional | |
query.types[] | Model | Each item | Expand List invoice adjustments — request body — query types item |
query.statuses | array | Optional | |
query.statuses[] | string | Each item | status of invoice adjustment One of: approved, declined, new, not_payable, paid, pending, processing |
query.invoice_id | string | Optional | |
query.reporter_id | string | Optional | Format: uuid |
query.date_from | string | Optional | Format: date |
query.date_to | string | Optional | Format: date |
query.limit | string | Optional | Pattern: ^[1-9][0-9]?$|^100$ |
query.offset | string | Optional |
Referenced models: List invoice adjustments — request body — query types item
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 List invoice adjustments — 200 response body |
Referenced models: List invoice adjustments — 200 response body
Schemas
Section titled “Schemas”8 more schemas are linked from the tables above, on the schema pages.
List invoice adjustments — request body — query types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of invoice adjustments returned for the request. |
data[] | Model | Each item | Expand List invoice adjustments — 200 response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachment | JSON | Required within parent | File attachment linked to the invoice adjustment. |
attachment (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item attachment File attachment linked to the invoice adjustment |
attachment (anyOf 2) | null | Alternative | |
contract | Model | Required within parent | Expand List invoice adjustments — 200 response body — data item contract Contract associated with this invoice adjustment. |
created_at | string | Required within parent | Timestamp when the adjustment was created (ISO-8601). Format: date-time |
currency_code | JSON | Required within parent | |
currency_code (anyOf 1) | string | Alternative | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency_code (anyOf 2) | null | Alternative | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_scale | JSON | Optional | |
custom_scale (anyOf 1) | string | Alternative | Custom scale label defined by the client. |
custom_scale (anyOf 2) | null | Alternative | Custom scale label defined by the client. |
date_submitted | JSON | Optional | |
date_submitted (anyOf 1) | string | Alternative | Timestamp when the adjustment was submitted for review. Format: date-time |
date_submitted (anyOf 2) | null | Alternative | Timestamp when the adjustment was submitted for review. Format: date-time |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Human-readable explanation of the invoice adjustment. |
description (anyOf 2) | null | Alternative | Human-readable explanation of the invoice adjustment. |
hourlyReportPreset | JSON | Optional | |
hourlyReportPreset (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item hourly Report Preset id, rate, title |
hourlyReportPreset (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier of this invoice adjustment. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of this invoice adjustment. Format: uuid |
invoice_id | JSON | Optional | |
invoice_id (anyOf 1) | JSON | Alternative | |
invoice_id (anyOf 1) (anyOf 1) | number | Alternative | Identifier of the generated invoice this adjustment belongs to. Format: double |
invoice_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
invoice_id (anyOf 2) | null | Alternative | Identifier of the generated invoice this adjustment belongs to. Format: double |
payment_cycle | Model | Required within parent | Expand List invoice adjustments — 200 response body — data item payment cycle Payment cycle associated with this adjustment. |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity used to calculate the total amount. Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | Quantity used to calculate the total amount. Format: double |
reported_by | Model | Required within parent | Expand List invoice adjustments — 200 response body — data item reported by User who reported the invoice adjustment. |
reviewed_by | JSON | Required within parent | Reviewer information if the adjustment has been reviewed. |
reviewed_by (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item reviewed by full name, id, remarks, reviewed at |
reviewed_by (anyOf 2) | null | Alternative | |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | Predefined scale used to calculate the adjustment amount. |
scale (anyOf 2) | null | Alternative | Predefined scale used to calculate the adjustment amount. |
status | JSON | Required within parent | Current processing status of the invoice adjustment. |
status (anyOf 1) | string | Alternative | Current processing status of the invoice adjustment. Known values: approved, declined, new, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative | |
total_amount | string | Required within parent | Total monetary value of the invoice 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 time used for time-based calculations. |
worksheet (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item worksheet Breakdown of time used for time-based calculations |
worksheet (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination metadata for the response. |
items_per_page | JSON | Required within parent | |
items_per_page (anyOf 1) | number | Alternative | Number of records returned per page. Format: double Maximum: 100 Minimum: 1 |
items_per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
offset | JSON | Required within parent | |
offset (anyOf 1) | number | Alternative | Index of the first record in the current page. Format: double Maximum: 999999999 Minimum: 0 |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | number | Alternative | Total number of records available. Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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 |
List invoice adjustments — 200 response body — data item contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract associated with this invoice adjustment. |
id | string | Required within parent | Unique identifier of the contract. |
title | string | Required within parent | Human-readable contract title. |
type | string | Required within parent | Type 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}