Emissão de Eventos Fiscais na API Rest
A Emissão de Eventos Fiscais através da API Rest será permitido para o usuário que já possuir o x-auth-token. No artigo Autenticação na API Rest damos mais detalhes sobre o x-auth-token. Existem alguns Endpoints para o serviço de Emissão de Eventos Fiscais e para cada um, há uma URL específica.
Autorização / Envio de Eventos Fiscais (POST)
A emissão de um Evento Fiscal através da API Rest pode ser feita utilizando alguns Layout específicos, como XML Oobj (padrão), XML Sefaz ou TXT-SP.
Obs: Para emissão de Evento de Desacordo de Operação para CT-e, é possível emitir utilizando o layout TXT NDD.
A URL é construída da seguinte forma:
http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}/eventos?layout={layoutDFe}
Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:
- {empresa} : CNPJ da Empresa
- {ambiente} : hom ou prod
- {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
- {ano} : Ano de Emissão no formado AAAA
- {serie} : Série do DFe
- {numero} : Número do DFe
- {layoutDFe} : oobj, sefaz ou txtsp. Será assumido o valor oobj, caso não informado
Exemplo com o parâmetro opcional layoutDFe preenchido:
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55/2018/502/186067/eventos?layout=sefaz
Exemplo sem o parâmetro opcional layoutDFe preenchido:
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55/2018/502/186067/eventos
Nesse Endpoint será enviado o conteúdo do Evento Fiscal nos Layouts XML Oobj (padrão), XML Sefaz ou TXT-SP.
Obter retorno de um Evento Fiscal (GET)
Nesse Endpoint, o retorno de um Evento Fiscal pode ser obtido no mesmo Layout que foi usado na Emissão / Envio.
A URL é construída da seguinte forma:
http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}/eventos/{tipoEvento}
Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:
- {empresa} : CNPJ da Empresa
- {ambiente} : hom ou prod
- {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
- {ano} : Ano de Emissão no formado AAAA
- {serie} : Série do DFe
- {numero} : Número do DFe
- {tipoEvento} : Código que representa o tipo do evento
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55/2018/502/186067/eventos/110110
Download de PDF (para Carta de Correção) (GET)
Se o Evento Fiscal for autorizado na Sefaz após realizar a Emissão / Envio, o usuário poderá baixar o PDF da Carta de Correção.
A URL é construída da seguinte forma:
http:// ou https:// + /endereço da API Rest + /api/eventos/dacce/{ambiente}/{chaveAcesso}.pdf
Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:
- {ambiente} : hom ou prod
- {chaveAcesso} : Chave de Acesso do DFe que possui Carta de Correção
http://rest.oobj-dfe.com.br/api/eventos/dacce/hom/43180307385111000102555020001860671000000000.pdf
Obter os Eventos de um DFe (GET)
O XML Proc do Evento Fiscal com Assinatura Digital, que é idêntico ao armazenado na Sefaz e deve ser guardado pelo contribuinte por no mínimo 5 anos.
Nesse Endpoint, é possível obter o XML Proc de todos os Eventos relacionados à um DFe, buscando com base na numeração, ano e série de um documento.
A URL é construída da seguinte forma:
http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}/eventos
Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:
- {empresa} : CNPJ da Empresa
- {ambiente} : hom ou prod
- {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
- {ano} : Ano de Emissão no formado AAAA
- {serie} : Série do DFe
- {numero} : Número do DFe
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55/2018/502/186067/eventos
É possível também puxar, os eventos de um documento utilizando a chave de acesso.
A URL é construída da seguinte forma:
http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{chaveAcesso}/eventos
Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:
- {empresa} : CNPJ da Empresa
- {ambiente} : hom ou prod;
- {chaveAcesso} : chave de acesso do documento que deseja pesquisar;
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/12365478996541236478952225412143153151354444/eventos
Caso necessário puxar detalhes de um evento específico, por exemplo, o documento possui uma carta de correção e um manifesto e deseje apenas as informações da carta de correção, é possível também.
A URL é construída da seguinte forma:
http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{chaveAcesso}/eventos/{tipoEvento}
Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:
- {empresa} : CNPJ da Empresa;
- {ambiente} : hom ou prod;
- {chaveAcesso} : chave de acesso do documento que deseja pesquisar;
- {tipoEvento}: Código do tipo do evento (ex: 110110, 110111)
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/12365478996541236478952225412143153151354444/eventos/110110
Obter os Eventos dentro de um determinado período (GET)
Pela API, passando o período de pesquisa, puxará todos os eventos emitidos dentro dentro do intervalo informado.
A URL é construída da seguinte forma:
http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/eventos/data-inicial/{dataEventoInicial}/data-final/{dataEventoFinal}
Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:
- {empresa} : CNPJ da Empresa;
- {ambiente} : hom ou prod;
- {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe);
- {dataEventoInicial}: Data de Inicio da pesquisa;
- {dataEventoFinal}: Data de Término da pesquisa;
Para realizar testes com a API Rest, e ter mais detalhes sobre a Emissão de Eventos Fiscais, acesse a documentação completa através do link: http://rest.oobj-dfe.com.br/swagger-ui.html#
