Operações (playground)

Emitir nota

POST
/invoices

Emite pela mesma regra do painel. Campos vazios vêm do modelo: amount usa o valor padrão, competence usa hoje e description usa a do modelo com {mes} e {ano} resolvidos.

Repetir a mesma idempotency_key devolve a nota já criada (200), sem emitir outra.

Autorização

bearer
headerAutorizaçãoBearer <token>

Token gerado no painel (Integrações → Tokens de API), começa com nf_

Corpo da requisição

application/json
  1. body
idempotency_key*string

id estável do seu sistema (ex.: o id da fatura); repetir nunca emite outra nota

customer_id*integer

GET /customers

template_id*integer

GET /templates

amount?string

1500.00 ou 1.500,00; vazio usa o valor do modelo

competence?string

AAAA-MM-DD; vazio usa hoje

Formatodate
description?string

vazio usa a do modelo, com {mes} e {ano} resolvidos

confirm_production?boolean

obrigatório true com o emitente em produção

Padrãofalse

Corpo da resposta

A idempotency_key já tinha nota: devolve a mesma, nada foi emitido

application/json
  1. response
id*integer
idempotency_key?string
status*InvoiceStatus
Value in"pending""authorized""rejected""cancelled"
status_label*string
environment*Environment
Value in"homologation""production"
dps_series*string
dps_number*integer
nfse_number?string

número da NFS-e (autorizada)

access_key?string

chave de acesso de 50 dígitos (autorizada)

amount*string

ponto decimal, duas casas

competence?string
Formatodate
issued_at?string
Formatodate-time
customer_id*integer
template_id*integer
description*string
error_code?string

código da SEFIN (rejeitada)

message?string

erro da SEFIN traduzido, ou aviso de resposta pendente

Exemplo de requisição
curl -X POST 'https://nfse.bassi.engineer/api/v1/invoices' \  -H 'Content-Type: application/json' \  -d '{  "idempotency_key": "fatura-2026-11-0042",  "customer_id": 1,  "template_id": 1,  "amount": "1500.00",  "competence": "2026-11-01",  "description": "Suporte técnico - novembro"}'
Exemplo de resposta
{  "id": 0,  "idempotency_key": "string",  "status": "pending",  "status_label": "string",  "environment": "homologation",  "dps_series": "string",  "dps_number": 0,  "nfse_number": "string",  "access_key": "string",  "amount": "string",  "competence": "2019-08-24",  "issued_at": "2019-08-24T14:15:22Z",  "customer_id": 0,  "template_id": 0,  "description": "string",  "error_code": "string",  "message": "string"}