API — Cadastros e comercial

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

Clientes

Method	Path	Permissão	Descrição
GET	/customers	customer.customer.read	Listar / buscar
POST	/customers	customer.customer.create	Criar
GET	/customers/{id}	customer.customer.read	Detalhe / dashboard
PATCH	/customers/{id}	customer.customer.update	Atualizar
POST	/customers/lookup-cep	customer.customer.read	Consulta CEP
POST	/customers/check-address-duplicity	customer.customer.read	Duplicidade de endereço
GET	/customers/{id}/history	customer.customer.read	Histórico
GET	/customers/{id}/sales	customer.customer.read	Vendas do cliente
GET	/customers/{id}/negotiations	customer.customer.read	Negociações
GET	/customers/{id}/emails	customer.customer.read	E-mails enviados
GET	/customers/{id}/sms	customer.customer.read	SMS
GET	/customers/{id}/appointments	customer.customer.read	Agendamentos
POST	/customers/{id}/attachments	customer.customer.update	Anexos

Contratos e modelos

Method	Path	Permissão	Descrição
GET	/contracts	contract.contract.read	Listar
POST	/contracts	contract.contract.create	Criar
GET	/contracts/next-number	contract.contract.create	Próximo número
GET	/contracts/{id}	contract.contract.read	Detalhe
PATCH	/contracts/{id}	contract.contract.update	Atualizar
POST	/contracts/{id}/activate	contract.contract.update	Ativar
POST	/contracts/{id}/cancel	contract.contract.update	Cancelar
POST	/contracts/{id}/generate-finance	finance.receivable.create	Gerar financeiro
GET/POST/PATCH/DELETE	/contracts/{id}/circuit-designations	read / update	Circuitos
POST	/contracts/{id}/amendments	contract.contract.update	Aditivos
GET	/contracts/{id}/render-template	contract.contract.read	Render modelo
GET	/contract-templates	auxiliary.contract_template.read	Modelos
POST	/contract-templates	auxiliary.contract_template.create	Criar modelo
POST	/contract-templates/{id}/preview	auxiliary.contract_template.read	Preview

Produtos e fornecedores

Method	Path	Permissão	Descrição
GET	/products	catalog.product.read	Listar
POST	/products	catalog.product.create	Criar
GET	/products/{id}	catalog.product.read	Detalhe
PATCH	/products/{id}	catalog.product.update	Atualizar
POST	/products/{id}/prices	catalog.product.update	Preços
GET	/suppliers	supplier.supplier.read	Listar
POST	/suppliers	supplier.supplier.create	Criar
GET	/suppliers/{id}	supplier.supplier.read	Detalhe
PATCH	/suppliers/{id}	supplier.supplier.update	Atualizar

Planos, vendedores e vendas

Method	Path	Permissão	Descrição
GET	/sales-plans	catalog.sales_plan.read	Listar planos
POST	/sales-plans	catalog.sales_plan.create	Criar
GET	/sales-plans/{id}	catalog.sales_plan.read	Detalhe
PATCH	/sales-plans/{id}	catalog.sales_plan.update	Atualizar
POST	/sales-plans/{id}/versions	catalog.sales_plan.create	Nova versão
DELETE	/sales-plans/{id}	catalog.sales_plan.update	Remover
GET	/sellers	catalog.seller.read	Listar vendedores
POST	/sellers	catalog.seller.create	Criar
PATCH	/sellers/{id}	catalog.seller.update	Atualizar
GET	/sales	commerce.sale.read	Listar vendas
POST	/sales	commerce.sale.create	Criar
GET	/sales/{id}	commerce.sale.read	Detalhe
PATCH	/sales/{id}	commerce.sale.update	Atualizar
POST	/sales/{id}/close-output	commerce.sale.update	Fechar saída
POST	/sales/{id}/generate-finance	commerce.sale.generate_finance	Gerar financeiro
POST	/sales/{id}/finalize	commerce.sale.finalize	Finalizar
POST	/sales/{id}/reopen	commerce.sale.reopen	Reabrir
POST	/sales/{id}/cancel	commerce.sale.cancel	Cancelar

Ver também

• Visão geral
• Wiki operador: 23-WIKI/cadastros/, 23-WIKI/comercial/

Referências