Skip to content

Deel: Get invoice details by ID

Deel workers.getInvoiceDetailsById: arguments, response, policy and SDK examples.

← Workers operations · Get started

Operation deel.workers_getinvoicedetailsbyid_v2026_04_27

Provider route: GET /ic/workers/invoices/{invoice_id}. 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["workers"]["getInvoiceDetailsById"]>[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.workers.getInvoiceDetailsById(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.workers.get_invoice_details_by_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.invoice_idstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get invoice details by ID — 200 response body

Referenced models: Get invoice details by ID — 200 response body

Get invoice details by ID — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get invoice details by ID — 200 response body — data
Invoice summary (snake_case; display card fields, amounts, and payment display).

Referenced models: Get invoice details by ID — 200 response body — data

Get invoice details by ID — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRootInvoice summary (snake_case; display card fields, amounts, and payment display).
amountJSONOptional
amount (anyOf 1)stringAlternativeAmount before fees.
amount (anyOf 2)nullAlternativeAmount before fees.
created_atstringRequired within parentWhen the invoice record was created (ISO-8601).
Format: date-time
currencystringRequired within parentThree-letter currency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
idstringRequired within parentPublic invoice id.
issued_atJSONOptional
issued_at (anyOf 1)stringAlternativeWhen the invoice was issued, if applicable.
Format: date-time
issued_at (anyOf 2)nullAlternativeWhen the invoice was issued, if applicable.
Format: date-time
payment_display_statusModelOptionalExpand Get invoice details by ID — 200 response body — data payment display status
Derived payment display state for the invoice.
statusstringRequired within parentInvoice workflow status.
titlestringOptionalDisplay title.
totalJSONOptional
total (anyOf 1)stringAlternativeTotal including fees.
total (anyOf 2)nullAlternativeTotal including fees.

Referenced models: Get invoice details by ID — 200 response body — data payment display status

Get invoice details by ID — 200 response body — data payment display status
FieldTypePresenceDescription and constraints
$objectRootDerived payment display state for the invoice.
keystringRequired within parentStable machine key.
labelstringRequired within parentHuman-readable label.

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

Pinned headers: {"X-Version": "2026-04-27"}

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.