Listar contas a pagar
GET/payables
Returns a cursor-paginated page of payables (accounts payable) for the workspace tied to the token's sub claim. Each row includes nested entity references (person, category, classification_center, each {id, name}) and aggregate counts (tax_charges_count, classification_center_allocations_count, attachments_count) — full child collections live in the per-resource detail endpoints. Each row also carries the settlement amounts (interest_amount, discount_amount, ticket_amount) and a derived nominal_amount = amount + interest - discount. Status is the raw DB enum (pending / paid / cancelled); derive overdue client-side via status === "pending" AND due_date < today. Default sort is due_date ascending. Payables awaiting human approval (see the create endpoint) are omitted from this list until an operator approves them in the app; a bill is still retrievable by id via GET /payables/{id}. To list the approval queue instead, filter it explicitly — ?payment_approval=pending_approval (read-only; there is no approve/reject action on this API). Each row carries its payment_approval state. Requires scope finance.payables.
Requisição
Respostas
- 200
- 400
- 401
- 403
- 429
- 500
Page of payables plus pagination metadata.
Malformed query (unknown filter / operator, invalid limit, bad cursor).
Missing / invalid / expired / revoked token.
Token authenticated but lacks the finance.payables 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.