Faturas

O documento a cobrar, do rascunho ao pago. finalize sela o rascunho, pay registra a liquidação, void anula, e as parcelas vivem em installments.

Comando	HTTP	Descrição
invoices list	GET /v1/invoices	Listar faturas
invoices create	POST /v1/invoices	Criar fatura
invoices get	GET /v1/invoices/{id}	Obter fatura
invoices update	PATCH /v1/invoices/{id}	Atualizar fatura
invoices delete	DELETE /v1/invoices/{id}	Excluir fatura
invoices apply-credits	POST /v1/invoices/{id}/apply-credits	Aplicar créditos na fatura
invoices finalize	POST /v1/invoices/{id}/finalize	Finalizar fatura
invoices issue-nfe	POST /v1/invoices/{id}/issue-nfe	Emitir NFe para fatura
invoices pay	POST /v1/invoices/{id}/pay	Pagar fatura
invoices payment-methods	GET /v1/invoices/{id}/payment-methods	Listar métodos de pagamento disponíveis
invoices pdf	GET /v1/invoices/{id}/pdf	Baixar PDF da fatura
invoices remove-credits	POST /v1/invoices/{id}/remove-credits	Remover créditos aplicados
invoices send-reminder	POST /v1/invoices/{id}/send-reminder	Enviar lembrete de cobrança
invoices undo-payment	POST /v1/invoices/{id}/undo-payment	Desfazer pagamento da fatura
invoices void	POST /v1/invoices/{id}/void	Cancelar (void) fatura
invoices installments get	GET /v1/invoices/{id}/installments	Listar parcelas da fatura
invoices installments create	POST /v1/invoices/{id}/installments	Criar/atualizar parcelamento
invoices installments mark-paid	POST /v1/invoices/{id}/installments/{installmentId}/mark-paid	Marcar parcela como paga
invoices installments pay	POST /v1/invoices/{id}/installments/{installmentId}/pay	Pagar parcela
invoices pending-nfe list	GET /v1/invoices/pending-nfe	Listar faturas com NFe pendente
invoices pending-payment list	GET /v1/invoices/pending-payment	Listar faturas com pagamento pendente

Exemplos

--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Listar faturas
kobana billing invoices list \
  --fields "id,public_id,external_id,number,billing_account_id"

# Obter fatura
kobana billing invoices get --params '{"id": "INVOICE_ID"}'

# Criar fatura
kobana billing invoices create \
  --json '{"billing_account_id": "BILLING_ACCOUNT_ID", "line_items": []}'

# Atualizar fatura
kobana billing invoices update \
  --params '{"id": "INVOICE_ID"}' \
  --json '{"external_id": "EXTERNAL_ID", "company_id": "COMPANY_ID", "collection_method": "charge_automatically"}'

# Aplicar créditos na fatura
kobana billing invoices apply-credits \
  --params '{"id": "INVOICE_ID"}' \
  --json '{"credit_ids": []}'

# Excluir fatura
kobana billing invoices delete --params '{"id": "INVOICE_ID"}' --dry-run

Próximos passos

• Pagamentos
• Introspecção de schema — todos os parâmetros que este recurso aceita.