API de Contas a Pagar

Notas fiscais de entrada / contas a pagar

5 endpoints · base https://api.comando.one/v1 · autenticação por chave cmd_live_…

GET/purchase-invoices

Listar contas a pagar

purchase_invoices:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

`page`(query)	integer	Número da página (default: 1)
`per_page`(query)	integer	Itens por página (default: 20, máx: 100)
`status`(query)	"rascunho" \| "recebida" \| "aprovada" \| "cancelada"
`payment_status`(query)	"pendente" \| "parcial" \| "pago" \| "vencido"
`supplier_id`(query)	string (uuid)
`invoice_number`(query)	string
`due_date_from`(query)	string (date)
`due_date_to`(query)	string (date)
`overdue`(query)	"true" \| "false"	true = contas a pagar com parcela vencida e não paga. O vencimento mora nas parcelas, então o status agregado da fatura não responde isso.
`sort_by`(query)	"amount" \| "issue_date" \| "created_at" \| "updated_at" \| "invoice_number"	Coluna de ordenação. Use com sort_order para responder 'as maiores' ou 'as mais recentes'.
`sort_order`(query)	"asc" \| "desc"	Direção da ordenação. Padrão: desc quando sort_by é informado.

Resposta 200 — Listagem paginada

`id`	string (uuid)
`supplier_id`	string (uuid)
`status`	"rascunho" \| "recebida" \| "aprovada" \| "cancelada"
`payment_status`	"pendente" \| "parcial" \| "pago" \| "vencido"
`invoice_number`	string \| null
`amount`	number
`issue_date`	string \| null (date)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)
`purchase_invoice_charges`	array de object	Parcelas a pagar (o vencimento mora aqui, não na fatura).

Exemplo

curl -X GET "https://api.comando.one/v1/purchase-invoices" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

POST/purchase-invoices

Criar conta a pagar

purchase_invoices:create

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`supplier_id`obrigatório	string (uuid)
`status`	"rascunho" \| "recebida" \| "aprovada" \| "cancelada"
`payment_status`	"pendente" \| "parcial" \| "pago" \| "vencido"
`invoice_number`	string
`amount`	number
`issue_date`	string (date)
`due_date`	string (date)	Atalho: cria uma única parcela com este vencimento e o valor de 'amount'. Ignorado se 'charges' for informado.
`charges`	array de object	Parcelas a pagar. Cada uma exige 'due_date'.
`items`	array de object	Itens da fatura. Se omitido, o valor de 'amount' vira um item único — a fatura não pode ficar sem item (o formulário do app não salva assim).
`title`	string	Descrição da fatura; vira o nome do item quando 'items' não é informado.
`description`	string	Apelido de 'title' na hora de nomear o item único. Precedência: title > description > notes > invoice_number.
`digitable_line`	string	Atalho: grava o boleto na parcela única criada por 'due_date'.
`boleto_barcode`	string	Apelido de 'digitable_line' no nível raiz. Vale para as parcelas que não trouxerem o seu próprio.
`barcode`	string	Apelido de 'digitable_line'. Precedência: o da parcela > boleto_barcode > digitable_line > barcode.
`pix_key`	string	Atalho: grava a chave Pix na parcela única.
`pix_copia_e_cola`	string	Pix copia-e-cola no nível raiz. Vale para as parcelas que não trouxerem o seu próprio.
`pix_payload`	string	Apelido de 'pix_copia_e_cola'. Precedência: o da parcela > pix_copia_e_cola > pix_payload.
`notes`	string
`attachment_ids`	array de string (uuid)	Ids de anexos já enviados que devem ser vinculados à fatura criada. É o fluxo 'lance esse imposto e anexe o PDF' numa chamada só.

Resposta 201 — Conta a pagar criada

`id`	string (uuid)
`supplier_id`	string (uuid)
`status`	"rascunho" \| "recebida" \| "aprovada" \| "cancelada"
`payment_status`	"pendente" \| "parcial" \| "pago" \| "vencido"
`invoice_number`	string \| null
`amount`	number
`issue_date`	string \| null (date)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)
`purchase_invoice_charges`	array de object	Parcelas a pagar (o vencimento mora aqui, não na fatura).

Exemplo

curl -X POST "https://api.comando.one/v1/purchase-invoices" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"<string (uuid)>"}'

DELETE/purchase-invoices/{id}

Excluir conta a pagar

Exclusão definitiva. Recusa (409) contas com pagamento registrado ou parcela paga — nesses casos use o cancelamento, que preserva o histórico.

purchase_invoices:delete

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 204 — Excluída

Sem corpo.

Exemplo

curl -X DELETE "https://api.comando.one/v1/purchase-invoices/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

GET/purchase-invoices/{id}

Obter conta a pagar (com itens e parcelas)

purchase_invoices:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Conta a pagar

`id`	string (uuid)
`supplier_id`	string (uuid)
`status`	"rascunho" \| "recebida" \| "aprovada" \| "cancelada"
`payment_status`	"pendente" \| "parcial" \| "pago" \| "vencido"
`invoice_number`	string \| null
`amount`	number
`issue_date`	string \| null (date)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)
`purchase_invoice_charges`	array de object	Parcelas a pagar (o vencimento mora aqui, não na fatura).

Exemplo

curl -X GET "https://api.comando.one/v1/purchase-invoices/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

PATCH/purchase-invoices/{id}/cancel

Cancelar conta a pagar

purchase_invoices:cancel

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Cancelada

`id`	string (uuid)
`supplier_id`	string (uuid)
`status`	"rascunho" \| "recebida" \| "aprovada" \| "cancelada"
`payment_status`	"pendente" \| "parcial" \| "pago" \| "vencido"
`invoice_number`	string \| null
`amount`	number
`issue_date`	string \| null (date)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)
`purchase_invoice_charges`	array de object	Parcelas a pagar (o vencimento mora aqui, não na fatura).

Exemplo

curl -X PATCH "https://api.comando.one/v1/purchase-invoices/{id}/cancel" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

Início rápido, autenticação, SDK, servidor MCP e o playground para testar sem escrever código estão na documentação completa. A especificação em OpenAPI está em api.comando.one/openapi.json.

Outros recursos da API

Clientes (16)Contratos (13)Faturas (12)Webhooks (12)Serviços (9)Split de Pagamentos (9)Catálogos (7)Propostas (6)

Ou deixe a IA usar a API por você

O servidor MCP expõe estes mesmos recursos ao ChatGPT, Claude ou Gemini — com OAuth, sem chave de API.

Conectar um assistente