Skip to content

Deel: Retrieve refund statement credit-note breakdown

Deel refundStatements.retrieveRefundStatementCreditNoteBreakdown: arguments, response, policy and SDK examples.

← Refund statements operations · Get started

Operation deel.refundstatements_retrieverefundstatementcreditnotebreakdown_v2026_05_11

Provider route: GET /refund-statements/{refund_statement_id}/breakdown. 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["refundStatements"]["retrieveRefundStatementCreditNoteBreakdown"]>[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.refundStatements.retrieveRefundStatementCreditNoteBreakdown(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.refund_statements.retrieve_refund_statement_credit_note_breakdown(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.refund_statement_idstringRequired within parentMinimum length: 1

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve refund statement credit-note breakdown — 200 response body

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

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.

SDK function policy ID: deel.refundstatements_retrieverefundstatementcreditnotebreakdown_v2026_05_11. Catalog operation: refundstatements_retrieverefundstatementcreditnotebreakdown_v2026_05_11. 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-05-11"}

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.