List payment receipts
GET/receipts
Returns a cursor-paginated page of payment receipts (comprovantes) for the workspace tied to the token's sub claim — the proof that a payment left. A receipt is either captured (source: "kobana", produced in the background when a payment dispatched to the bank was confirmed) or uploaded (source: "upload", a file someone attached for a payment made outside the system). Only an uploaded one can be missing a payable_id. Default sort is -paid_at. Requires scope finance.receipts.
⚠️ download_url points at the attachments resource, so fetching the bytes needs a token that also carries finance.attachments. And a row can legitimately have no binary at all: when the origin offered only a format we do not store, the receipt is available and reachable through document_url instead.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
Page of receipts plus pagination metadata.
Malformed query (unknown filter / operator, invalid limit, bad cursor).
Missing / invalid / expired / revoked token.
Token authenticated but lacks the finance.receipts 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 ratelimit-limit, ratelimit-remaining, ratelimit-reset and retry-after — wait out retry-after rather than retrying immediately.
Unhandled server error.