Skip to content

Deel: Refund statements schemas

2 Deel schemas with complete fields and constraints.

← Refund statements operations · All schemas

Retrieve refund statement credit-note breakdown — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentCredit note / credit statement lines linked to this refund statement.
data[]ModelEach itemExpand Retrieve refund statement credit-note breakdown — 200 response body — data item
has_morebooleanRequired within parentReserved for pagination; currently always false (full breakdown returned in `data`).
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeReserved for cursor pagination; currently always null for this endpoint.
next_cursor (anyOf 2)nullAlternativeReserved for cursor pagination; currently always null for this endpoint.

Referenced models: Retrieve refund statement credit-note breakdown — 200 response body — data item

Retrieve refund statement credit-note breakdown — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentCredit amount; typically negative for credits.
contract_idJSONOptional
contract_id (anyOf 1)stringAlternativeContract `oid` when the credit note is tied to a contract; otherwise null.
contract_id (anyOf 2)nullAlternativeContract `oid` when the credit note is tied to a contract; otherwise null.
currencystringRequired within parentISO 4217 currency code.
idstringRequired within parentPublic id of the credit note (or credit statement line) invoice.
labelstringRequired within parentDisplay label (sequencing label or description fallback).
original_invoice_idJSONOptional
original_invoice_id (anyOf 1)stringAlternativePublic id of the invoice being credited when applicable; `null` when not linked.
original_invoice_id (anyOf 2)nullAlternativePublic id of the invoice being credited when applicable; `null` when not linked.

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.