Deel: Retrieve payment receipts — accounting retrieve Payment Receipts
Deel accounting.retrievePaymentReceipts: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation deel.accounting_retrievepaymentreceipts_v2027_01_01
Deprecated. This contract (2026-11-07) no longer has this operation. The SDK keeps accounting.retrievePaymentReceipts / accounting.retrieve_payment_receipts, deprecated, and the method calls contract 2026-10-27, which published it and which Alter still serves. Its input and response below are that contract’s.
Provider route: GET /payments. 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"]["retrievePaymentReceipts"]>[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.retrievePaymentReceipts(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_payment_receipts(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.currencies | array | Optional | |
query.currencies[] | string | Each item | Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
query.cursor | string | Optional | |
query.date_from | string | Optional | Format: date |
query.date_to | string | Optional | Format: date |
query.entities | array | Optional | |
query.entities[] | string | Each item | One of: individual, company |
query.statuses | array | Optional | |
query.statuses[] | string | Each item | One of: paid, processing |
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 payment receipts — accounting retrieve Payment Receipts — 200 response body |
Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data |
Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data
Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
has_more | boolean | Optional | Inform if there are more entries to be fetched using next cursor. |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null. |
next_cursor (anyOf 2) | null | Alternative | A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null. |
rows | array | Optional | Array of payment receipts matching the query criteria. |
rows[] | Model | Each item | Expand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item |
total | JSON | Optional | |
total (anyOf 1) | number | Alternative | The total number of payments matching the query. Format: double |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_count | JSON | Optional | |
total_count (anyOf 1) | number | Alternative | The total number of payments matching the query. Format: double |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item
Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Date and time when the payment was created, in ISO-8601 format. Format: date-time |
deel_granted_credits_used | Model | Optional | Expand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item deel granted credits used Amount paid using Deel-granted credits. |
deel_reference | JSON | Optional | |
deel_reference (anyOf 1) | string | Alternative | Deel reference identifier for the payment. |
deel_reference (anyOf 2) | null | Alternative | Deel reference identifier for the payment. |
eor_early_invoicing_funds_used | Model | Optional | Expand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item eor early invoicing funds used Amount paid using EOR early invoicing funds. |
general_funds_used | Model | Optional | Expand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item general funds used Amount paid using the client's general balance funds. |
id | string | Optional | Unique identifier of the payment. |
label | string | Optional | A descriptive label for the payment. |
paid_at | string | Optional | Date and time when the payment was completed, in ISO-8601 format. Format: date-time |
payment_currency | string | Optional | Three or four-letter currency code for the payment, following ISO 4217 (e.g., USD, USDC). Maximum length: 4 Minimum length: 3 Pattern: ^[A-Z]{3,4}$ |
payment_method | Model | Optional | Expand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method Payment method details for the transaction. |
prepaid_billing_credits_used | Model | Optional | Expand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item prepaid billing credits used Amount paid using prepaid billing credits. |
status | string | Optional | Status of the payment. Either 'paid' or 'processing'. Known values: paid, processing |
timezone | string | Optional | Timezone offset in ISO 8601 format (e.g., +02:00, -05:00). Pattern: ^[+-]\d{2}:\d{2}$ |
total | string | Optional | Original invoice total before any credits or balance were applied. |
total_due | string | Optional | Amount due for the payment after applying any credits or balance. Equals 'total' when no credits were used. |
Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item deel granted credits used, Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item eor early invoicing funds used, Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item general funds used, Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method, Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item prepaid billing credits used
Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item deel granted credits used
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Amount paid using Deel-granted credits. |
amount | string | Optional | Amount deducted from Deel-granted credits, in the payment currency. '0.00' if not used. |
original_amount | JSON | Optional | |
original_amount (anyOf 1) | string | Alternative | Amount deducted from Deel-granted credits, in the original currency they were held in. Null if not used. |
original_amount (anyOf 2) | null | Alternative | Amount deducted from Deel-granted credits, in the original currency they were held in. Null if not used. |
original_currency | JSON | Optional | |
original_currency (anyOf 1) | string | Alternative | Currency in which the Deel-granted credits were held, following ISO 4217 (e.g., USD, USDC). Null if not used. Maximum length: 4 Minimum length: 3 Pattern: ^[A-Z]{3,4}$ |
original_currency (anyOf 2) | null | Alternative | Currency in which the Deel-granted credits were held, following ISO 4217 (e.g., USD, USDC). Null if not used. Maximum length: 4 Minimum length: 3 Pattern: ^[A-Z]{3,4}$ |
Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item eor early invoicing funds used
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Amount paid using EOR early invoicing funds. |
amount | string | Optional | Amount deducted from EOR early invoicing funds, in the payment currency. '0.00' if not used. |
original_amount | JSON | Optional | |
original_amount (anyOf 1) | string | Alternative | Amount deducted from EOR early invoicing funds, in the original currency they were held in. Null if not used. |
original_amount (anyOf 2) | null | Alternative | Amount deducted from EOR early invoicing funds, in the original currency they were held in. Null if not used. |
original_currency | JSON | Optional | |
original_currency (anyOf 1) | string | Alternative | Currency in which the EOR early invoicing funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used. Maximum length: 4 Minimum length: 3 Pattern: ^[A-Z]{3,4}$ |
original_currency (anyOf 2) | null | Alternative | Currency in which the EOR early invoicing funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used. Maximum length: 4 Minimum length: 3 Pattern: ^[A-Z]{3,4}$ |
Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item general funds used
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Amount paid using the client's general balance funds. |
amount | string | Optional | Amount deducted from general funds, in the payment currency. '0.00' if not used. |
original_amount | JSON | Optional | |
original_amount (anyOf 1) | string | Alternative | Amount deducted from general funds, in the original currency it was held in. Null if not used. |
original_amount (anyOf 2) | null | Alternative | Amount deducted from general funds, in the original currency it was held in. Null if not used. |
original_currency | JSON | Optional | |
original_currency (anyOf 1) | string | Alternative | Currency in which the general funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used. Maximum length: 4 Minimum length: 3 Pattern: ^[A-Z]{3,4}$ |
original_currency (anyOf 2) | null | Alternative | Currency in which the general funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used. Maximum length: 4 Minimum length: 3 Pattern: ^[A-Z]{3,4}$ |
Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment method details for the transaction. |
type | Model | Optional | Expand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method type Type of payment method used for the transaction. |
Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method type
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.accounting_retrievepaymentreceipts_v2027_01_01. Catalog operation: accounting_retrievepaymentreceipts_v2027_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": "2027-01-01"}