TripleBooks
Treasury

Settlements

Settlements and settlement batches

Authentication

Authenticate with Authorization: Bearer ak_... — see API keys. Requests are scoped to one entity. Pass entityId as a query parameter, JSON field, or x-entity-id header. API keys are already pinned to an entity. A mismatched entityId returns 403.

Endpoints

MethodPathDescription
GET/api/ledger/settlements?entityId=List settlements
POST/api/ledger/settlementsRecord settlement
GET/api/ledger/settlement-batches?entityId=List batches

List settlements

GET /api/ledger/settlements?entityId={entityId}

Returns settlements for the entity. Supports batchId, status, dateRange, and other filters.

Record settlement

POST /api/ledger/settlements

Body: { "entityId", "batchId?", "amount", "counterpartyId", "date", "reference?", ... }

List settlement batches

GET /api/ledger/settlement-batches?entityId={entityId}

Returns settlement batches. Supports status, dateRange, and other filters.

On this page