Deel: Retrieve Deel invoices
Deel accounting.retrieveDeelInvoices: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation deel.accounting_retrievedeelinvoices_v2026_01_01
Provider route: GET /invoices/deel. 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["accounting"]["retrieveDeelInvoices"]>[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.accounting.retrieveDeelInvoices(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.accounting.retrieve_deel_invoices(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.limit | string | Optional | |
query.offset | string | Optional |
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 Retrieve Deel invoices — 200 response body |
Referenced models: Retrieve Deel invoices — 200 response body
Schemas
Section titled “Schemas”Retrieve Deel invoices — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve Deel invoices — 200 response body — data item |
page | Model | Required within parent | Expand Retrieve Deel invoices — 200 response body — page |
Referenced models: Retrieve Deel invoices — 200 response body — data item, Retrieve Deel invoices — 200 response body — page
Retrieve Deel invoices — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
created_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
currency | string | Required within parent | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
id | string | Required within parent | Unique identifier of the invoice. |
label | string | Required within parent | Label of the invoice. |
status | string | Required within parent | Current status of the invoice. Known values: pending, paid, processing, canceled, skipped, failed, refunded |
total | string | Required within parent | Total invoice amount including Fee and VAT. |
Retrieve Deel invoices — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items_per_page | JSON | Required within parent | |
items_per_page (anyOf 1) | number | Alternative | Number of items per page Format: double Maximum: 99 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 | Offset 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 rows Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.accounting_retrievedeelinvoices_v2026_01_01. Catalog operation: accounting_retrievedeelinvoices_v2026_01_01. 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: ["accounting:read"]
Pinned headers: {"X-Version": "2026-01-01"}