Emitir

Quando uma NFS-e é enviada para processamento, é realizada uma pré-validação, caso ocorra algum problema como: ausência de campos essenciais, formato de dados incorreto ou problemas com o cadastro do prestador em nossa base, a nota não será aceita e você receberá uma mensagem de erro de forma síncrona.

Caso a nota seja aceita para processamento, ela será enviada para uma fila e será processada de forma assíncrona. Com isto, a nota poderá ser autorizada ou retornar um erro, de acordo com a validação da prefeitura.

Para verificar se a nota já foi autorizada, você terá que efetuar uma consulta ou se utilizar de webhooks (gatilhos).

Reforma Tributária

  • Abaixo, campos novos da API de NFSe são denotados com (RT) e destacados em itálico. Durante a transição, alguns municípios podem não aceitar ou não interpretar estes campos.
  • Muitos municípios estão migrando para o novo padrão da API de NFSe Nacional, verifique em nosso Guia da Reforma Tributária.

ATENÇÃO Alguns municípios podem ter campos adicionais ou regras específicas para preenchimento de campos. Estas exceções tem se mostrado frequentes em função da Reforma Tributária. Consulte nossa lista de Municípios Integrados para orientações sobre especificidades de seu município.

Abaixo você poderá verificar uma listagem dos principais campos disponíveis.

Query Params
string
required

Referência da NFSe

Body Params
date-time
required

Data/hora de emissão da NFSe. Alguns municípios não utilizam hora e ela será descartada caso seja fornecida. Formato padrão ISO 8601.

string
enum
required

Natureza da operação. Informar um dos códigos abaixo. Valor padrão: 1. Campo ignorado em alguns municípios.
1: Tributação no município
2: Tributação fora do município
3: Isenção
4: Imune
5: Exigibilidade suspensa por decisão judicial
6: Exigibilidade suspensa por procedimento administrativo

Allowed:
string
enum

Código do regime especial de tributação. Campo ignorado em alguns municípios
1: Microempresa municipal
2: Estimativa
3: Sociedade de profissionais
4: Cooperativa
5: MEI - Simples Nacional
6: ME EPP- Simples Nacional

Allowed:
boolean
required

Informar true (verdadeiro) ou false (falso) se a empresa for optante pelo Simples Nacional. Campo ignorado em alguns municípios.

boolean

Informe true (verdadeiro) ou false (falso). Valor padrão: false. Campo ignorado em alguns municípios.

prestador
object
required
tomador
object
required
servico
object
required
intermediario
object

Esta seção é ignorada se não suportada pelo município.

string
length ≤ 15

Código da obra quando construção civil. Tamanho máximo: 15 caracteres.

string

Código ART quando construção civil. Este campo é ignorado em alguns municípios.

string

Caso o município permita substituição de notas, aqui você poderá informar o número da NFSe a ser substituída.

string

Caso o município permita substituição de notas, aqui você poderá informar o número do RPS a ser substituído.

string

Obrigatório se informado o campo numero_rps_substituido. Indica a série do RPS a ser substituído.

string

Obrigatório se informado o campo numero_rps_substituido. Indica o tipo do RPS a ser substituído. Caso desconheça este valor, utilize "1".

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html