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.
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["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 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.refund_statements.retrieve_refund_statement_credit_note_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.refund_statement_id | string | Required within parent | Minimum length: 1 |
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 refund statement credit-note breakdown — 200 response body |
Referenced models: Retrieve refund statement credit-note breakdown — 200 response body
Schemas
Section titled “Schemas”Retrieve refund statement credit-note breakdown — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Credit note / credit statement lines linked to this refund statement. |
data[] | Model | Each item | Expand Retrieve refund statement credit-note breakdown — 200 response body — data item |
has_more | boolean | Required within parent | Reserved for pagination; currently always false (full breakdown returned in `data`). |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Reserved for cursor pagination; currently always null for this endpoint. |
next_cursor (anyOf 2) | null | Alternative | Reserved 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Credit amount; typically negative for credits. |
contract_id | JSON | Optional | |
contract_id (anyOf 1) | string | Alternative | Contract `oid` when the credit note is tied to a contract; otherwise null. |
contract_id (anyOf 2) | null | Alternative | Contract `oid` when the credit note is tied to a contract; otherwise null. |
currency | string | Required within parent | ISO 4217 currency code. |
id | string | Required within parent | Public id of the credit note (or credit statement line) invoice. |
label | string | Required within parent | Display label (sequencing label or description fallback). |
original_invoice_id | JSON | Optional | |
original_invoice_id (anyOf 1) | string | Alternative | Public id of the invoice being credited when applicable; `null` when not linked. |
original_invoice_id (anyOf 2) | null | Alternative | Public id of the invoice being credited when applicable; `null` when not linked. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}