Payables and receivables

The titles: create, update, settle, cancel and delete payables and receivables, the totals per period, send a payment to the bank and issue a charge (bank slip or Pix).

Families on this page

Family	Tools	read	write	destructive
payables — Payables	9	4	2	3
receivables — Receivables	9	4	2	3

payables

Tool	Kind	Permission	Endpoint	What it does
finance_payables_list	read	payables.list	GET /v1/payables	List payables (contas a pagar), cursor-paginated.
finance_payables_get	read	payables.show	GET /v1/payables/{id}	Fetch one payable with its rateio (cost_center_allocations), tax charges, custom classifications and reconciliation group.
finance_payables_aggregates	read	payables.list	GET /v1/payables/aggregates	Totals of payables (pending, paid, overdue…) for a period (month+year or start_date+end_date) and optionally one company.
finance_payables_ids	read	payables.list	GET /v1/payables/ids	The id of every live payable, for reconciling a mirror: an id that stops appearing was deleted.
finance_payables_create	write	payables.create	POST /v1/payables	Create a payable.
finance_payables_update	write	payables.update	PATCH /v1/payables/{id}	Partially update a payable.
finance_payables_delete	destructive	payables.delete	DELETE /v1/payables/{id}	Delete a payable.
finance_payables_send_to_bank	destructive	payables.dispatch	POST /v1/payables/{id}/send-to-bank	MOVES MONEY: dispatch an approved payable to the bank through Kobana.
finance_payables_cancel_dispatch	destructive	payables.dispatch	POST /v1/payables/{id}/cancel-dispatch	Cancel a payable's bank dispatch on the Kobana side.

receivables

Tool	Kind	Permission	Endpoint	What it does
finance_receivables_list	read	receivables.list	GET /v1/receivables	List receivables (contas a receber), cursor-paginated.
finance_receivables_get	read	receivables.show	GET /v1/receivables/{id}	Fetch one receivable with its rateio, tax charges, custom classifications, charge state and reconciliation group.
finance_receivables_aggregates	read	receivables.list	GET /v1/receivables/aggregates	Totals of receivables (pending, received, overdue…) for a period (month+year or start_date+end_date) and optionally one company.
finance_receivables_ids	read	receivables.list	GET /v1/receivables/ids	The id of every live receivable, for reconciling a mirror.
finance_receivables_create	write	receivables.create	POST /v1/receivables	Create a receivable.
finance_receivables_update	write	receivables.update	PATCH /v1/receivables/{id}	Partially update a receivable.
finance_receivables_delete	destructive	receivables.delete	DELETE /v1/receivables/{id}	Delete a receivable.
finance_receivables_charge	destructive	receivables.charge	POST /v1/receivables/{id}/charge	ASKS A CUSTOMER FOR MONEY: issue a bank slip or Pix charge for the receivable through Kobana.
finance_receivables_charge_cancel	destructive	receivables.charge	POST /v1/receivables/{id}/charge/cancel	Cancel the receivable's charge on the gateway.

---

The fields of each resource are in the API reference and in finance_schemas_get.

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.