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.

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 todos 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.

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

 

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#/Evento32Fiscal

0 (0)
Avaliação do Artigo (Nenhum voto)
Avaliar esse artigo
Anexos
Não há anexos para este artigo.
Artigos Relacionados RSS Feed
Autenticação na API Rest
Visualizado 1147 vezes desde 09/03/2018
Integração API Rest
Visualizado 652 vezes desde 09/03/2018
Emissão de DFes na API Rest
Visualizado 521 vezes desde 13/03/2018
Inutilização de Numeração na API Rest
Visualizado 391 vezes desde 16/03/2018
Importação e Conciliação de DFes na API Rest
Visualizado 315 vezes desde 16/03/2018
Recebimento de Documentos Fiscais via API Rest
Visualizado 271 vezes desde 16/03/2018
Gerenciamento de Empresas na API Rest
Visualizado 254 vezes desde 16/03/2018
Manutenção de CSC (Código de Segurança do Contribuinte) na API Rest
Visualizado 763 vezes desde 16/03/2018
Criar Aplicativo no Monitor Oobj
Visualizado 194 vezes desde 12/04/2018
Configurar MDe na Api Rest
Visualizado 51 vezes desde 27/09/2018
Comentários
Nome
Email
Código de Segurança Security Code
Não há comentários para este artigo. Seja o primeiro a postar um comentário.