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.
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["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 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.immigration.list_case_invoices(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.case_id | string | Required within parent | Format: uuid |
query.cursor | string | Optional | |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
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 case invoices — 200 response body |
Referenced models: List case invoices — 200 response body
Schemas
Section titled “Schemas”List case invoices — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List case invoices — 200 response body — data item |
has_more | boolean | Required within parent | Whether more items are available beyond this page. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to pass as cursor to fetch the next page. Null when there is no next page. |
next_cursor (anyOf 2) | null | Alternative | Cursor to pass as cursor to fetch the next page. Null when there is no next page. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | JSON | Alternative | |
total_count (anyOf 1) (anyOf 1) | integer | Alternative | Total number of invoices issued to the organization for the case. |
total_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_count (anyOf 2) | null | Alternative | Total 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Invoiced amount in the invoice currency. Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | ISO 4217 currency code of the invoiced amount. |
due_date | string | Required within parent | UTC timestamp by which the invoice is due. Format: date-time |
id | string | Required within parent | The public identifier of the invoice, as shown in the Deel platform. |
is_paid | boolean | Required within parent | Whether the invoice has been settled. |
issued_at | string | Required within parent | UTC timestamp when the invoice was issued. Format: date-time |
paid_at | JSON | Required within parent | |
paid_at (anyOf 1) | string | Alternative | UTC timestamp when the invoice was paid. Null while unpaid. Format: date-time |
paid_at (anyOf 2) | null | Alternative | UTC timestamp when the invoice was paid. Null while unpaid. Format: date-time |
quote_id | string | Required within parent | The unique identifier of the quote the invoice was issued for. Format: uuid |
status | string | Required within parent | Payment status of the invoice. Known values: PENDING, PROCESSING, PREPROCESSING, PAID, CANCELLED, OPEN, AWAITING_PAYMENT, FAILED, SKIPPED, UNPAYABLE, REFUNDED, PROCESSED, CREDITED |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}