Referência de comandos¶

Todos os comandos do ca, agrupados pelo endpoint que consomem.

Cada endpoint traz uma marca de confiança:

✅ verificado — exercitado contra a API real e respondeu como documentado.
⚠️ não verificado — escrito a partir da documentação e nunca exercitado. Não leia como "provavelmente certo": leia como não confiável.

O que ⚠️ realmente significa

A marca não quer dizer só "a escrita nunca foi disparada". Ela quer dizer não confiável em todos os eixos: path, nome de filtro, nome de campo do payload, tipo do id e formato da resposta. Os filtros listados numa seção ⚠️ saíram da documentação, não de uma chamada real.

Isso não é pessimismo de ofício: a campanha de verificação exercitou os nove grupos do CLI contra a produção e todos tinham pelo menos um defeito — filtros que devolviam a coleção inteira fingindo filtrar, campos obrigatórios que a documentação não lista, um comando apontado para o endpoint errado, e um caso que passava em qualquer teste razoável. O apanhado está em Notas para quem for estender, e é leitura obrigatória antes de mexer em qualquer integração.

Esta página é gerada

A tabela sai das definições do Symfony Console, então ela não pode divergir do que o CLI realmente aceita. A prosa de cada grupo é curada em docs/_data/commands/. Convenção de leitura: obrig. marca o que falha sem valor; padrão é o que o CLI assume quando você omite.

Comando	Endpoint
`config path`	`— (local)`	✅
`config init`	`— (local)`	✅
`config set`	`— (local)`	✅
`config show`	`— (local)`	✅
`auth login`	`— (local)`	✅
`auth logout`	`— (local)`	✅
`categoria list`	`GET /v1/categorias`	✅
`categoria configuracao-padrao`	`GET /v1/categorias/configuracao-padrao`	✅
`categoria dre`	`GET /v1/financeiro/categorias-dre`	✅
`centro-de-custo list`	`GET /v1/centro-de-custo`	✅
`centro-de-custo create`	`POST /v1/centro-de-custo`	✅
`conta-financeira list`	`GET /v1/conta-financeira`	✅
`conta-financeira saldo`	`GET /v1/conta-financeira/{id}/saldo-atual`	✅
`transferencia list`	`GET /v1/financeiro/transferencias`	✅
`conta-a-receber list`	`GET /v1/financeiro/eventos-financeiros/contas-a-receber/buscar`	✅
`conta-a-receber create`	`POST /v1/financeiro/eventos-financeiros/contas-a-receber`	✅
`cobranca create`	`POST /v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca`	✅
`cobranca get`	`GET /v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id}`	✅
`cobranca delete`	`DELETE /v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id}`	✅
`conta-a-pagar list`	`GET /v1/financeiro/eventos-financeiros/contas-a-pagar/buscar`	✅
`conta-a-pagar create`	`POST /v1/financeiro/eventos-financeiros/contas-a-pagar`	✅
`parcela get`	`GET /v1/financeiro/eventos-financeiros/parcelas/{id}`	✅
`parcela update`	`PATCH /v1/financeiro/eventos-financeiros/parcelas/{id}`	✅
`parcela baixar`	`POST /v1/financeiro/eventos-financeiros/parcelas/{id}/baixa`	✅
`parcela list`	`GET /v1/financeiro/eventos-financeiros/{id_evento}/parcelas`	✅
`baixa create`	`POST /v1/financeiro/eventos-financeiros/parcelas/{id}/baixa`	✅
`baixa list`	`GET /v1/financeiro/eventos-financeiros/parcelas/{id}/baixa`	✅
`baixa get`	`GET /v1/financeiro/eventos-financeiros/parcelas/baixa/{id}`	✅
`baixa update`	`PATCH /v1/financeiro/eventos-financeiros/parcelas/baixa/{id}`	✅
`baixa delete`	`DELETE /v1/financeiro/eventos-financeiros/parcelas/baixa/{id}`	✅
`financeiro alteracoes`	`GET /v1/financeiro/eventos-financeiros/alteracoes`	✅
`financeiro saldo-inicial`	`GET /v1/financeiro/eventos-financeiros/saldo-inicial`	✅
`protocolo get`	`GET /v1/protocolo/{id}`	✅
`contrato list`	`GET /v1/contratos`	✅
`contrato create`	`POST /v1/contratos`	✅
`contrato proximo-numero`	`GET /v1/contratos/proximo-numero`	✅
`contrato get`	`GET /v1/contratos/{id}`	✅
`contrato delete`	`DELETE /v1/contratos/{id}`	✅
`contrato encerrar`	`POST /v1/contratos/{id}/encerrar`	✅
`pessoa list`	`GET /v1/pessoas`	✅
`pessoa create`	`POST /v1/pessoas`	✅
`pessoa get`	`GET /v1/pessoas/{id}`	✅
`pessoa legado`	`GET /v1/pessoas/legado/{id}`	✅
`pessoa update`	`PUT /v1/pessoas/{id}`	✅
`pessoa patch`	`PATCH /v1/pessoas/{id}`	✅
`pessoa ativar`	`POST /v1/pessoas/ativar`	✅
`pessoa inativar`	`POST /v1/pessoas/inativar`	✅
`pessoa excluir`	`POST /v1/pessoas/excluir`	✅
`pessoa conta-conectada`	`GET /v1/pessoas/conta-conectada`	✅
`produto list`	`GET /v1/produtos`	✅
`produto create`	`POST /v1/produtos`	✅
`produto get`	`GET /v1/produtos/{id}`	✅
`produto delete`	`DELETE /v1/produtos/{id}`	✅
`produto update`	`PATCH /v1/produtos/{id}`	✅
`produto categorias`	`GET /v1/produtos/categorias`	✅
`produto cest`	`GET /v1/produtos/cest`	✅
`produto ncm`	`GET /v1/produtos/ncm`	✅
`produto unidades-medida`	`GET /v1/produtos/unidades-medida`	✅
`produto ecommerce-marcas`	`GET /v1/produtos/ecommerce-marcas`	✅
`produto ecommerce-categorias`	`GET /v1/produtos/ecommerce-categorias`	⚠️
`servico list`	`GET /v1/servicos`	✅
`servico create`	`POST /v1/servicos`	✅
`servico get`	`GET /v1/servicos/{id}`	✅
`servico update`	`PATCH /v1/servicos/{id}`	✅
`servico delete`	`DELETE /v1/servicos`	✅
`nota-fiscal list`	`GET /v1/notas-fiscais`	✅
`nota-fiscal get`	`GET /v1/notas-fiscais/{chave}`	✅
`nota-fiscal vincular-mdfe`	`POST /v1/notas-fiscais/vinculo-mdfe`	✅
`nota-fiscal-servico list`	`GET /v1/notas-fiscais-servico`	✅
`venda list`	`GET /v1/venda/busca`	✅
`venda create`	`POST /v1/venda`	✅
`venda get`	`GET /v1/venda/{id}`	✅
`venda update`	`PUT /v1/venda/{id}`	✅
`venda imprimir`	`GET /v1/venda/{id}/imprimir`	✅
`venda itens`	`GET /v1/venda/{id_venda}/itens`	✅
`venda vendedores`	`GET /v1/venda/vendedores`	✅
`venda proximo-numero`	`GET /v1/venda/proximo-numero`	✅
`venda excluir-lote`	`POST /v1/venda/exclusao-lote`	✅
`orcamento list`	`GET /v1/orcamentos`	✅
`orcamento create`	`POST /v1/orcamentos`	✅
`orcamento get`	`GET /v1/orcamentos/{id}`	✅
`orcamento excluir-lote`	`DELETE /v1/orcamentos`	✅
`captura enviar`	`POST /v1/captura/documentos`	✅
`captura status`	`GET /v1/captura/documentos/status`	✅
`captura get`	`GET /v1/captura/{id}`	✅
`captura aceitar`	`POST /v1/captura/{id}`	✅
`captura recusar`	`DELETE /v1/captura/{id}`	✅