Deel: Retrieve refund statements
Deel accounting.retrieveRefundStatements: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation deel.accounting_retrieverefundstatements_v2026_04_30
Provider route: GET /refund-statements. 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"]["retrieveRefundStatements"]>[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.retrieveRefundStatements(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_refund_statements(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.date_from | string | Optional | Format: date |
query.date_to | string | Optional | Format: date |
query.cursor | string | Optional | |
query.currencies | array | Optional | |
query.currencies[] | string | Each item | Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
query.entities | array | Optional | |
query.entities[] | string | Each item | One of: individual, company |
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 statements — 200 response body |
Referenced models: Retrieve refund statements — 200 response body
Schemas
Section titled “Schemas”Retrieve refund statements — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve refund statements — 200 response body — data |
Referenced models: Retrieve refund statements — 200 response body — data
Retrieve refund statements — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
has_more | boolean | Required within parent | Inform if there are more entries to be fetched using next cursor,. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null. |
next_cursor (anyOf 2) | null | Alternative | A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null. |
rows | array | Required within parent | Array of refund statements matching the query criteria. |
rows[] | Model | Each item | Expand Retrieve refund statements — 200 response body — data rows item |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | The total number of refund statements matching the query. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve refund statements — 200 response body — data rows item
Retrieve refund statements — 200 response body — data rows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Amount of the payment. |
created_at | string | Required within parent | Date and time when the refund statement was created, in ISO-8601 format. Format: date-time |
currency | string | Required within parent | Three-letter currency code for the payment, following ISO 4217. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
id | string | Required within parent | Unique identifier of the refund statement. |
label | string | Required within parent | A descriptive label for the refund statement. |
paid_at | JSON | Optional | |
paid_at (anyOf 1) | string | Alternative | Date and time when the refund statement was completed, in ISO-8601 format. Format: date-time |
paid_at (anyOf 2) | null | Alternative | Date and time when the refund statement was completed, in ISO-8601 format. Format: date-time |
payment_method | string | Required within parent | Method of payment used for the refund statement. Known values: bank_transfer, client_balance |
status | string | Required within parent | Status of the refund statement. Either 'paid', 'processing', 'cancelled' or 'failed'. Known values: paid, processing, cancelled, failed |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.accounting_retrieverefundstatements_v2026_04_30. Catalog operation: accounting_retrieverefundstatements_v2026_04_30. 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-04-30"}