v55

latestOpenAPI 3.1.0CC-BY-NC-SA-4.0raw.githubusercontent.com2026-08-011243791.8 MB
Settlements API

Get open settlement

Retrieve the details of the open balance of the organization. This will return a settlement object representing your organization's balance.

For a complete reference of the settlement object, refer to the Get settlement endpoint documentation.

For more accurate bookkeeping, refer to the balance report endpoint or the balance transactions endpoint.

get/v2/settlements/open

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A settlement object describing your current balance. For a complete reference of the settlement object, refer to the Get settlement endpoint documentation.