Skip to content

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.

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 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_payment_receipts(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.currenciesarrayOptional
query.currencies[]stringEach itemMaximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
query.cursorstringOptional
query.date_fromstringOptionalFormat: date
query.date_tostringOptionalFormat: date
query.entitiesarrayOptional
query.entities[]stringEach itemOne of: individual, company
query.statusesarrayOptional
query.statuses[]stringEach itemOne of: paid, processing

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body

Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body

2 more schemas are linked from the tables above, on the schema pages.

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
has_morebooleanOptionalInform if there are more entries to be fetched using next cursor.
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternativeA 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)nullAlternativeA 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.
rowsarrayOptionalArray of payment receipts matching the query criteria.
rows[]ModelEach itemExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item
totalJSONOptional
total (anyOf 1)numberAlternativeThe total number of payments matching the query.
Format: double
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_countJSONOptional
total_count (anyOf 1)numberAlternativeThe total number of payments matching the query.
Format: double
total_count (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalDate and time when the payment was created, in ISO-8601 format.
Format: date-time
deel_granted_credits_usedModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item deel granted credits used
Amount paid using Deel-granted credits.
deel_referenceJSONOptional
deel_reference (anyOf 1)stringAlternativeDeel reference identifier for the payment.
deel_reference (anyOf 2)nullAlternativeDeel reference identifier for the payment.
eor_early_invoicing_funds_usedModelOptionalExpand 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_usedModelOptionalExpand 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.
idstringOptionalUnique identifier of the payment.
labelstringOptionalA descriptive label for the payment.
paid_atstringOptionalDate and time when the payment was completed, in ISO-8601 format.
Format: date-time
payment_currencystringOptionalThree 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_methodModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method
Payment method details for the transaction.
prepaid_billing_credits_usedModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item prepaid billing credits used
Amount paid using prepaid billing credits.
statusstringOptionalStatus of the payment. Either 'paid' or 'processing'.
Known values: paid, processing
timezonestringOptionalTimezone offset in ISO 8601 format (e.g., +02:00, -05:00).
Pattern: ^[+-]\d{2}:\d{2}$
totalstringOptionalOriginal invoice total before any credits or balance were applied.
total_duestringOptionalAmount 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
FieldTypePresenceDescription and constraints
$objectRootAmount paid using Deel-granted credits.
amountstringOptionalAmount deducted from Deel-granted credits, in the payment currency. '0.00' if not used.
original_amountJSONOptional
original_amount (anyOf 1)stringAlternativeAmount deducted from Deel-granted credits, in the original currency they were held in. Null if not used.
original_amount (anyOf 2)nullAlternativeAmount deducted from Deel-granted credits, in the original currency they were held in. Null if not used.
original_currencyJSONOptional
original_currency (anyOf 1)stringAlternativeCurrency 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)nullAlternativeCurrency 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
FieldTypePresenceDescription and constraints
$objectRootAmount paid using EOR early invoicing funds.
amountstringOptionalAmount deducted from EOR early invoicing funds, in the payment currency. '0.00' if not used.
original_amountJSONOptional
original_amount (anyOf 1)stringAlternativeAmount deducted from EOR early invoicing funds, in the original currency they were held in. Null if not used.
original_amount (anyOf 2)nullAlternativeAmount deducted from EOR early invoicing funds, in the original currency they were held in. Null if not used.
original_currencyJSONOptional
original_currency (anyOf 1)stringAlternativeCurrency 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)nullAlternativeCurrency 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
FieldTypePresenceDescription and constraints
$objectRootAmount paid using the client's general balance funds.
amountstringOptionalAmount deducted from general funds, in the payment currency. '0.00' if not used.
original_amountJSONOptional
original_amount (anyOf 1)stringAlternativeAmount deducted from general funds, in the original currency it was held in. Null if not used.
original_amount (anyOf 2)nullAlternativeAmount deducted from general funds, in the original currency it was held in. Null if not used.
original_currencyJSONOptional
original_currency (anyOf 1)stringAlternativeCurrency 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)nullAlternativeCurrency 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
FieldTypePresenceDescription and constraints
$objectRootPayment method details for the transaction.
typeModelOptionalExpand 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

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

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.