Deel: Retrieve invoices
Deel accounting.retrieveInvoices: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation deel.accounting_retrieveinvoices_v2026_01_01
Provider route: GET /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["accounting"]["retrieveInvoices"]>[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.retrieveInvoices(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_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.issued_from_date | string | Optional | |
query.issued_to_date | string | Optional | |
query.status | string | Optional | One of: all |
query.limit | number | Optional | Default: 25 Format: double Maximum: 50 Minimum: 1 |
query.offset | integer | Optional | Default: 0 Format: int64 Maximum: 999999999 Minimum: 0 |
query.cursor | string | Optional | |
query.include | string | Optional | One of: cor |
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 invoices — 200 response body |
Referenced models: Retrieve invoices — 200 response body
Schemas
Section titled “Schemas”Retrieve invoices — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve invoices — 200 response body — data item |
page | Model | Required within parent | Expand Retrieve invoices — 200 response body — page |
Referenced models: Retrieve invoices — 200 response body — data item, Retrieve invoices — 200 response body — page
Retrieve invoices — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | string | Alternative | Billed amount of the invoice. |
amount (anyOf 2) | null | Alternative | Billed amount of the invoice. |
contract_id | JSON | Required within parent | |
contract_id (anyOf 1) | string | Alternative | Unique identifier of the related contract. |
contract_id (anyOf 2) | null | Alternative | Unique identifier of the related contract. |
created_at | string | Required within parent | Date and time when the invoice was created (ISO-8601 format). Format: date-time |
currency | string | Required within parent | Three-letter currency code for the invoice. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
deel_fee | JSON | Optional | |
deel_fee (anyOf 1) | string | Alternative | Fee charged by Deel. |
deel_fee (anyOf 2) | null | Alternative | Fee charged by Deel. |
due_date | JSON | Required within parent | |
due_date (anyOf 1) | string | Alternative | Date and time when the invoice is due (ISO-8601 format). Format: date-time |
due_date (anyOf 2) | null | Alternative | Date and time when the invoice is due (ISO-8601 format). Format: date-time |
id | string | Required within parent | Unique identifier of this resource. |
is_overdue | JSON | Required within parent | |
is_overdue (anyOf 1) | boolean | Alternative | Indicates whether the invoice is overdue. |
is_overdue (anyOf 2) | null | Alternative | Indicates whether the invoice is overdue. |
issued_at | JSON | Required within parent | |
issued_at (anyOf 1) | string | Alternative | Date and time when the invoice was issued (ISO-8601 format). Format: date-time |
issued_at (anyOf 2) | null | Alternative | Date and time when the invoice was issued (ISO-8601 format). Format: date-time |
label | string | Required within parent | Label or reference number of the invoice. |
paid_at | Model | Required within parent | Expand Retrieve invoices — 200 response body — data item paid at Date/time when the invoice was paid (ISO-8601). May be null or empty string. |
recipient_legal_entity_id | string | Optional | Unique identifier for the recipient legal entity Format: uuid |
status | string | Required within parent | Current status of the invoice. Known values: pending, paid, processing, credited, refunded |
total | string | Required within parent | Total invoice amount, including fees and VAT. |
vat_id | JSON | Required within parent | |
vat_id (anyOf 1) | string | Alternative | VAT identification number related to the invoice. |
vat_id (anyOf 2) | null | Alternative | VAT identification number related to the invoice. |
vat_percentage | JSON | Required within parent | |
vat_percentage (anyOf 1) | string | Alternative | Percentage of VAT charged on the invoice. |
vat_percentage (anyOf 2) | null | Alternative | Percentage of VAT charged on the invoice. |
vat_total | JSON | Required within parent | |
vat_total (anyOf 1) | string | Alternative | Total amount of VAT charged on the invoice. |
vat_total (anyOf 2) | null | Alternative | Total amount of VAT charged on the invoice. |
Referenced models: Retrieve invoices — 200 response body — data item paid at
Retrieve invoices — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | Cursor for paginated results. |
cursor (anyOf 2) | null | Alternative | Cursor for paginated results. |
items_per_page | JSON | Required within parent | |
items_per_page (anyOf 1) | number | Alternative | Number of items displayed 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 | The starting position of the current page of results. 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 available for the query. Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve invoices — 200 response body — data item paid at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Date/time when the invoice was paid (ISO-8601). May be null or empty string. |
$ (anyOf 1) | string | Alternative | Format: date-time |
$ (anyOf 2) | string | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.accounting_retrieveinvoices_v2026_01_01. Catalog operation: accounting_retrieveinvoices_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"}