Deel: Retrieve a payment breakdown
Deel accounting.retrieveApaymentBreakdown: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation deel.accounting_retrieveapaymentbreakdown_v2026_01_01
Provider route: GET /payments/{payment_id}/breakdown. 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"]["retrieveApaymentBreakdown"]>[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.retrieveApaymentBreakdown(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_apayment_breakdown(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.payment_id | string | Required within parent |
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 a payment breakdown — 200 response body |
Referenced models: Retrieve a payment breakdown — 200 response body
Schemas
Section titled “Schemas”Retrieve a payment breakdown — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Retrieve a payment breakdown — 200 response body — data item |
Referenced models: Retrieve a payment breakdown — 200 response body — data item
Retrieve a payment breakdown — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
adjustment | string | Optional | Adjustment amount for the payment. |
approve_date | Model | Optional | Expand Retrieve a payment breakdown — 200 response body — data item approve date Date when the work report was approved by designated approvers. Empty for payments that don't require work report approval, such as service fees, management fees, and automated payments. |
approvers | string | Optional | Comma-separated list of names of people who approved this payment. May be empty if no approvals were required or recorded. |
bonus | string | Optional | Additional bonus payment amount awarded to the worker. |
commissions | string | Optional | Commissions included in the payment. |
contract_country | string | Optional | Country where the contract is established. |
contract_id | JSON | Optional | |
contract_id (anyOf 1) | string | Alternative | Public identifier of the contract this line item belongs to. Null for service-fee and similar non-contract line items. |
contract_id (anyOf 2) | null | Alternative | Public identifier of the contract this line item belongs to. Null for service-fee and similar non-contract line items. |
contract_start_date | Model | Optional | Expand Retrieve a payment breakdown — 200 response body — data item contract start date Start date of the contract. Empty for service agreements and fee-related contracts (such as equipment payments, insurance payments, and management fees) that don't have traditional contract start dates. |
contract_type | JSON | Optional | Type of contract this payment relates to. Determines the nature of the work relationship and payment structure. |
contract_type (anyOf 1) | Model | Alternative | Expand Retrieve a payment breakdown — 200 response body — data item contract type string |
contract_type (anyOf 2) | null | Alternative | |
contractor_email | string | Optional | Email address of the worker. |
contractor_employee_name | string | Optional | Name of the worker. |
contractor_pic_url | JSON | Optional | |
contractor_pic_url (anyOf 1) | string | Alternative | URL to the worker's Deel avatar. Null if the worker has no avatar set or for non-worker line items. |
contractor_pic_url (anyOf 2) | null | Alternative | URL to the worker's Deel avatar. Null if the worker has no avatar set or for non-worker line items. |
contractor_unique_identifier | Model | Optional | Expand Retrieve a payment breakdown — 200 response body — data item contractor unique identifier Unique identifier for the worker. May be empty for certain contract types such as service agreements and fees. |
currency | string | Optional | Currency code for this payment. |
date | string | Optional | Date associated with the payment breakdown. Format: date-time |
deductions | string | Optional | Deductions from the payment. |
expenses | string | Optional | Expenses related to the payment. |
frequency | Model | Optional | Expand Retrieve a payment breakdown — 200 response body — data item frequency Work unit scale from the contractor's work statement. Indicates how work is measured and reported (hourly, daily, weekly, monthly, or custom units). Empty for contracts with fixed payments that don't require work quantity tracking, such as milestone-based contracts and consulting agreements. |
general_ledger_account | string | Optional | General ledger account code or name for accounting purposes. May be configured at the group, company, or organization level. Empty if not configured. |
group_id | Model | Optional | Expand Retrieve a payment breakdown — 200 response body — data item group id Unique identifier for the group associated with this payment. Empty for organization-level payments, individual payments, and standalone service fees that are not associated with a specific group. |
invoice_id | string | Optional | Unique identifier of this resource. |
others | string | Optional | Other payment amounts. |
overtime | string | Optional | Overtime payment amount. |
payment_currency | string | Optional | Currency in which the payment was processed. |
payment_date | string | Optional | Date when the payment was made. Format: date-time |
pro_rata | string | Optional | Pro-rated payment amount. |
processing_fee | string | Optional | Processing fee amount applied to the payment. |
total | string | Optional | Total payment due for this breakdown item. |
total_payment_currency | string | Optional | Total payment in the payment currency. |
work | string | Optional | Base payment amount for work performed, including regular salary/wages and off-cycle payments. |
Referenced models: Retrieve a payment breakdown — 200 response body — data item approve date, Retrieve a payment breakdown — 200 response body — data item contract start date, Retrieve a payment breakdown — 200 response body — data item contract type string, Retrieve a payment breakdown — 200 response body — data item contractor unique identifier, Retrieve a payment breakdown — 200 response body — data item frequency, Retrieve a payment breakdown — 200 response body — data item group id
Retrieve a payment breakdown — 200 response body — data item approve date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Date when the work report was approved by designated approvers. Empty for payments that don't require work report approval, such as service fees, management fees, and automated payments. |
$ (anyOf 1) | string | Alternative | Format: date-time |
$ (anyOf 2) | string | Alternative | Known values: "" (empty string) |
Retrieve a payment breakdown — 200 response body — data item contract start date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Start date of the contract. Empty for service agreements and fee-related contracts (such as equipment payments, insurance payments, and management fees) that don't have traditional contract start dates. |
$ (anyOf 1) | string | Alternative | Format: date-time |
$ (anyOf 2) | string | Alternative | Known values: "" (empty string) |
Retrieve a payment breakdown — 200 response body — data item contract type string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Type of contract this payment relates to. Determines the nature of the work relationship and payment structure. Known values: milestones, time_based, ongoing_time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, peo, peo_csa, unknown, employee, global_payroll, shield_msa, gp_client_agreement, ep_client_agreement, power_of_attorney, debt_authorization, hris_direct_employee, hris_service_agreement, hofy_standalone_payment, wework_standalone_payment, travel_insurance_standalone_payment, health_insurance_standalone_payment, prepaid_billing, missing_saas_fees, one_off_service_fee, eor_management_fee, eor_one_off_management_fee, engage_monthly_subscription_fee, ats_subscription_fee, benefits_admin_monthly_platform_fee, contractor_outside_deel, late_payment_fee, background_check_standalone_payment, peo_service_fee, payment_processing_fee, deel_percentage_fee, netx_fee, prepaid_funding_statement, one_off_mobility_service_fee, prepaid_billing_expired_credits, implementation_delay, managed_hr_monthly_subscription_fee, expense_card, anon_report_fee, ic_maintenance_platform_fee, deel_it_order_statement, hris_direct_contractor, office_solutions, usp_service_fee, ic_contract_fees, mobility_subscription_service_fee, intercompany, deel_card_fee, entity_management, crypto_payout, deel_ai_workforce, deel_talent_fee, deel_hris, deel_compensation, contractor_subscription_fee, integration_services_fee, bundle_commitment_fee, wallet_chargeback_recovery_funding_statement, deel_workforce_planning_fee, fee_merge, payroll_merge, "" (empty string) |
Retrieve a payment breakdown — 200 response body — data item contractor unique identifier
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier for the worker. May be empty for certain contract types such as service agreements and fees. |
$ (anyOf 1) | string | Alternative | Format: uuid |
$ (anyOf 2) | string | Alternative | Known values: "" (empty string) |
Retrieve a payment breakdown — 200 response body — data item frequency
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Work unit scale from the contractor's work statement. Indicates how work is measured and reported (hourly, daily, weekly, monthly, or custom units). Empty for contracts with fixed payments that don't require work quantity tracking, such as milestone-based contracts and consulting agreements. Known values: hourly, daily, weekly, biweekly, semimonthly, monthly, custom, "" (empty string) |
Retrieve a payment breakdown — 200 response body — data item group id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier for the group associated with this payment. Empty for organization-level payments, individual payments, and standalone service fees that are not associated with a specific group. |
$ (anyOf 1) | string | Alternative | Format: uuid |
$ (anyOf 2) | string | Alternative | Known values: "" (empty string) |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.accounting_retrieveapaymentbreakdown_v2026_01_01. Catalog operation: accounting_retrieveapaymentbreakdown_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"}