eNotas Gateway

eNotasGW Developer Portal

Bem vindo ao eNotas Gateway Developer Portal!

Veja como é simples emitir diversos tipos de documentos fiscais eletrônicos de forma simples e 100% automático com centenas de prefeituras e SEFAZs.

Primeiros Passos      Documentação

Webhook

Entenda o que é e como cadastrar um webhook para ser notificado das mudanças mais importantes sobre suas notas fiscais, com exemplos!

O que é Webhook?

Webhooks permitem que sistemas externos recebam notificações de todos os eventos que ocorrem na API.

Quando um evento acontece, a API envia uma requisição HTTP (POST) para a URL configurada no webhook com as informações relativas ao evento.

Ao receber a notificação, o sistema integrado a API pode executar diversas tarefas, dependendo do seu objetivo.

Eventos que notificam seu sistema

Seu sistema será notificado sempre que uma nota fiscal mudar para um dos status abaixo:

• ​Autorizada - Nota fiscal foi autorizada pelo órgão responsável;
• ​Negada - Nota fiscal foi negada pelo órgão responsável;
• ​Cancelada - O cancelamento da nota fiscal foi autorizado pelo órgão responsável;
• ​CancelamentoNegado - O cancelamento da nota fiscal foi rejeitado pelo órgão responsável;

O valor em negrito representa o status que será retornado no parâmetro nfeStatus.

Parâmetro "nfeMotivoStatus"

Este parâmetro só retorna diferente de null nos seguintes status:

• "nfeStatus": "Negada",
• "nfeStatus": "CancelamentoNegado",

Dados retornados na notificação

Os dados do POST de notificação variam por tipo de nota fiscal e ambos os webhooks de retorno da API V2 (NF-e e NFC-e) são bastante similares.

Exemplo WEBHOOK - NF-e

{
    "tipo": "NF-e",
    "empresaId": "string",
    "nfeStatus": "string",
    "nfeMotivoStatus": "string",
    "nfeId": "001",
    "nfeStatus": "Autorizada",
    "nfeMotivoStatus": null,
    "nfeLinkDanfe": "http://api.enotasgw.com.br/file/(...)/pdf",
    "nfeLinkXml": "http://api.enotasgw.com.br/file/(...)/xml",
    "nfeNumero": "123",
    "nfeSerie": "1",
    "nfeChaveAcesso": "08764980057334953516065001000000691967411517",
    "nfeDataEmissao": "2017-01-02T17:20:32Z",
    "nfeDataAutorizacao": "2017-01-02T17:21:07Z",
    "nfeNumeroProtocolo": "353150000119390",
    "nfeDigestValue": "ssiUjiiOQkD2UGw"
}

Exemplo WEBHOOK - NFC-e

O campo "nfeLinkConsultaPorChaveAcesso" é exclusivo das NFC-e, por ser uma especificação das SEFAZ estaduais.

{
    "tipo": "NFC-e",
    "empresaId": "string",
    "nfeStatus": "string",
    "nfeId": "001",
    "nfeStatus": "Autorizada",
    "nfeMotivoStatus": null,
    "nfeLinkDanfe": "http://api.enotasgw.com.br/file/(...)/pdf",
    "nfeLinkXml": "http://api.enotasgw.com.br/file/(...)/pdf",
    "nfeLinkConsultaPorChaveAcesso": "http://sistemas.sefaz.am.gov.br/nfceweb/formConsulta.do",
    "nfeNumero": "123",
    "nfeSerie": "1",
    "nfeChaveAcesso": "73349650010000005351606919674115087649800517",
    "nfeDataEmissao": "2017-01-02T17:20:32Z",
    "nfeDataAutorizacao": "2017-01-02T17:21:07Z",
    "nfeNumeroProtocolo": "353150000119390",
    "nfeDigestValue": "ssiUjiiOQkD2UGw"
}

Campo "nfeMotivoStatus"

Esse campo só retorna diferente de null quando a nota é rejeitada ou denegada.

Updated 8 months ago

Webhook


Entenda o que é e como cadastrar um webhook para ser notificado das mudanças mais importantes sobre suas notas fiscais, com exemplos!

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.