Skip to content

Deel: List case invoices

Deel immigration.listCaseInvoices: arguments, response, policy and SDK examples.

← Immigration operations · Get started

Operation deel.immigration_listcaseinvoices_v2026_10_14

Provider route: GET /immigration/invoices. 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["immigration"]["listCaseInvoices"]>[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.immigration.listCaseInvoices(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.immigration.list_case_invoices(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.case_idstringRequired within parentFormat: uuid
query.cursorstringOptional
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List case invoices — 200 response body

Referenced models: List case invoices — 200 response body

List case invoices — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List case invoices — 200 response body — data item
has_morebooleanRequired within parentWhether more items are available beyond this page.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to pass as cursor to fetch the next page. Null when there is no next page.
next_cursor (anyOf 2)nullAlternativeCursor to pass as cursor to fetch the next page. Null when there is no next page.
total_countJSONRequired within parent
total_count (anyOf 1)JSONAlternative
total_count (anyOf 1) (anyOf 1)integerAlternativeTotal number of invoices issued to the organization for the case.
total_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_count (anyOf 2)nullAlternativeTotal number of invoices issued to the organization for the case.

Referenced models: List case invoices — 200 response body — data item

List case invoices — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeInvoiced amount in the invoice currency.
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentISO 4217 currency code of the invoiced amount.
due_datestringRequired within parentUTC timestamp by which the invoice is due.
Format: date-time
idstringRequired within parentThe public identifier of the invoice, as shown in the Deel platform.
is_paidbooleanRequired within parentWhether the invoice has been settled.
issued_atstringRequired within parentUTC timestamp when the invoice was issued.
Format: date-time
paid_atJSONRequired within parent
paid_at (anyOf 1)stringAlternativeUTC timestamp when the invoice was paid. Null while unpaid.
Format: date-time
paid_at (anyOf 2)nullAlternativeUTC timestamp when the invoice was paid. Null while unpaid.
Format: date-time
quote_idstringRequired within parentThe unique identifier of the quote the invoice was issued for.
Format: uuid
statusstringRequired within parentPayment status of the invoice.
Known values: PENDING, PROCESSING, PREPROCESSING, PAID, CANCELLED, OPEN, AWAITING_PAYMENT, FAILED, SKIPPED, UNPAYABLE, REFUNDED, PROCESSED, CREDITED

SDK function policy ID: deel.immigration_listcaseinvoices_v2026_10_14. Catalog operation: immigration_listcaseinvoices_v2026_10_14. 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: ["immigration:read"]

Pinned headers: {"X-Version": "2026-10-14"}

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.