API — Financeiro e fiscal

OpenAPI: packages/openapi/openapi.v1.yaml
Atualizado: 2026-09-13

Contas a receber

Method	Path	Permissão	Descrição
GET	/receivables	finance.receivable.read	Listar títulos
POST	/receivables	finance.receivable.create	Criar
GET	/receivables/{id}	finance.receivable.read	Detalhe
PATCH	/receivables/{id}	finance.receivable.update	Atualizar
GET	/receivables/{id}/history	finance.receivable.read	Histórico
POST	/receivables/{id}/settle	finance.receivable.update	Baixar / receber
POST	/receivables/{id}/cancel	finance.receivable.update	Cancelar
POST	/receivables/{id}/register-boleto	finance.receivable.update	Registrar boleto (ex.: BB API)
POST	/receivables/prepare-boletos	finance.receivable.update	Preparar impressão de boletos
POST	/receivables/mark-printed	finance.receivable.update	Marcar como impresso
POST	/receivables/send-boleto-email	finance.receivable.update	Enviar boleto por e-mail
POST	/receivables/{id}/attachments	finance.receivable.update	Anexo
GET	/reports/receivables.csv	reports.receivable.export	Exportação

Contas a pagar

Method	Path	Permissão	Descrição
GET	/payables/next-id	finance.payable.read	Próximo ID
GET	/payables	finance.payable.read	Listar
POST	/payables	finance.payable.create	Criar
GET	/payables/{id}	finance.payable.read	Detalhe
PATCH	/payables/{id}	finance.payable.update	Atualizar
POST	/payables/{id}/settle	finance.payable.settle	Liquidar
POST	/payables/{id}/cancel	finance.payable.cancel	Cancelar
POST	/payables/{id}/payments/{paymentId}/reverse	finance.payable.reverse_payment	Estornar pagamento
POST	/payables/{id}/reverse-cancel	finance.payable.reverse_cancel	Reverter cancelamento
DELETE	/payables/{id}/attachments/{attachmentId}	finance.payable.delete_attachment	Remover anexo

Bancos, carteiras, remessa e retorno

Method	Path	Permissão	Descrição
GET	/banks	finance.bank_account.read	Catálogo de bancos
GET	/banks/{code}	finance.bank_account.read	Banco por código
GET	/bank-accounts	finance.bank_account.read	Contas bancárias
POST	/bank-accounts	finance.bank_account.create	Criar conta
GET	/bank-accounts/{id}	finance.bank_account.read	Detalhe
PATCH	/bank-accounts/{id}	finance.bank_account.update	Atualizar
GET	/collection-wallets	auxiliary.collection_wallet.read	Carteiras de cobrança
POST	/collection-wallets	auxiliary.collection_wallet.create	Criar carteira
GET	/remittances	finance.remittance.read	Remessas
POST	/remittances	finance.remittance.create	Gerar remessa
GET	/remittances/{id}/download	finance.remittance.read	Download arquivo
GET	/return-batches	finance.remittance.read	Retornos
POST	/return-batches	finance.remittance.create	Importar retorno

Webhook BB (público com token): POST /webhooks/bb/cobrancas/{token}.

Régua e renegociação

Method	Path	Permissão	Descrição
GET	/collection-rules	finance.receivable.read	Listar régua
POST	/collection-rules	finance.receivable.create	Criar regra
PATCH	/collection-rules/{id}	finance.receivable.update	Atualizar
POST	/collection-rules/{id}/run	finance.receivable.create	Executar régua
GET	/renegotiations	finance.receivable.read	Listar
POST	/renegotiations/preview	finance.receivable.read	Prévia
POST	/renegotiations	finance.receivable.create	Confirmar renegociação
GET	/renegotiations/{id}	finance.receivable.read	Detalhe

NFCom

Method	Path	Permissão	Descrição
GET	/nfcom/documents	fiscal.nfcom.read	Listar
POST	/nfcom/documents	fiscal.nfcom.create	Criar documento
GET	/nfcom/documents/{id}	fiscal.nfcom.read	Detalhe
POST	/nfcom/documents/{id}/transmit	fiscal.nfcom.transmit	Transmitir SEFAZ
POST	/nfcom/documents/{id}/cancel	fiscal.nfcom.cancel	Cancelar
POST	/nfcom/documents/{id}/substitute	fiscal.nfcom.substitute	Substituir
GET	/nfcom/documents/{id}/xml	fiscal.nfcom.read	XML
POST	/nfcom/documents/danfe	fiscal.nfcom.read	DANFE

CFOP e classificação fiscal

Method	Path	Permissão	Descrição
GET	/cfops	fiscal.cfop.read	Listar CFOP
POST	/cfops	fiscal.cfop.create	Criar
GET	/cfops/{id}	fiscal.cfop.read	Detalhe
PATCH	/cfops/{id}	fiscal.cfop.update	Atualizar
GET	/tax-classifications	fiscal.tax_classification.read	Listar classificações
POST	/tax-classifications	fiscal.tax_classification.create	Criar
GET	/tax-classifications/{id}	fiscal.tax_classification.read	Detalhe
PATCH	/tax-classifications/{id}	fiscal.tax_classification.update	Atualizar
GET/POST/PATCH/DELETE	/tax-classifications/{id}/uf-rules	read / update	Regras por UF
GET/POST/PATCH/DELETE	/tax-classifications/{id}/operation-rules	read / update	Regras por operação
GET/POST/PATCH/DELETE	/tax-classifications/{id}/iss-municipal	read / update	ISS municipal

Rascunhos fiscais auxiliares: /fiscal/drafts (fiscal.draft.*).

Ver também

• Visão geral
• Wiki operador: 23-WIKI/financeiro/, 23-WIKI/fiscal/

Referências