Skip to content

Deel: Create an invoice adjustment

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

← Invoice adjustments operations · Get started

Operation deel.invoiceadjustments_createinvoiceadjustment

Provider route: POST /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"]["createInvoiceAdjustment"]>[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.createInvoiceAdjustment(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.create_invoice_adjustment(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.recurringstringOptional
bodyobjectOptional
body.dataModelRequired within parentExpand Create an invoice adjustment — request body — body data
Payload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata.

Referenced models: Create an invoice adjustment — request body — body data

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Create an invoice adjustment — 201 response body

Referenced models: Create an invoice adjustment — 201 response body

Create an invoice adjustment — request body — body data
FieldTypePresenceDescription and constraints
$objectRootPayload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata.
amountnumberRequired within parentMonetary amount to apply for this invoice adjustment, expressed in the contract currency as a positive number.
Format: double
Minimum: 0
contract_idstringRequired within parentUnique Deel contract identifier (public id) that receives this invoice adjustment line item.
date_submittedstringRequired within parentSubmission date in ISO-8601 short-date format (YYYY-MM-DD) used for filtering, reporting, and approvals.
Format: date
descriptionstringRequired within parentDetailed human-readable explanation that appears on invoices and audit records visible to both parties.
Maximum length: 30000
group_keystring or nullOptionalWhen provided, invoice adjustments sharing the same group_key within the same payment cycle are merged into a single aggregated line item on the invoice. Requires is_auto_approved to be true.
Maximum length: 300
hourly_report_preset_idstring or nullOptionalIdentifier of an existing hourly report preset used to link standardized rate and scale metadata to this entry.
Format: uuid
is_auto_approvedbooleanOptionalWhen true, the created invoice adjustment skips manual approval and is approved immediately on creation.
paymentCycleIdstring or nullOptionalPublic id (UUID) of the active payment cycle required when creating VAT-related invoice adjustment entries against a specific cycle.
Format: uuid
typestringRequired within parentInvoice adjustment category that determines business rules and downstream invoicing behavior.
One of: bonus, commission, deduction, expense, other, overtime, time_off, vat
Create an invoice adjustment — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create an invoice adjustment — 201 response body — data
Container object with identifiers, status, and creation metadata for the newly created invoice adjustment.

Referenced models: Create an invoice adjustment — 201 response body — data

Create an invoice adjustment — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRootContainer object with identifiers, status, and creation metadata for the newly created invoice adjustment.
createdbooleanRequired within parentIndicates whether the invoice adjustment record was successfully created by this request.
created_atJSONOptional
created_at (anyOf 1)stringAlternativeISO-8601 timestamp recording the exact moment the invoice adjustment was created in the system.
Format: date-time
created_at (anyOf 2)nullAlternativeISO-8601 timestamp recording the exact moment the invoice adjustment was created in the system.
Format: date-time
idModelOptionalExpand Create an invoice adjustment — 201 response body — data id
Unique identifier returned for the created invoice adjustment resource after persistence succeeds.
statusJSONOptionalCurrent processing status assigned to the invoice adjustment after the create workflow finishes executing.
status (anyOf 1)stringAlternativeCurrent processing status assigned to the invoice adjustment after the create workflow finishes executing.
Known values: approved, declined, new, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative

Referenced models: Create an invoice adjustment — 201 response body — data id

Create an invoice adjustment — 201 response body — data id
FieldTypePresenceDescription and constraints
$JSONRootUnique identifier returned for the created invoice adjustment resource after persistence succeeds.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternativeFormat: int64
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: deel.invoiceadjustments_createinvoiceadjustment. Catalog operation: invoiceadjustments_createinvoiceadjustment. 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:write", "worker:write"]

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.