Produto

API de NFS-e.

A nota fiscal de serviço sai do seu sistema em JSON. A tradução para o layout da prefeitura, ou para o padrão nacional do município, fica do lado da API.

Emitir

POST /nfse recebe a referência, o prestador, o tomador e o serviço. Se a referência já existir, a API devolve a mesma nota.

Consultar

GET /nfse/{referencia} mostra o status: processando, autorizado, rejeitado ou cancelado.

Cancelar

DELETE /nfse/{referencia} envia a justificativa. O status passa a cancelado quando a prefeitura aceita.

Baixar

Com status autorizado, GET .../pdf e GET .../xml entregam o DANFSE e o arquivo autorizado.

Corpo da nota

O que vai no JSON.

A referência é sua. O prestador identifica quem emite. O tomador é o contratante do serviço. O bloco de serviço leva a discriminação, o item da lista, o código municipal, a alíquota e o valor.

ISS retido, quando houver, vai no próprio serviço. A API não escolhe a tributação: ela envia o que estiver no pedido e devolve o erro da prefeitura se o município recusar.

Ver a tabela de campos

Ambientes

Homologação. A nota não tem valor fiscal. Serve para validar o JSON, o certificado e o retorno do município.

Produção. Usa outra chave. A autorização segue a regra da prefeitura do prestador.

O certificado aceito neste fluxo é o A1, em arquivo.

Status

Do envio até o arquivo.

  1. processando — a prefeitura ainda não devolveu o resultado.
  2. autorizado — número, código de verificação, PDF e XML estão disponíveis.
  3. rejeitado — a mensagem da prefeitura volta no JSON da consulta.
  4. cancelado — o cancelamento foi aceito.

Aviso

Webhook ou consulta.

Cadastre uma URL para receber nfse.autorizada, nfse.rejeitada e nfse.cancelada. Se preferir, consulte a referência até o status sair de processando.

Ver o payload do webhook

A chave de teste libera o primeiro POST.

O cadastro pede o CNPJ do prestador e o certificado A1. A documentação prática da rota está em um só lugar.

Ver autenticação