Notas fiscais
A emissão fiscal de uma fatura: emitir, cancelar, baixar PDF e XML, e acompanhar cada tentativa junto à prefeitura. Barueri tem comandos próprios.
| Comando | HTTP | Descrição |
|---|---|---|
nfes list | GET /v1/nfes | Listar NFes |
nfes create | POST /v1/nfes | Criar NFe (rascunho) |
nfes get | GET /v1/nfes/{id} | Obter NFe |
nfes update | PATCH /v1/nfes/{id} | Atualizar NFe (rascunho) |
nfes delete | DELETE /v1/nfes/{id} | Excluir NFe |
nfes cancel | POST /v1/nfes/{id}/cancel | Cancelar NFe |
nfes issue | POST /v1/nfes/{id}/issue | Emitir NFe |
nfes pdf | GET /v1/nfes/{id}/pdf | Baixar PDF da NFe |
nfes retry-cancel | POST /v1/nfes/{id}/retry-cancel | Retentar cancelamento da NFe |
nfes validate-barueri | POST /v1/nfes/{id}/validate-barueri | Validar NFS-e Barueri |
nfes xml | GET /v1/nfes/{id}/xml | Baixar XML da NFe |
nfes bulk create | POST /v1/nfes/bulk | Atualizar NFes em lote |
nfes bulk-delete create | POST /v1/nfes/bulk-delete | Excluir NFes em lote |
nfes fetch-barueri create | POST /v1/nfes/fetch-barueri | Buscar NFS-e em Barueri |
nfes fetch-from-sefaz create | POST /v1/nfes/fetch-from-sefaz | Buscar NFS-e no ADN (SEFAZ) |
nfes import-barueri create | POST /v1/nfes/import-barueri | Importar NFS-e Barueri |
nfes request-tries list | GET /v1/nfes/request-tries | Listar tentativas de requisição (organização) |
nfes request-tries get | GET /v1/nfes/{id}/request-tries | Listar tentativas de requisição da NFe |
nfes requests get | GET /v1/nfes/{id}/requests/{requestId} | Obter requisição externa |
nfes sync create | POST /v1/nfes/sync | Sincronizar NFes da organização |
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 NFes
kobana billing nfes list \
--fields "id,public_id,external_id,invoice_id,transaction_id"
# Obter NFe
kobana billing nfes get --params '{"id": "NFE_ID"}'
# Criar NFe (rascunho)
kobana billing nfes create \
--json '{"billing_account_id": "BILLING_ACCOUNT_ID", "amount_cents": 100, "customer": {}}'
# Atualizar NFe (rascunho)
kobana billing nfes update \
--params '{"id": "NFE_ID"}' \
--json '{"external_id": "EXTERNAL_ID", "service_code": "SERVICE_CODE", "service_description": "SERVICE_DESCRIPTION"}'
# Cancelar NFe
kobana billing nfes cancel \
--params '{"id": "NFE_ID"}' \
--json '{"reason": "REASON"}'
# Excluir NFe
kobana billing nfes delete --params '{"id": "NFE_ID"}' --dry-run
Próximos passos
- Regras de imposto
- Introspecção de schema — todos os parâmetros que este recurso aceita.