Deel: Invoice line items by contract

← invoice_adjustments operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.invoiceadjustments_getcontractinvoiceadjustments

Provider route: GET /contracts/{contract_id}/invoice-adjustments. Alter supplies the connection’s credentials and routing.

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"]["getContractInvoiceAdjustments"]>[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.getContractInvoiceAdjustments(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_contract_invoice_adjustments(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.contract_id	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.contract_types	array	Optional
query.contract_types[]	string	Each item	Type of a contract One of: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee, peo
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, 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

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 Invoice line items by contract — 200 response body

Referenced models: Invoice line items by contract — 200 response body

Policy, approvals and errors

SDK function policy ID: deel.invoiceadjustments_getcontractinvoiceadjustments. Catalog operation: invoiceadjustments_getcontractinvoiceadjustments. 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