Pular para o conteúdo principal

Processo Emissão NF-e

Informações Gerais

Esta página descreve o fluxo técnico completo para emissão de NF‑e no Emissor Fiscal.

Além das operações tradicionais de emissão, este fluxo também suporta os cálculos dos novos tributos da Reforma Tributária. Nesse modelo, a automação pode enviar apenas os parâmetros essenciais, enquanto o Emissor Fiscal realiza os cálculos e completa o JSON final automaticamente.

Essa funcionalidade está disponível para clientes que contratam o Produto Emissor Fiscal e não exige nenhuma integração adicional.

Informações importantes:

  • Este endpoint contempla as diferentes finalidades da emissão de uma NF-e.
  • É possível realizar integração para emissão via json e via XML
  • Todas as tags contempladas no json de emissão estão disponíveis aqui: Tags
  • Os endpoints foram estruturados para refletir, sempre que possível, as tags definidas no Manual de Orientação do Contribuinte (MOC)
  • As particularidades são tratadas no tópico Campos Emissor Fiscal x Campos MOC desta documentação

Jornada de Emissão:


Ambientes


Campos Emissor Fiscal x Campos MOC

Tags exclusivas do Emissor Fiscal

Campo Emissor FiscalCampo MOC
NFrefListNFref
TIPOIDCONSdest
IDCONSCPF, CNPJ ou idEstrangeiro
ItemNFCeListdet
NVEXMLListNVE
DIListDI
detExportListdetExport
veicProdveicProd
RastroListrastro
ArmaListarma
Grupo_IIII
itemICMSPartICMSPart
itemICMSSTICMSST
obsItemobsItem (NT NT2021.004v1.20)
dadosRetTransptransp
dadosVeicTransptransp
reboqueListtransp
volListtransp
dadosFatcobr
dupListcobr
PagNFCeListpag
infIntermedinfIntermed
obsContListinfAdic
obsFiscoListinfAdic
procRefListinfAdic (NT 2021.004)

Layout SEFAZ para estruturação de NF-e está disponível no link:
Portal da Nota Fiscal Eletronica


Parâmetros de Emissão

Os parâmetros de envio comum ao processo de emissão com Json e XML são:

CampoDescriçãoConteúdo / ObservaçãoObrigatório
tpDANFETipo de Danfe a ser retornado1 = Retrato (Padrão)
3 = Resumido
5 = Simplificado
6 = Simplificado SC
7 = Etiqueta
Sim
tpImpTipo da Impressão. Deve ser informado de acordo com o tpDANFE indicado1 = tpDanfe 1 (Retrato)
2 = tpDanfe 8 (Paisagem)
3 = tpDanfe 5 (Simplificado)
Não
ExtensaoDanfeExtensão do arquivo DANFE que será retornado1= pdf (Default)
2= png
Não

Emissão NF-e - Json

  • Endpoint Client 2.0: /NFe/AutorizaJSON
  • Endpoint Client em Nuvem: /nfehubsender/Sale/Send
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Exemplo de payload de Envio

{
"natOp": "VENDA DE MERCADORIA CONFORME CFOP",
"versao": "4.00",
"serie": "365",
"nNF": 810220,
"dhEmi": "2026-02-23T15:12:00-03:00",
"tpImp": 1,
"tpEmis": 1,
"finNFe": 1,
"CNPJ": "54111111001111",
"vBC": 0,
"vICMS": 0,
"vProd": 250,
"vDesc": 10,
"vOutro": 0,
"vNF": 240,
"vTotTrib": 45,
"infCpl": "OBJETO DE ENTRADA PARA OBSERVACAO ** EXCLUSIVA DO CLIENTE",
"TIPOIDCONS": "1",
"IDCONS": "31507041111",
"xLgr": "Rua Olavo Barreto Viana",
"nro": 63,
"xBairro": "Centro",
"xMun": "Porto Alegre",
"xPais": "Brasil",
"CEP": "90570070",
"cMun": 4314902,
"cPais": 1058,
"UF": "RS",
"vIPI": 0,
"vPIS": 4.12,
"vCOFINS": 19,
"vServ": 0,
"vBCServ": 0,
"vISS": 0,
"vPISServ": 0,
"vCOFINSServ": 0,
"vICMSDeson": 0,
"xNome": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
"cMunEntrega": 0,
"cMunFGIBS": "4314902",
"ItemNFCeList": [
{
"nItem": 1,
"cProd": "01.01.0002",
"xProd": "NOTA FISCAL EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
"cEAN": 7909620614143,
"NCM": 62041900,
"CFOP": 5101,
"uCom": "PC",
"qCom": 1,
"vUnCom": 250,
"vProd": 250,
"vDesc": 10,
"vOutro": 0,
"orig": 0,
"modBC": 3,
"vBC": 0,
"pICMS": 0,
"vICMS": 0,
"CST_CSOSN": 40,
"cMunFG": 0,
"cListServ": 0,
"qSelo": 0,
"CST_PIS": "01",
"vBC_PIS": 250,
"pPIS": 1.65,
"vPIS": 4.12,
"qBCProd_PIS": null,
"vAliqProd_PIS": null,
"CST_COF": "01",
"vBC_COF": 250,
"pCOFINS": 7.6,
"vCOFINS": 19,
"infAdProd": "Informação adicional do produto para validação",
"vICMSDeson": null,
"motDesICMS": null,
"indDeduzDeson": null,
"vTotTrib": 45,
"vItem": 250,
"IBSCBS": {
"CST": "000",
"cClassTrib": "000001",
"gIBSCBS": {
"vBC": "216.88",
"vIBS": "0.22",
"gIBSUF": {
"pIBSUF": "0.1000",
"vIBSUF": "0.22"
},
"gIBSMun": {
"pIBSMun": "0.0000",
"vIBSMun": "0.00"
},
"gCBS": {
"pCBS": "0.9000",
"vCBS": "1.95"
}
}
}
}
],
"IBSCBSTot": {
"vBCIBSCBS": "216.88",
"gIBS": {
"gIBSUF": {
"vDif": "0.00",
"vDevTrib": "0.00",
"vIBSUF": "0.22"
},
"gIBSMun": {
"vDif": "0.00",
"vDevTrib": "0.00",
"vIBSMun": "0.00"
},
"vIBS": "0.22",
"vCredPres": "0.00",
"vCredPresCondSus": "0.00"
},
"gCBS": {
"vDif": "0.00",
"vDevTrib": "0.00",
"vCBS": "1.95",
"vCredPres": "0.00",
"vCredPresCondSus": "0.00"
}
},
"vNFTot": "216.88",
"PagNFCeList": [
{
"indPag": 1,
"tPag": 17,
"vPag": 40,
"dPag": "2025-03-24",
"CNPJPag": "54517628001593",
"UFPag": "RS",
"CardNFCeList": [
{
"tpIntegra": 2,
"CNPJReceb": "54517628001593",
"idTermPag": 1,
"cAut": "1234568asdasd11235"
}
]
},
{
"tPag": 1,
"vPag": 200
}
],
"DadosFat": {
"nFat": 1,
"VDesc": 0,
"VLiq": 240,
"VOrig": 240
},
"devolveXML": true,
"geraDanfe": true,
"tpDanfe": 3
}

O retorno da API poderá ser o documento autorizado ou a rejeição do documento. Segue o detalhamento dos parâmetros retornados:

  • chNFe: Chave da nota fiscal
  • cStat: Status vinculado ao documento. Os possíveis status serão detalhados em tópico específico.
  • xMotivo: Descrição do status do documento
  • danfe: DANFE em PNG. Deverá decodificar de Base64
  • nNF: Número do documento fiscal
  • xUrlDanfe: URL de consulta do documento fiscal na Sefaz

Exemplo de Payload de Retorno:

{
"TimeProcessing": "00:00:06.5724709",
"TimeCommunication": "00:00:05.4445199",
"TimeDanfe": "00:00:01.0976903",
"BdCorrompido": false,
"Central_Contingencia": false,
"chNFe": "42260111152133001111113650000000051025173073",
"cStat": "100",
"Danfe": "Danfe em base 64",
"DataAlteracao": "2026-02-26T09:00:17.11",
"DesvioConsumoIndevido": false,
"dhRetorno": "2026-02-26T10:52:33-03:00",
"ExcessoList": [],
"IndicaPDVAutorizacao": "A",
"IndicaPDVCancInut": "A",
"IndicaPDVConsulta": "A",
"IsCacheable": false,
"nProt": "342260000152565",
"RetornoIntegradorList": [],
"Usuario_Senha_Invalido": false,
"XmlCompactado": "XML em base64 e compactado em gzip",
"xMotivo": "Autorizado o uso da NF-e"
}

Detalhamento campo cStat

Neste campo poderão haver retornos de status da SEFAZ e do Emissor Fiscal, conforme segue:

Retornos da SEFAZ

  • Autorização:

    • 100 – Autorizado
  • Rejeições:

    • Consultar todos os códigos de rejeição vinculados a emissão de documento no manual de orientação ao contribuinte (MOC – Anexo I) disponível no item “4.4.2. Tabela de Códigos de Rejeição”.

Retornos do Emissor Fiscal

Consultar retornos utilizando a API ListaCodigoStatusSefaz documentada em: APIs Auxiliares

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha na Solução Fiscal ou rejeição pela Sefaz
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Emissão NF-e - XML

Para realizar emissão enviando o XML é necessário:

  • Colocar as barras de escape para aspas duplas.
  • Enviar XML no layout SEFAZ na tag "xml".
  • Utilizar o Endpoint Client 2.0: /NFe/Autoriza

Exemplo de Payload de Envio:

{
"xml": "XML no layout Sefaz com as barras de escape nas aspas duplas",
"GeraDanfe": true,
"DevolveXml": true,
"tpDanfe": 0,
"XmlAssinado": false,
"ExtensaoDanfe": 1
}

⚠️ Importante:

Embora seja possível emitir NF‑e por meio do envio do XML no layout SEFAZ, recomenda-se priorizar a emissão via JSON sempre que possível.

A emissão via JSON facilita a adaptação a mudanças legais e reduz o esforço de manutenção da automação integradora.


Consulta NF-e

  • Endpoint Client 2.0: /NFe/Consulta
  • Endpoint Client em Nuvem: hubservices/NFe/Sale/Search
  • Método: GET
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/jsoN
  • Parâmetros:
    • nNF: Número do documento
    • Série: Série do documento
    • Cnpj = CNPJ do Emissor
    • GeraDanfe = true|false. Define retorno da DANFE
    • TpDanfe = = Tipo de DANFE
      • Retrato= 1 (Padrão)
      • Resumido = 3
      • Simplificado = 5
      • Simplificado SC = 6
      • Etiqueta = 7
      • Paisagem = 8
    • DevolveXML: true/false. (Define retorno do XML)

Exemplo Payload Envio:

{
"nNF": 53602,
"serie": 365,
"CNPJ": "11111111111111",
"tpDanfe": 2,
"DevolveXml": "true",
"GeraDanfe": "true"
}

Exemplo Payload Retorno:

{
"ID": "",
"chNFe": "35190754517628000111111090000001111111111119",
"dhRetorno": "2025-07-01T10:36:45-03:00",
"nProt": "13519000xxxxxx95",
"cStat": "100",
"xMotivo": "Autorizado o uso da NF-e",
"xUrlDanfe": null,
"Danfe": "AvCBSCi9Db250ZW50cyA2GvPocAzVtZRFCf/fzsQvk+H0R2mC7pQL1b36=",
"XmlCompactado": "H4sIAAAAAAMJb2H6P22t0XwH0e2JP6BH1/Jlp9h8Z3APEcBoAAA==",
"DanfeHTML": null,
"mensagemSEFAZ": null,
"UltimoDocumento": null,
"CCCC": null,
"cod": null,
"numeroSessao": null,
"xURLDanfeAutorizacao": null,
"Arquivo_Danfe": null,
"Arquivo_XML": null,
"DataAlteracao": "2025-06-28T16:54:28.267",
"Central_Contingencia": null,
"IndicaPDVAutorizacao": "A",
"IndicaPDVCancInut": "A",
"IndicaPDVConsulta": "A",
"URL_Consulta": null,
"Consultou_Todos_Servidores": false,
"tpEvento": null,
"MensagemSolucao": null,
"DesvioConsumoIndevido": false,
"XmlEventoCompactado": null,
"chaveNFeEnviada": null,
"idNota": 0,
"ExigeIdentificacaoDestinatarioContingencia": null,
"cMsg": null,
"xMsg": null,
"RetornoIntegradorList": []
}

Cancela NF-e

  • Endpoint Client 2.0: /NFe/Cancela
  • Endpoint Client em Nuvem: nfehubsender/Sale/Cancel
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/jsoN
  • Parâmetros:
    • chNFe: Chave do documento que será cancelado
    • dhEvento: Data do cancelamento
    • xJust: Justificativa do cancelamento
    • tpEvento: Código do evento de cancelamento
    • versão: Versão da autenticação da API.
    • tpAmb: Tipo do ambiente
      • 1 - Produção;
      • 2 - Homologação

Exemplo Payload Envio:


{
"chNFe": "43251054517628001111113650000536611111141497",
"dhEvento": "2025-10-21T18:00:28-03:00",
"xJust": "CancelamentodeNF-e",
"tpEvento": 110111,
"versao": "1.00",
"tpAmb": 2,
"GeraDanfe": false,
"DevolveXml": false
}

Exemplo Payload Retorno:


Inutiliza NF-e

  • Endpoint Client 2.0: /NFe/Inutiliza
  • Endpoint Client em Nuvem: nfehubsender/Sale/Invalidate
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/jsoN
  • Parâmetros:
    • ano: ano corrente
    • CNPJ: Cnpj do emissor
    • nNFFin: Número Final dos documentos a serem inutilizados
    • nNFIni: Número Inicial dos documentos a serem inutilizados
    • serie: Série dos documentos
    • xJust: Justificativa da inutilização.
    • devolveXML: Deseja o retorno do XML

Exemplo Payload Envio:

{
"ano": 2025,
"CNPJ": "11111111111111",
"nNFFin": 203,
"nNFIni": 203,
"serie": 709,
"xJust": "QUEBRA NA SEQUENCIA DE NUMERACAO EM FUNCAO DE PROBLEMAS TECNICOS.",
"devolveXML": true
}

Exemplo Payload Retorno:

{
"ID": "",
"chNFe": "",
"dhRetorno": "2025-07-01T11:11:33-03:00",
"nProt": "135190001111149",
"cStat": "102",
"xMotivo": "Inutilizacao de numero homologado",
"xUrlDanfe": null,
"Danfe": null,
"XmlCompactado": "H4sIAAAAAAAEAMVY6a/iyK7/4CsAEgAA",
"DanfeHTML": null,
"mensagemSEFAZ": null,
"UltimoDocumento": null,
"CCCC": null,
"cod": null,
"numeroSessao": null,
"xURLDanfeAutorizacao": null,
"Arquivo_Danfe": null,
"Arquivo_XML": null,
"DataAlteracao": "2025-06-28T16:54:28.267",
"Central_Contingencia": null,
"IndicaPDVAutorizacao": "A",
"IndicaPDVCancInut": "A",
"IndicaPDVConsulta": "A",
"URL_Consulta": null,
"Consultou_Todos_Servidores": false,
"tpEvento": null,
"MensagemSolucao": null,
"DesvioConsumoIndevido": false,
"XmlEventoCompactado": null,
"chaveNFeEnviada": null,
"idNota": 0,
"ExigeIdentificacaoDestinatarioContingencia": null,
"cMsg": null,
"xMsg": null,
"RetornoIntegradorList": []
}

Carta de Correção

  • Endpoint Client 2.0: /NFe/CartaCorrecao
  • Endpoint Client em Nuvem: nfehubsender/api/NFWebApi/CartaCorrecaoNFe
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/jsoN
  • Parâmetros:
    • chNFe: Chave do documento
    • dhEvento: Data do cancelamento
    • xCorrecao: Descrição da correção solicitada
    • tpEvento: Código do evento de cancelamento
    • versão: Versão da autenticação da API.
    • tpAmb: Tipo do ambiente
      • 1 - Produção;
      • 2 - Homologação

Exemplo Payload Envio:

{
"chNFe": "43250854517628001591111110000536261711111071",
"dhEvento": "2025-09-02T09:02:00-03:00",
"xCorrecao": "Bairro do destinatário incorreto. Deverá ser Centro",
"tpEvento": 110110
}

Exemplo Payload Retorno:


Consulta Última Nota NF-e

Para que o emissor consiga identificar qual a numeração da última nota de NF-e que transitou no Emissor Fiscal, ele pode utilizar esta API.

  • Endpoint Client 2.0: /NFe/GetUltimaNota
  • Endpoint Client em Nuvem: /hubservices/NFe/NoteNumber/GetLast?Cnpj={{SaleCnpj}}&Serie=2
  • Método: GET
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/jsoN
  • Parâmetros:
    • Cnpj = CNPJ do Emissor
    • Série: Série do documento

Exemplo Payload Envio:

Exemplo Payload Retorno:


Evento de Conciliação Financeira - ECONF

O Evento de Conciliação Financeira (ECONF – código 110750) foi instituído pela Nota Técnica 2024.002. Ele permite ao emitente registrar à SEFAZ, de forma facultativa, que o pagamento referente a uma NF-e (modelo 55) ou NFC-e (modelo 65) foi efetivado, mesmo em data diversa da emissão. Após autorizado, integra o histórico da nota e fortalece a rastreabilidade fiscal.

Quando se aplica

O ECONF é adequado quando:

  • O pagamento ocorre em data diferente da emissão (ex.: cartão, boleto, transferência);
  • A empresa precisa demonstrar conciliação financeira formal para fins fiscais ou contábeis;
  • Há necessidade de alinhamento com o Registro 1601 da EFD‑ICMS/IPI.

⚠️ Importante:

  • Evento facultativo, não altera tributos, valores ou dados da nota;
  • Não substitui manifestação, carta de correção, cancelamento ou outros eventos fiscais;
  • O evento de cancelamento (110751) permite excluir informações registradas no ECONF original.

  • Endpoint Client 2.0: /NFe/ConciliacaoFinanceira
  • Endpoint Client em Nuvem: /api/NFWebApi/ConciliacaoFinanceira
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescriçãoObrigatório
chNFeChave do documento fiscal a que o evento será vinculadoSim
cAutIdentifica o número da autorização da transação da operaçãoNão
CNPJIFCNPJ da instituição financeira, de pagamento, adquirente ou subadquirente.Não
CNPJPagPreencher informando o CNPJ do estabelecimento onde o pagamento foi processado/ transacionado/recebido quando a emissão do documento fiscal ocorrer em estabelecimento distinto.Sim
CnpjRecebInformar o CNPJ do estabelecimento beneficiário do pagamentoSim
dPagData do Pagamento no formato AAAA-MM-DD. Em caso de pagamentos agendados, informar a data da efetivação.Sim
indPag0= Pagamento à Vista
1= Pagamento à Prazo
Não
tBandUtilizar a Tabela de Códigos das Operadoras de cartão de crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica.Não
tPagMeio de Pagamento - Utilizar a Tabela de códigos dos meios de pagamentos publicada no Portal Nacional da Nota Fiscal EletrônicaSim
UFPagUF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido.Sim
UfRecebUF do CNPJ do estabelecimento beneficiário do pagamento.Sim
vPagValor do PagamentoSim
xPagDescrição do meio de pagamento. Preencher informando o meio de pagamento utilizado quando o código do meio de pagamento for informado como 99-outros.Não

Exemplo de Payload de Envio

{
"chNFe": "43251154517628001593550020002647981739959246",
"detPagList": [
{
"cAut": "88899991111",
"CNPJIF": "59438325000101",
"CNPJPag": "54517628001593",
"CnpjReceb": "59438325000101",
"dPag": "2025-11-10",
"indPag": 1,
"tBand": 3,
"tPag": 3,
"UFPag": "RS",
"UfReceb": "RS",
"vPag": 67.2,
"xPag": "Cartão"
}
],
"Protocolo": "c1f3f362-4bce-47a1-9445-bf19eabb054e"
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Cancelamento Conciliação Financeira - ECONF

  • Endpoint Client 2.0: /NFe/CancelaConciliacaoFinanceira
  • Endpoint Client em Nuvem: /api/NFWebApi/CancelamentoConciliacaoFinanceira
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Exemplo Payload Envio:

{
"chNFe": "43251154517628001593550020002647981739959246",
"Protocolo": "1578f1e3-4582-4865-acd9-3edba948b7df",
"ProtocoloConciliacao": "c1f3f362-4bce-47a1-9445-bf19eabb054e"
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

##Eventos do Emitente - Reforma Tributária

Neste tópico serão tratados os eventos do emitente, criados para atender a Reforma Tributária.

Cada tópico contempla um evento, a URL para chamada da API correspondente ao evento e uma breve explicação e informação sobre os valores esperados para cada evento.


Eventos do Emitente - Reforma Tributária

Neste tópico serão tratados os eventos do emitente, criados para atender a Reforma Tributária.

Cada tópico contempla um evento, a URL para chamada da API correspondente ao evento e uma breve explicação e informação sobre os valores esperados para cada evento.


112110 - Informação de efetivo pagamento integral para liberar crédito presumido do adquirente

  • Endpoint Client em Nuvem: /api/NFWebApi/Evento/112110
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parÂmetros de envio:

TagDescrição
tpEventoCódigo do Tipo de Evento
chNFeChave do Documento a que o evento será atrelado
indQuitacaoIndicador de efetiva quitação do pagamento integral da operação referente a NFe referenciada.
Valor deve ser igual a "1"

Exemplo Payload de Envio:

{
"tpEvento": 112110,
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"indQuitacao": 1
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

112120 - Importação em ALC/ZFM não convertida em isenção

  • Endpoint Client em Nuvem: /api/NFWebApi/Evento/112120
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
tpEventoCódigo do Tipo de Evento
chNFeChave do Documento a que o evento será atrelado
gConsumoInformações por item da NF-e de importação.
Nota: a quantidade de ocorrências não pode ser maior que a quantidade de itens da NF-e de aquisição.
nItemCorresponde ao atributo “nItem” do elemento “det” da NF-e de importação
vIBSValor do IBS correspondente à quantidade que não atendeu aos requisitos para a conversão em isenção
vCBSValor do CBS correspondente à quantidade que não atendeu aos requisitos para a conversão em isenção
gControleEstoqueInformações de quantidade de estoque influenciadas pelo evento
qtdeInformar a quantidade que não atendeu os requisitos para a conversão em isenção
unidadeInformar a unidade relativa ao campo gConsumo

Exemplo Payload de Envio:

{
"tpEvento": 112120,
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"gConsumo": [
{
"nitem": 1,
"vIBS": 150.5,
"vCBS": 75.25,
"gControleEstoque": {
"qtde": 10.0,
"unidade": "UN"
}
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

112130 - Perecimento, perda, roubo ou furto durante o transporte contratado pelo fornecedor

  • Endpoint Client em Nuvem: /api/NFWebApi/Evento/112130
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
tpEventoCódigo do Tipo de Evento
chNFeChave do Documento a que o evento será atrelado
gPerecimentoInformações por item da Nota de Fornecimento
nItemCorresponde ao atributo “nItem” do elemento “det” da NF-e de fornecimento
vIBSValor do IBS na Nota de Fornecimento correspondente à quantidade que foi objeto de roubo, perda, furto ou perecimento.
vCBSValor da CBS na Nota de Fornecimento correspondente à quantidade que foi objeto de roubo, perda, furto ou perecimento.
gControleEstoqueInformações de quantidade de estoque influenciadas pelo evento
qPerecimentoInformar a quantidade que foi objeto de roubo, perda, furto ou perecimento
uPerecimentoInformar a unidade relativa ao campo qPerecimento
SequenciaXMLInformações do crédito a ser estornado de IBS/CBS referente às aquisições para este item

Exemplo Payload de Envio:

{
"tpEvento": 112130,
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"gPerecimento": [
{
"nitem": 1,
"vIBS_Fornecimento": 150.5,
"vCBS_Fornecimento": 75.25,
"gControleEstoque": {
"qPerecimento": 10.0,
"uPerecimento": "UN"
},
"SequenciaXML": {
"vCBS_Credito": 0,
"vIBS_Credito": 0
}
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

112140 - Fornecimento não realizado com pagamento antecipado

  • Endpoint Client em Nuvem: /api/NFWebApi/Evento/112140
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
tpEventoCódigo do Tipo de Evento
chNFeChave do Documento a que o evento será atrelado
gItemNaoFornecidoInformações por item da Nota de Pagamento antecipado
nItemCorresponde ao atributo “nItem” do elemento “det” do documento referenciado
vIBSValor do IBS na nota de débito de pagamento antecipado correspondente à quantidade que não foi fornecida
vCBSValor do CBS na nota de débito de pagamento antecipado correspondente à quantidade que não foi fornecida
gControleEstoqueInformações de quantidade de estoque influenciadas pelo evento
qNaoFornecidaInformar a quantidade que não foi fornecida e teve o imposto antecipado
uNaoFornecidaInformar a unidade relativa ao campo qNaoFornecida

Exemplo Payload de Envio:

{
"tpEvento": 112140,
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"gItemNaoFornecido": [
{
"nitem": 1,
"vIBS": 150.5,
"vCBS": 75.25,
"gControleEstoque": {
"qNaoFornecida": 10.0,
"uNaoFornecida": "UN"
}
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

112150 - Atualização da Data de Previsão de Entrega

  • Endpoint Client em Nuvem: /api/NFWebApi/Evento/112150
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
tpEventoCódigo do Tipo de Evento
chNFeChave do Documento a que o evento será atrelado
dPrevEntregaData da previsão de entrega ou disponibilização do bem. Formato: “AAAA-MM-DD”.

Exemplo Payload de Envio:

{
"tpEvento": 112150,
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"dPrevEntrega": "{{DataHoraAtual}}"
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

211120 - Destinação de item para consumo pessoal

  • Endpoint Client em Nuvem: /api/NFWebApi/Evento/211120
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
tpEventoCódigo do Tipo de Evento
chNFeChave do Documento a que o evento será atrelado
gConsumoInformações por item da NF-e de Aquisição
Nota: a quantidade de ocorrências não pode ser maior que a quantidade de itens da NF-e de aquisição.
nItemCorresponde ao atributo “nItem” do elemento “det” da NF-e de aquisição
vIBSValor do IBS na Nota de Aquisição correspondente à quantidade destinada a uso e consumo pessoal
vCBSValor do CBS na Nota de Aquisição correspondente à quantidade destinada a uso e consumo pessoal
gControleEstoqueInformações de quantidade de estoque influenciadas pelo evento
qConsumoInformar a quantidade para consumo de pessoa física
uConsumoInformar a unidade relativa ao campo gConsumo
DFeReferenciadoInformações por item da NF-e de Uso e Consumo Pessoal
chaveAcessoInformar a chave da nota (NFe ou NFCe) emitida para o fornecimento nos casos em que a legislação obriga a emissão de documento fiscal.
nItemCorresponde ao "nItem" do DFeReferenciado.

Exemplo Payload de Envio:

{
"tpEvento": 211120,
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"gConsumo": [
{
"nitem": 1,
"vIBS": 150.5,
"vCBS": 75.25,
"gControleEstoque": {
"qConsumo": 10.0,
"uConsumo": "UN"
},
"DFeReferenciado": {
"chaveAcesso": "{{SaleChNFe}}",
"nItem": 1
}
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Eventos do Destinatário - Reforma Tributária

Neste tópico serão tratados os eventos do Destinatário, criados para atender a Reforma Tributária.

Cada tópico contempla um evento, a URL para chamada da API correspondente ao evento e uma breve explicação e informação sobre os valores esperados para cada evento.

211110 - Solicitação de Apropriação de crédito presumido

  • Endpoint Client em Nuvem: /api/NFEntradaWebApi/Evento/Destinatario/211110
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
chNFeChave do Documento a que o evento será atrelado
gCredPresInformações de crédito presumido por item
nItemCorresponde ao atributo “nItem” do elemento “det” do documento referenciado
vBCValor do base de cálculo do item
gIBSGrupo de Informações do Crédito Presumido do IBS
cCredPresCódigo de Classificação do Crédito presumido, conforme tabela cCredPres (Anexo IV)
pCredPresPercentual do Crédito Presumido
vCredPresValor do Crédito Presumido
gCBSGrupo de Informações do Crédito Presumido da CBS
cCredPresCódigo de Classificação do Crédito presumido, conforme tabela cCredPres (Anexo IV)
pCredPresPercentual do Crédito Presumido
vCredPresValor do Crédito Presumido

Exemplo Payload de Envio:

{
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"CnpjDest": "{{CnpjSpMatriz}}",
"gCredPres": [
{
"nItem": 1,
"vBC": 0.25,
"gIBS": {
"cCredPres": "10",
"pCredPres": 0.25,
"vCredPres": 0.25 }
"gCBS": {
"cCredPres": "10",
"pCredPres": 0.25,
"vCredPres": 0.25 }
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

211120 - Destinação de item para consumo pessoal

  • Endpoint Client em Nuvem: /api/NFEntradaWebApi/Evento/Destinatario/211120
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
tpEventoCódigo do Tipo de Evento
chNFeChave do Documento a que o evento será atrelado
gConsumoInformações por item da NF-e de Aquisição
Nota: a quantidade de ocorrências não pode ser maior que a quantidade de itens da NF-e de aquisição.
nItemCorresponde ao atributo “nItem” do elemento “det” da NF-e de aquisição
vIBSValor do IBS na Nota de Aquisição correspondente à quantidade destinada a uso e consumo pessoal
vCBSValor do CBS na Nota de Aquisição correspondente à quantidade destinada a uso e consumo pessoal
gControleEstoqueInformações de quantidade de estoque influenciadas pelo evento
qConsumoInformar a quantidade para consumo de pessoa física
uConsumoInformar a unidade relativa ao campo gConsumo
DFeReferenciadoInformações por item da NF-e de Uso e Consumo Pessoal
chaveAcessoInformar a chave da nota (NFe ou NFCe) emitida para o fornecimento nos casos em que a legislação obriga a emissão de documento fiscal.
nItemCorresponde ao "nItem" do DFeReferenciado.

Exemplo Payload de Envio:

{
"tpEvento": 211120,
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"CnpjDest": "{{CnpjSpMatriz}}",
"gConsumo": [
{
"nitem": 1,
"vIBS": 150.5,
"vCBS": 75.25,
"gControleEstoque": {
"qConsumo": 10.0,
"uConsumo": "UN"
},
"DFeReferenciado": {
"chaveAcesso": "{{SaleChNFe}}",
"nItem": 1
}
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

211124 - Perecimento, perda, roubo ou furto durante o transporte contratado pelo adquirente

  • Endpoint Client em Nuvem: /api/NFEntradaWebApi/Evento/Destinatario/211124
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
chNFeChave do Documento a que o evento será atrelado
gPerecimentoInformações por item da Nota de Aquisição
nItemCorresponde ao atributo “nItem” do elemento “det” do documento referenciado.
vIBSValor do IBS na Nota de Aquisição correspondente à quantidade que foi objeto de roubo, perda, furto ou perecimento
vCBSValor do CBS na Nota de Aquisição correspondente à quantidade que foi objeto de roubo, perda, furto ou perecimento
gControleEstoqueInformações de quantidade de estoque influenciadas pelo evento
qPerecimentoInformar a quantidade que foi objeto de roubo, perda, furto ou perecimento
uPerecimentoInformar a unidade relativa ao campo qPerecimento

Exemplo Payload de Envio:

{
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"CnpjDest": "{{CnpjSpMatriz}}",
"gPerecimento": [
{
"nItem": 1,
"vIBS": 10.25,
"vCBS": 5.75,
"gControleEstoque": {
"qPerecimento": 2.5,
"uPerecimento": "UN"
}
},
{
"nItem": 2,
"vIBS": 4.00,
"vCBS": 2.00,
"gControleEstoque": {
"qPerecimento": 1.0,
"uPerecimento": "CX"
}
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

211128 - Aceite de débito na apuração por emissão de nota de crédito

  • Endpoint Client em Nuvem: /api/NFEntradaWebApi/Evento/Destinatario/211128
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
chNFeChave do Documento a que o evento será atrelado
indAceitacaoIndicador de concordância com o valor da nota de crédito que lançaram IBS e CBS na apuração assistida.
Valores: 0 = não aceite; 1 = aceite.

Exemplo Payload de Envio:

{
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"CnpjDest": "{{CnpjSpMatriz}}",
"indAceitacao": "1"
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

211130 - Imobilização de Item

  • Endpoint Client em Nuvem: /api/NFEntradaWebApi/Evento/Destinatario/211130
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
chNFeChave do Documento a que o evento será atrelado
gImobilizacaoInformações de itens integrados ao ativo imobilizado
nItemCorresponde ao atributo “nItem” do elemento “det” do documento referenciado.
vIBSValor do IBS relativo à imobilização
vCBSValor da CBS relativo à imobilização
gControleEstoqueInformações de crédito presumido por item
qImobilizadoInformar a quantidade do item a ser imobilizado
uImobilizadoInformar a unidade relativa ao campo qImobilizado

Exemplo Payload de Envio:

{
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"CnpjDest": "{{CnpjSpMatriz}}",
"gImobilizacao": [
{
"nItem": 1,
"vIBS": 58.50,
"vCBS": 12.75,
"gControleEstoque": {
"qImobilizado": 1.0000,
"uImobilizado": "UN"
}
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

211140 - Solicitação de Apropriação de Crédito de Combustível

  • Endpoint Client em Nuvem: /api/NFEntradaWebApi/Evento/Destinatario/211140
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
chNFeChave do Documento a que o evento será atrelado
gConsumoCombInformações de consumo de combustíveis
nItemCorresponde ao atributo “nItem” do elemento “det” do documento referenciado.
vIBSValor do IBS relativo ao consumo de combustível na nota de aquisição
vCBSValor do CBS relativo ao consumo de combustível na nota de aquisição
gControleEstoqueInformações de quantidade por item
qCombInformar a quantidade de consumo do item
uCombInformar a unidade relativa ao campo qComb

Exemplo Payload de Envio:

{
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"CnpjDest": "{{CnpjSpMatriz}}",
"gConsumoComb": [
{
"nItem": 1,
"vIBS": 12.34,
"vCBS": 5.67,
"gControleEstoque": {
"qComb": 50.0000,
"uComb": "L"
}
},
{
"nItem": 2,
"vIBS": 3.00,
"vCBS": 1.50,
"gControleEstoque": {
"qComb": 10.7500,
"uComb": "L"
}
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

211150 - Solicitação de Apropriação de Crédito para bens e serviços que dependem de atividade do adquirente

  • Endpoint Client em Nuvem: /api/NFEntradaWebApi/Evento/Destinatario/211150
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
chNFeChave do Documento a que o evento será atrelado
gCreditoInformações de crédito
nItemCorresponde ao atributo “nItem” do elemento “det” do documento referenciado.
vCredIBSValor da solicitação de crédito a ser apropriado de IBS
vCredCBSValor da solicitação de crédito a ser apropriado de CBS

Exemplo Payload de Envio:

{
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"CnpjDest": "{{CnpjSpMatriz}}",
"gCredito": [
{
"nItem": 1,
"vCredIBS": 125.45,
"vCredCBS": 83.20
},
{
"nItem": 2,
"vCredIBS": 50.00,
"vCredCBS": 25.00
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Cancelamento de Eventos - Reforma Tributária

110001 - Cancelamento de Evento

  • Endpoint Client em Nuvem: /api/NFWebApi/CancelamentoEvento
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json

Dados dos parâmetros de envio:

TagDescrição
tpEventoCódigo do Tipo de Evento
chNFeChave do Documento a que o evento será atrelado
ProtocoloAutorizadoInformar o número do Protocolo de Autorização do Evento a ser cancelado
tpEventoAutCódigo do evento autorizado a ser cancelado. Por este evento poderão ser cancelados todos os Eventos previstos nesta NT, exceto o próprio Evento de Cancelamento (110001).

Exemplo Payload de Envio:

{
"CnpjDest": "{{CnpjSpMatriz}}",
"tpEvento": 110001,
"chNFe": "{{SaleChNFe}}",
"dhEvento": "{{DataHoraAtual}}",
"Protocolo": "{{GeneratedGUID}}",
"ProtocoloAutorizado": "{{ProtocoloAutorizado}}",
"tpEventoAut": 211110
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Emissor Fiscal
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Este conteúdo foi útil para você?