Boletos e cobranças

Os boletos que a conta emite para receber, as carteiras de cobrança que os registram, os pagamentos recebidos, carnês, assinaturas e o recebimento unificado.

Famílias nesta página

Família	Tools	read	write	destructive
Boletos de cobrança	17	2	7	8
Carteiras de cobrança	5	2	2	1
Pagamentos de boletos	2	2	0	0
Carnês	4	2	1	1
Assinaturas	5	2	2	1
Recebimentos	4	2	0	2

Boletos de cobrança

Escopo: banking/charge.bank_billets

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_bank_billet_list	read	charge.bank_billets.basic	GET /v1/bank_billets	Lists bank billets of the authenticated account, with filters that combine.
banking_charge_bank_billet_get	read	charge.bank_billets.basic	GET /v1/bank_billets/:id	Returns every field of one bank billet — including its payments, registrations, remittances, discharges and associated Pix — in the same shape as the v1 API.
banking_charge_bank_billet_create	write	charge.bank_billets.create	POST /v1/bank_billets	Issues a bank billet.
banking_charge_bank_billet_update	write	charge.bank_billets.update	PUT /v1/bank_billets/:id	Updates a billet that has already been issued.
banking_charge_bank_billet_cancel	destructive	charge.bank_billets.basic + charge.bank_billets.cancel	PUT /v1/bank_billets/:id/cancel	Asks the bank to write off (cancel) a billet.
banking_charge_bank_billet_cancel_batch	destructive	charge.bank_billets.basic + charge.bank_billets.cancel	POST /v1/bank_billets/cancel_all	Cancels several billets at once, in the background.
banking_charge_bank_billet_duplicate	write	charge.bank_billets.create	POST /v1/bank_billets/:id/duplicate	Creates a new billet from an existing one, inheriting the original's data.
banking_charge_bank_billet_pay	destructive	charge.bank_billets.pay	PUT /v1/bank_billets/:id/pay	Marks a billet as paid directly to the beneficiary, without the payment having come from the bank.
banking_charge_bank_billet_protest	destructive	charge.bank_billets.basic + charge.bank_billets.command	PUT /v1/bank_billets/:id/protest/:type	Sends the bank an instruction to protest an overdue billet (send) or to withdraw a protest already requested (cancel).
banking_charge_bank_billet_revoke	destructive	charge.bank_billets.basic + charge.bank_billets.cancel	painel: GET /boletos/:id/revoke	Marks the billet as written off in Kobana, without asking the bank for a write-off.
banking_charge_bank_billet_mark_overdue	write	charge.bank_billets.basic + charge.bank_billets.cancel	painel: GET /boletos/:id/overdue	Forces the billet into overdue.
banking_charge_bank_billet_create_occurrence	destructive	charge.bank_billets.basic + charge.bank_billets.command	painel: GET /boletos/:id/movimentar/:occurrence	Queues a CNAB instruction about the billet onto the next remittance to the bank — granting a rebate, changing the "uso da empresa" field, requesting a return, and so on.
banking_charge_bank_billet_take_off_remittance	destructive	charge.bank_billets.basic	painel: GET /boletos/:id/nao_enviar_para_banco	Removes the billet from a CNAB remittance that has not been sent to the bank yet.
banking_charge_bank_billet_update_addons	write	charge.bank_billets.update	PUT /v1/bank_billets/:id/addons	Writes the billet addons — extra data Kobana carries alongside the instrument without sending it to the bank.
banking_charge_bank_billet_send_email	write	charge.bank_billets.basic	POST /v1/bank_billets/:id/send_email	E-mails the billet to the payer.
banking_charge_bank_billet_send_sms	write	charge.bank_billets.basic	POST /v1/bank_billets/:id/send_sms	Sends the payer an SMS with the billet details.
banking_charge_bank_billet_delete	destructive	charge.bank_billets.basic + charge.bank_billets.destroy	painel: DELETE /boletos/:id	Deletes a billet that is already canceled.

Carteiras de cobrança

Escopo: banking/charge.bank_billet_accounts

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_bank_billet_account_list	read	charge.bank_billet_accounts.basic	GET /v2/charge/bank_billet_accounts	Lists the bank billet accounts (carteiras de cobrança) of the account: the bank wallets bank billets are issued from.
banking_charge_bank_billet_account_get	read	charge.bank_billet_accounts.basic	GET /v2/charge/bank_billet_accounts/:uid	Returns every field of one bank billet account (carteira de cobrança), including its bank contract, next numbers and bolepix settings, in the same shape as the API v2.
banking_charge_bank_billet_account_create	write	charge.bank_billet_accounts.create	POST /v2/charge/bank_billet_accounts	Creates a bank billet account (carteira de cobrança): the bank wallet that bank billets are issued from.
banking_charge_bank_billet_account_update	write	charge.bank_billet_accounts.update	PATCH /v2/charge/bank_billet_accounts/:uid	Changes settings of a bank billet account (carteira de cobrança): name, layout kind, next "nosso número" and remittance number, beneficiary address, payment place and bolepix Pix account.
banking_charge_bank_billet_account_delete	destructive	charge.bank_billet_accounts.destroy	DELETE /v2/charge/bank_billet_accounts/:uid	Deletes a bank billet account (carteira de cobrança) together with its bank billets, remittances and history.

Pagamentos de boletos

Escopo: banking/charge.bank_billet_payments

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_bank_billet_payment_list	read	charge.bank_billet_payments.basic	GET /v2/charge/bank_billet_payments	Lists the payments (baixas por pagamento) received for the account's bank billets, most recent first, with filters that combine.
banking_charge_bank_billet_payment_get	read	charge.bank_billet_payments.basic	GET /v2/charge/bank_billet_payments/:uid	Returns every field of one bank billet payment (paid amount, dates, receiving bank and agency, fees), with the billet it settled, in the same shape as the API v2.

Carnês

Escopo: banking/charge.installments

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_installment_list	read	charge.installments.basic	GET /v2/charge/installments	Lists the installment plans (carnês: a set of bank billets for the same payer) of the account, most recent first.
banking_charge_installment_get	read	charge.installments.basic	GET /v2/charge/installments/:uid	Returns every field of one installment plan (carnê), including its status and the bank billets it generated, in the same shape as the API v2.
banking_charge_installment_create	write	charge.installments.create	POST /v2/charge/installments	Creates an installment plan (carnê): total bank billets of amount for the same payer, the first due at start_at and the next ones every cycle; or one billet per item of custom_bank_billets.
banking_charge_installment_delete	destructive	charge.installments.destroy	DELETE /v2/charge/installments/:uid	Deletes an installment plan (carnê).

Assinaturas

Escopo: banking/charge.customer_subscriptions

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_customer_subscription_list	read	charge.customer_subscriptions.basic	GET /v2/charge/customer_subscriptions	Lists the customer subscriptions (recurring bank billet charges) of the account, most recent first.
banking_charge_customer_subscription_get	read	charge.customer_subscriptions.basic	GET /v2/charge/customer_subscriptions/:uid	Returns every field of one customer subscription (recurring bank billet charge), including its cycle, next billing date, penalties and the billets issued, in the same shape as the API v2.
banking_charge_customer_subscription_create	write	charge.customer_subscriptions.create	POST /v2/charge/customer_subscriptions	Creates a customer subscription: a recurring charge that issues a bank billet to the payer every cycle, starting at next_billing, days_in_advance days before each due date, until end_at (or forever).
banking_charge_customer_subscription_update	write	charge.customer_subscriptions.update	PUT /v2/charge/customer_subscriptions/:uid	Changes a customer subscription (amount, cycle, next billing date, payer, penalties...).
banking_charge_customer_subscription_delete	destructive	charge.customer_subscriptions.destroy	DELETE /v2/charge/customer_subscriptions/:uid	Deletes a customer subscription, so no new billet is issued for it.

Recebimentos

Escopo: banking/charge.payments

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_payment_list	read	charge.payments.basic	GET /v2/charge/payments	Lists the payments (recebimentos) the account received for its bank billets and Pix charges, most recent first, with filters that combine.
banking_charge_payment_get	read	charge.payments.basic	GET /v2/charge/payments/:uid	Returns one payment (recebimento) received for a bank billet or Pix charge, with the charge it settled, payer, debtor and receiving bank, in the same shape as the API v2.
banking_charge_payment_create	destructive	charge.payments.create	POST /v2/charge/payments	Registers a payment received outside Kobana (baixa manual) for a bank billet or Pix charge of the account, and settles the charge with it: a Pix becomes paid with this amount; a billet becomes paid once its payments cover its amount or reach its payment count.
banking_charge_payment_delete	destructive	charge.payments.destroy	DELETE /v2/charge/payments/:uid	Deletes a payment registered for a bank billet and recalculates the billet, which goes back to unpaid when no other payment covers it.

---

Os campos de cada recurso estão na Referência da API. Uma tool que você não pode rodar não aparece em tools/list; se uma daqui não está lá, veja Autenticação.