Faturas e recebimentos

Faturas e seus itens, pagamentos e métodos de pagamento, as contas bancárias e chaves Pix que recebem cobranças por transferência, créditos aplicados na conta e cupons de desconto.

Famílias nesta página

Família	Tools	read	write	destructive
invoices — Faturas	23	8	11	4
payments — Pagamentos e métodos de pagamento	19	4	11	4
transfer-destinations — Contas bancárias e chaves Pix	11	5	4	2
credits — Créditos	7	3	3	1
coupons — Cupons e códigos de desconto	8	3	4	1

invoices

Tool	Tipo	Permissão	Endpoint	O que faz
billing_billing_accounts_invoices	read	invoices.list	GET /v1/billing_accounts/:id/invoices	List the invoices of one billing account.
billing_subscriptions_create_invoice	write	invoices.create	POST /v1/subscriptions/:id/create-invoice	Raise an invoice for the current period of a subscription now, instead of waiting for the billing worker.
billing_invoices_list	read	invoices.list	GET /v1/invoices	List invoices.
billing_invoices_get	read	invoices.show	GET /v1/invoices/:id	Fetch one invoice with its line items and totals.
billing_invoices_create	write	invoices.create	POST /v1/invoices	Create a draft invoice with its line items.
billing_invoices_upsert	write	invoices.create	PUT /v1/invoices	Create or update an invoice matched on id → external_id.
billing_invoices_update	write	invoices.update	PATCH /v1/invoices/:id	Update an invoice.
billing_invoices_delete	destructive	invoices.update	DELETE /v1/invoices/:id	Soft-delete an invoice.
billing_invoices_finalize	write	invoices.update	POST /v1/invoices/:id/finalize	Finalize a draft invoice: it becomes open, gets its number, and — with charge_automatically — is charged immediately.
billing_invoices_pay	write	payments.create	POST /v1/invoices/:id/pay	Settle an invoice.
billing_invoices_undo_payment	destructive	invoices.update	POST /v1/invoices/:id/undo-payment	Reverse a manual settlement, sending the invoice back to open.
billing_invoices_void	destructive	invoices.void	POST /v1/invoices/:id/void	Void an open invoice.
billing_invoices_apply_credits	write	invoices.update	POST /v1/invoices/:id/apply-credits	Apply credits of the billing account to an open invoice, reducing the amount due.
billing_invoices_remove_credits	destructive	invoices.update	POST /v1/invoices/:id/remove-credits	Undo every credit application on an open invoice, returning the credits to the billing account balance.
billing_invoices_installments_list	read	invoices.show	GET /v1/invoices/:id/installments	List the installment schedule of an invoice.
billing_invoices_installments_create	write	invoices.update	POST /v1/invoices/:id/installments	Split an invoice into installments.
billing_invoices_installments_pay	write	payments.create	POST /v1/invoices/:id/installments/:installmentId/pay	Charge one installment: through the gateway (pix, bank_slip, card), or as a bank_transfer to an organization bank account or Pix key.
billing_invoices_installments_mark_paid	write	payments.create	POST /v1/invoices/:id/installments/:installmentId/mark-paid	Mark one installment paid out of band, without touching a gateway.
billing_invoices_payment_methods	read	invoices.show	GET /v1/invoices/:id/payment-methods	Payment methods usable to settle this invoice, in the order the portal offers them.
billing_invoices_send_reminder	write	invoices.send	POST /v1/invoices/:id/send-reminder	E-mail the customer a payment reminder for an open invoice.
billing_invoices_pdf	read	invoices.show	GET /v1/invoices/:id/pdf	Metadata for the invoice PDF.
billing_invoices_pending_nfe	read	invoices.list	GET /v1/invoices/pending-nfe	Invoices that are due an NFe and have not had one issued yet.
billing_invoices_pending_payment	read	invoices.list	GET /v1/invoices/pending-payment	Open invoices still awaiting payment.

payments

Tool	Tipo	Permissão	Endpoint	O que faz
billing_payments_list	read	payments.list	GET /v1/payments	List payments — every charge attempt, successful or not.
billing_payments_get	read	payments.show	GET /v1/payments/:id	Fetch one payment with its gateway status.
billing_payments_create	write	payments.create	POST /v1/payments	Charge an invoice through a gateway.
billing_payments_delete	destructive	payments.update	DELETE /v1/payments/:id	Soft-delete a payment record.
billing_payments_retry	write	payments.retry	POST /v1/payments/:id/retry	Retry a failed payment with the same method.
billing_payments_refund	destructive	payments.refund	POST /v1/payments/:id/refund	Refund a succeeded payment at the gateway.
billing_payments_cancel	destructive	payments.update	POST /v1/payments/:id/cancel	Cancel a pending payment.
billing_payments_change_due_date	write	payments.update	POST /v1/payments/:id/change-due-date	Move the due date of an open boleto/PIX charge.
billing_payments_change_card	write	payments.update	POST /v1/payments/:id/change-card	Point a card payment at a different stored card before retrying it.
billing_payments_send_email	write	payments.update	POST /v1/payments/:id/send-email	E-mail the charge (boleto/PIX link) to an address.
billing_payments_sync	write	payments.update	POST /v1/payments/:id/sync	Re-read a payment from the gateway and update the local status.
billing_payments_bulk_update_invoice	write	payments.update	POST /v1/payments/bulk-update-invoice	Re-link up to 100 payments to another invoice.
billing_payment_methods_list	read	payments.list	GET /v1/payment_methods	List stored payment methods.
billing_payment_methods_get	read	payments.show	GET /v1/payment_methods/:id	Fetch one payment method.
billing_payment_methods_create	write	payments.create	POST /v1/payment_methods	Attach a payment method to a billing account.
billing_payment_methods_upsert	write	payments.create	PUT /v1/payment_methods	Create or update a payment method matched on id → external_id.
billing_payment_methods_update	write	payments.update	PATCH /v1/payment_methods/:id	Update a payment method — the default flag and its metadata.
billing_payment_methods_delete	destructive	payments.update	DELETE /v1/payment_methods/:id	Detach a payment method.
billing_payment_methods_set_default	write	payments.update	POST /v1/payment_methods/:id/set-default	Make this the default payment method of its billing account.

transfer-destinations

Tool	Tipo	Permissão	Endpoint	O que faz
billing_banks_list	read	settings.view	GET /v1/banks	List the Brazilian banks (COMPE code and name) a bank account can be registered under.
billing_bank_accounts_list	read	settings.view	GET /v1/bank_accounts	List the organization bank accounts customers can be told to transfer to on a bank_transfer charge.
billing_bank_accounts_get	read	settings.view	GET /v1/bank_accounts/:id	Fetch one organization bank account, with its bank.
billing_bank_accounts_create	write	settings.update	POST /v1/bank_accounts	Register an organization bank account to receive bank_transfer charges.
billing_bank_accounts_update	write	settings.update	PATCH /v1/bank_accounts/:id	Update an organization bank account.
billing_bank_accounts_delete	destructive	settings.update	DELETE /v1/bank_accounts/:id	Soft-delete an organization bank account.
billing_pix_keys_list	read	settings.view	GET /v1/pix_keys	List the organization Pix keys customers can be told to transfer to on a bank_transfer charge.
billing_pix_keys_get	read	settings.view	GET /v1/pix_keys/:id	Fetch one organization Pix key.
billing_pix_keys_create	write	settings.update	POST /v1/pix_keys	Register an organization Pix key to receive bank_transfer charges.
billing_pix_keys_update	write	settings.update	PATCH /v1/pix_keys/:id	Update an organization Pix key.
billing_pix_keys_delete	destructive	settings.update	DELETE /v1/pix_keys/:id	Soft-delete an organization Pix key.

credits

Tool	Tipo	Permissão	Endpoint	O que faz
billing_billing_accounts_credits	read	credits.list	GET /v1/billing_accounts/:id/credits	List the credits of one billing account.
billing_credits_list	read	credits.list	GET /v1/credits	List credits.
billing_credits_get	read	credits.show	GET /v1/credits/:id	Fetch one credit with what is left of it.
billing_credits_create	write	credits.create	POST /v1/credits	Grant a credit to a billing account.
billing_credits_upsert	write	credits.create	PUT /v1/credits	Create or update a credit matched on id → external_id.
billing_credits_update	write	credits.create	PATCH /v1/credits/:id	Update a credit.
billing_credits_delete	destructive	credits.delete	DELETE /v1/credits/:id	Soft-delete a credit.

coupons

Tool	Tipo	Permissão	Endpoint	O que faz
billing_coupons_list	read	coupons.list	GET /v1/coupons	List discount coupons with their validity window and usage counters.
billing_coupons_get	read	coupons.show	GET /v1/coupons/:id	Fetch one coupon with its usage counters.
billing_coupons_create	write	coupons.create	POST /v1/coupons	Create a discount coupon.
billing_coupons_upsert	write	coupons.create	PUT /v1/coupons	Create or update a coupon matched on id → external_id → code.
billing_coupons_update	write	coupons.update	PATCH /v1/coupons/:id	Update a coupon.
billing_coupons_delete	destructive	coupons.delete	DELETE /v1/coupons/:id	Soft-delete a coupon.
billing_coupons_deactivate	write	coupons.update	POST /v1/coupons/:id/deactivate	Stop a coupon being redeemable, keeping its history intact.
billing_coupons_redemptions	read	coupons.show	GET /v1/coupons/:id/redemptions	List the redemptions of a coupon — who used it, when, and for how much.

---

Os campos de cada recurso estão na Referência da API e em billing_schemas_get.

Uma tool que você não pode rodar não aparece em tools/list. Se uma daqui não está lá, veja Autenticação.