Webinar Fundo de Combate à Pobreza (FCP) - Oobj e Systax

Emissão de DFes na API Rest

A Emissão de DF-es 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 Documentos Fiscais e para cada um, há uma URL específica.

 

Autorização / Envio / Emissão de DFe (POST)

A emissão de um DFe 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}?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)
  • {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?layout=oobj


Exemplo sem o parâmetro opcional 
layoutDFe preenchido: 

http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55

 

Nesse Endpoint será enviado o conteúdo do DFe nos Layouts XML Oobj (padrão), XML Sefaz ou TXT-SP.

 

 

 

Obter Retorno de um Documento Fiscal

Após a emissão de um DFe, o usuário deve obter o retorno de processamento do mesmo. Esse retorno poderá ser de Autorização, Rejeição ou Arquivo Inválido. Para isso há dois Endpoints, um que permite obter o o retorno através da série e número e outro por chave de acesso:

1. Obter retorno de um DFe através da série e número (GET)

Nesse Endpoint, o retorno do DFe é obtido através da série e número do DFe emitido.

A URL é construída da seguinte forma: 

http://  ou  https:// /endereço da API Rest  +  /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes:

  • {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

 

 

2. Obter o retorno de um DFe através da chave de acesso (GET)

Nesse Endpoint, o retorno do DFe é obtido através da Chave de Acesso:

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{chaveAcesso}

 

  • {empresa} : CNPJ da Empresa
  • {ambiente} : hom ou prod
  • {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
  • {chaveAcesso} : Chave de Acesso do DFe
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55/43180307385111000102555020001860671000000000

 

No seu Sistema, ao integrar com a API Rest, o desenvolvedor poderá escolher qual componente para obter o retorno irá implementar ou se usará os dois.

 

 

 

Download de PDF (Documento Auxiliar)

Se o DFe for autorizado ou emitido em Contingência, após realizar a Emissão poderá obter o Documento Auxiliar do DFe em formado PDF. E assim como para Retornar um DFe, há dois Endpoints, um que permite obter o PDF através da série e número e outro por chave de acesso:

1. Download de PDF de um DFe através da série e número (GET)

Nesse Endpoint, o PDF (Documento Auxiliar) do DFe é obtido através da série e número do DFe emitido.

A URL é construída da seguinte forma: 

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}.pdf

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes:

  • {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.pdf

 

Observe que a URL é semelhante a URL do Endpoint para Obter o retorno de um DFe através da série e número, sendo necessário adicionar apenas o termo .pdf no final.

 

 

2. Download de PDF de um DFe através da chave de acesso (GET)

Nesse Endpoint, o PDF (Documento Auxiliar) do DFe é obtido através da Chave de Acesso:

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{chaveAcesso}.pdf

 

  • {empresa} : CNPJ da Empresa
  • {ambiente} : hom ou prod
  • {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
  • {chaveAcesso} : Chave de Acesso do DFe
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55/43180307385111000102555020001860671000000000.pdf

 

No seu Sistema, ao integrar com a API Rest, o desenvolvedor poderá escolher qual componente para obter o Documento Auxiliar irá implementar ou se usará os dois.

 

 

 

Buscar último NSU consultado na Sefaz

Esse serviço têm foco no Recebimento de Documentos Fiscais e permite a busca do último NSU (Número Sequência Único) consultado na Sefaz

 

 


Obter resumo dos DFes Recebidos utilizando NSU

 

 

 

 

Obter resumo dos DFes Recebidos utilizando Data de Emissão

 

 

 

Obter XML Proc (GET)

O XML Proc é o Documento Fiscal com Assinatura Digital, que é idêntico ao armazenado na Sefaz e que deve ser guardado pelo contribuinte por no mínimo 5 anos.

Nesse Endpoint, é possível obter o XML Proc de um DFe Emitido ou Recebido. Sempre que esse serviço for utilizado será retornado os DFes emitidos ou recebidos pela empresa informada na URL de forma paginada com 20 elementos (XML Proc), ou seja, ao realizar o primeiro acesso a esse Endpoint, você poderá informar a página que deseja consultar na URL, ou poderá deixar em branco, assim virá a primeira página.

Na resposta da sua consulta nesse serviço, será informado no final a quantidade de itens que há na página, e qual o Total de itens que pode ser obtidos em todas as outras páginas. Dessa forma, basta realizar uma iteração, passando por cada página até que não hajam mais elementos, caso queira obter todos os XML's Proc da sua empresa.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/?pagina={numeroPagina}&comXML={true ou false}

 

  • {empresa} : CNPJ da Empresa
  • {ambiente} : hom ou prod
  • {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
  • {numeroPagina} : numero da pagina (Opcional. Se não informado, o valor 1 é assumido como padrão)
  • {comXml} : true ou false (Opcional. Se não informado, o valor false é assumido como padrão) 

Exemplo com os parâmetros opcionais preenchidos:

http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55?pagina=1&comXml=false

 

Exemplo sem os parâmetros opcionais preenchidos:

http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55

 

 

Para realizar testes com a API Rest, e ter mais detalhes sobre a Emissão de Documentos Fiscais, acesse a documentação completa através do link: http://rest.oobj-dfe.com.br/swagger-ui.html#/Documento32Fiscal

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 362 vezes desde 09/03/2018
Integração API Rest
Visualizado 334 vezes desde 09/03/2018
Emissão de Eventos Fiscais na API Rest
Visualizado 222 vezes desde 16/03/2018
Inutilização de Numeração na API Rest
Visualizado 186 vezes desde 16/03/2018
Importação e Conciliação de DFes na API Rest
Visualizado 169 vezes desde 16/03/2018
Recebimento de Documentos Fiscais na API Rest
Visualizado 121 vezes desde 16/03/2018
Gerenciamento de Empresas na API Rest
Visualizado 131 vezes desde 16/03/2018
Manutenção de CSC (Código de Segurança do Contribuinte) na API Rest
Visualizado 415 vezes desde 16/03/2018
Criar Aplicativo no Monitor Oobj
Visualizado 102 vezes desde 12/04/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.