Skip to content

Deel: Retrieve a payment breakdown — 200 response body — data item

Retrieve a payment breakdown: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Retrieve a payment breakdown — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
adjustmentstringOptionalAdjustment amount for the payment.
approve_dateModelOptionalExpand 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.
approversstringOptionalComma-separated list of names of people who approved this payment. May be empty if no approvals were required or recorded.
bonusstringOptionalAdditional bonus payment amount awarded to the worker.
commissionsstringOptionalCommissions included in the payment.
contract_countrystringOptionalCountry where the contract is established.
contract_idJSONOptional
contract_id (anyOf 1)stringAlternativePublic identifier of the contract this line item belongs to. Null for service-fee and similar non-contract line items.
contract_id (anyOf 2)nullAlternativePublic identifier of the contract this line item belongs to. Null for service-fee and similar non-contract line items.
contract_start_dateModelOptionalExpand 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_typeJSONOptionalType of contract this payment relates to. Determines the nature of the work relationship and payment structure.
contract_type (anyOf 1)ModelAlternativeExpand Retrieve a payment breakdown — 200 response body — data item contract type string
contract_type (anyOf 2)nullAlternative
contractor_emailstringOptionalEmail address of the worker.
contractor_employee_namestringOptionalName of the worker.
contractor_pic_urlJSONOptional
contractor_pic_url (anyOf 1)stringAlternativeURL 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)nullAlternativeURL to the worker’s Deel avatar. Null if the worker has no avatar set or for non-worker line items.
contractor_unique_identifierModelOptionalExpand 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.
currencystringOptionalCurrency code for this payment.
datestringOptionalDate associated with the payment breakdown.
Format: date-time
deductionsstringOptionalDeductions from the payment.
expensesstringOptionalExpenses related to the payment.
frequencyModelOptionalExpand 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_accountstringOptionalGeneral ledger account code or name for accounting purposes. May be configured at the group, company, or organization level. Empty if not configured.
group_idModelOptionalExpand 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_idstringOptionalUnique identifier of this resource.
othersstringOptionalOther payment amounts.
overtimestringOptionalOvertime payment amount.
payment_currencystringOptionalCurrency in which the payment was processed.
payment_datestringOptionalDate when the payment was made.
Format: date-time
pro_ratastringOptionalPro-rated payment amount.
processing_feestringOptionalProcessing fee amount applied to the payment.
totalstringOptionalTotal payment due for this breakdown item.
total_payment_currencystringOptionalTotal payment in the payment currency.
workstringOptionalBase 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

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.