NFS-e eventos JSON — referência de campos
NFS-e eventos JSON — referência de campos
Documento de referência — Dicionário campo a campo da representação JSON de um evento NFS-e obtido após decodificação do campo
b64(Base64 + Gzip).
Convenções deste documento
- Campos nulos ou ausentes no XML de origem são omitidos do JSON.
- Datas seguem o formato UTC
AAAA-MM-DDThh:mm:ssTZDsalvo quando indicado. - O campo
eventodentro deinfPedRegpossui estrutura dinâmica — os campos variam conforme o tipo de evento (tpEvento). Consulte o documento de tipos de eventos para detalhes.
1. Raiz — NfseEventJsonDTO
| Campo | Descrição |
|---|---|
versao | Versão do schema do evento NFS-e (ex.: "1.00", "1.01"). Extraído do atributo versao do elemento raiz <evento>. |
infEvento | Grupo de informações do evento processado. Ver seção 2. |
2. Informações do evento — infEvento
| Campo | Descrição |
|---|---|
infEvento.id | Identificador único do evento processado (atributo Id do elemento <infEvento> no XML). |
infEvento.verAplic | Versão do aplicativo que gerou o evento. |
infEvento.ambGer | Ambiente de geração: "1" = Sistema próprio do município; "2" = Sefin Nacional NFS-e; "3" = ADN NFS-e. |
infEvento.nSeqEvento | Número sequencial do evento para o mesmo tipo de evento. Para eventos que ocorrem somente uma vez (ex.: cancelamento), o valor é "001". |
infEvento.dhProc | Data/hora do registro do evento (UTC, ISO 8601). |
infEvento.nDFe | Número sequencial do documento gerado pelo ambiente de geração de DFS-e do município. |
infEvento.pedRegEvento | Pedido de registro do evento. Ver seção 3. |
3. Pedido de registro — infEvento.pedRegEvento
| Campo | Descrição |
|---|---|
pedRegEvento.versao | Versão do schema do pedido de registro (atributo versao do elemento <pedRegEvento>). |
pedRegEvento.infPedReg | Informações do pedido de registro. Ver seção 4. |
4. Informações do pedido de registro — infPedReg
| Campo | Descrição |
|---|---|
infPedReg.id | Identificador único do pedido de registro (atributo Id do elemento <infPedReg> no XML). |
infPedReg.tpAmb | Tipo de ambiente: "1" = Produção; "2" = Homologação. |
infPedReg.verAplic | Versão do aplicativo que gerou o pedido de registro de evento. |
infPedReg.dhEvento | Data/hora do evento (UTC, ISO 8601). |
infPedReg.CNPJAutor | CNPJ do autor do evento (14 dígitos, sem formatação). Parte interessada ou pessoa que figura na NFS-e. |
infPedReg.chNFSe | Chave de acesso da NFS-e à qual o evento está vinculado. |
infPedReg.nPedRegEvento | Número do pedido de registro do evento. |
infPedReg.evento | Mapa (Map<String, String>) com os dados específicos do tipo de evento. O campo tpEvento está sempre presente e indica o tipo. Os demais campos variam conforme o tipo de evento. Consulte o documento de tipos de eventos NFS-e para a descrição dos campos de cada tipo. |
5. Exemplo
{
"versao": "1.01",
"infEvento": {
"id": "EVT31062002247979038000111000000000004925102970368024101101001",
"verAplic": "SVRS202501",
"ambGer": "2",
"nSeqEvento": "001",
"dhProc": "2024-11-04T13:16:25-03:00",
"pedRegEvento": {
"versao": "1.01",
"infPedReg": {
"id": "PEDIDO31062002247979038000111000000000004925102970368024101101001",
"tpAmb": "1",
"verAplic": "APP_CONTRIB_1.0",
"dhEvento": "2024-11-04T13:16:25-03:00",
"CNPJAutor": "47979038000111",
"chNFSe": "31062002247979038000111000000000004925102970368024",
"nPedRegEvento": "001",
"evento": {
"tpEvento": "101101",
"xDesc": "Cancelamento de NFS-e",
"cMotivo": "2",
"xMotivo": "Serviço não prestado"
}
}
}
}
}