List receivables
GET/receivables
Returns a cursor-paginated page of receivables (accounts receivable) for the workspace tied to the token's sub claim. Mirror of /payables with the receive-side settlement amounts (interest_amount, discount_amount, ticket_amount) and a derived nominal_amount = amount + interest - discount. Status is the raw DB enum (pending / received / cancelled); derive overdue client-side. Every row also carries the charge mirror (charge) — whether a bank slip / Pix was issued for it and where that charge stands. null when never charged. Branch on charge.state, not on charge.status: the commercial axis alone calls a charge opened while its registration at the institution is still pending, and such a charge cannot be paid. Default sort is due_date ascending. Requires scope finance.receivables.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
Page of receivables plus pagination metadata.
Malformed query (unknown filter / operator, invalid limit, bad cursor).
Missing / invalid / expired / revoked token.
Token authenticated but lacks the finance.receivables scope, or sub does not match any workspace.
Rate limit exceeded for this token. Reads and writes have separate budgets, both on a 1-hour sliding window. The response carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and Retry-After — wait out Retry-After rather than retrying immediately.
Unhandled server error.