Skip to content

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.

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 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.accounting.retrieve_invoices(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.issued_from_datestringOptional
query.issued_to_datestringOptional
query.statusstringOptionalOne of: all
query.limitnumberOptionalDefault: 25
Format: double
Maximum: 50
Minimum: 1
query.offsetintegerOptionalDefault: 0
Format: int64
Maximum: 999999999
Minimum: 0
query.cursorstringOptional
query.includestringOptionalOne of: cor

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve invoices — 200 response body

Referenced models: Retrieve invoices — 200 response body

Retrieve invoices — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve invoices — 200 response body — data item
pageModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONOptional
amount (anyOf 1)stringAlternativeBilled amount of the invoice.
amount (anyOf 2)nullAlternativeBilled amount of the invoice.
contract_idJSONRequired within parent
contract_id (anyOf 1)stringAlternativeUnique identifier of the related contract.
contract_id (anyOf 2)nullAlternativeUnique identifier of the related contract.
created_atstringRequired within parentDate and time when the invoice was created (ISO-8601 format).
Format: date-time
currencystringRequired within parentThree-letter currency code for the invoice.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
deel_feeJSONOptional
deel_fee (anyOf 1)stringAlternativeFee charged by Deel.
deel_fee (anyOf 2)nullAlternativeFee charged by Deel.
due_dateJSONRequired within parent
due_date (anyOf 1)stringAlternativeDate and time when the invoice is due (ISO-8601 format).
Format: date-time
due_date (anyOf 2)nullAlternativeDate and time when the invoice is due (ISO-8601 format).
Format: date-time
idstringRequired within parentUnique identifier of this resource.
is_overdueJSONRequired within parent
is_overdue (anyOf 1)booleanAlternativeIndicates whether the invoice is overdue.
is_overdue (anyOf 2)nullAlternativeIndicates whether the invoice is overdue.
issued_atJSONRequired within parent
issued_at (anyOf 1)stringAlternativeDate and time when the invoice was issued (ISO-8601 format).
Format: date-time
issued_at (anyOf 2)nullAlternativeDate and time when the invoice was issued (ISO-8601 format).
Format: date-time
labelstringRequired within parentLabel or reference number of the invoice.
paid_atModelRequired within parentExpand 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_idstringOptionalUnique identifier for the recipient legal entity
Format: uuid
statusstringRequired within parentCurrent status of the invoice.
Known values: pending, paid, processing, credited, refunded
totalstringRequired within parentTotal invoice amount, including fees and VAT.
vat_idJSONRequired within parent
vat_id (anyOf 1)stringAlternativeVAT identification number related to the invoice.
vat_id (anyOf 2)nullAlternativeVAT identification number related to the invoice.
vat_percentageJSONRequired within parent
vat_percentage (anyOf 1)stringAlternativePercentage of VAT charged on the invoice.
vat_percentage (anyOf 2)nullAlternativePercentage of VAT charged on the invoice.
vat_totalJSONRequired within parent
vat_total (anyOf 1)stringAlternativeTotal amount of VAT charged on the invoice.
vat_total (anyOf 2)nullAlternativeTotal amount of VAT charged on the invoice.

Referenced models: Retrieve invoices — 200 response body — data item paid at

Retrieve invoices — 200 response body — page
FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternativeCursor for paginated results.
cursor (anyOf 2)nullAlternativeCursor for paginated results.
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeNumber of items displayed per page.
Format: double
Maximum: 99
Minimum: 1
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)numberAlternativeThe starting position of the current page of results.
Format: double
Maximum: 999999999
Minimum: 0
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of rows available for the query.
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve invoices — 200 response body — data item paid at
FieldTypePresenceDescription and constraints
$JSONRootDate/time when the invoice was paid (ISO-8601). May be null or empty string.
$ (anyOf 1)stringAlternativeFormat: date-time
$ (anyOf 2)stringAlternative

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"}

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.