Pular para o conteúdo principal

Rota da API - Exportar notas V2

Tiago Valverde
Atualizado

A Rota Exporta, foi criada para realizar a geração de vários XML's e PDF's de uma só vez em um arquivo .zip, todos os XML's e PDF's emitidos e destinados a um CNPJ.

Para a exportação de XML e PDF, utilize o parâmetro "pdf": true.

Caso deseje consultar apenas um XML de uma chave específica, utilize este outro endpoint, clicando aqui!

 

Essa rota é assíncrona, guarde o protocolo retornado para que possa consultar a situação de sua exportação.

 

Observações:

  • O período máximo para exportação é de 31 dias.
  • Os campos dataInicial e dataFinal são referentes a data de emissão do documento.
  • O arquivo .zip ficará disponível para download por 15 dias.
  • Esta rota pode ser utilizada na exportação de todos os documentos, basta substituir o nome do documento nas requisições. Exemplos:
    1. https://managersaas.tecnospeed.com.br:8081/api/v2/cfesat/exporta
    2. https://managersaas.tecnospeed.com.br:8081/api/v2/cte/exporta
    3. https://managersaas.tecnospeed.com.br:8081/api/v2/mdfe/exporta
    4. https://managersaas.tecnospeed.com.br:8081/api/v2/nfse/exporta
    5. https://managersaas.tecnospeed.com.br:8081/api/v2/nfe/exporta
    6. https://managersaas.tecnospeed.com.br:8081/api/v2/nfce/exporta
    7. https://managersaas.tecnospeed.com.br:8081/api/v2/cteos/exporta

Observação> Nos exemplos abaixo será utilizado o documento NFe para simplificar o uso.

1ºPasso - Exportar documentos

No primeiro passo será definido o período de solicitação de xml's.

 

POST

https://managersaas.tecnospeed.com.br:8081/api/v2/nfe/exporta?grupo=SeuGrupo&cnpj=29062609000177

 

Headers

 

Nome Descrição Exemplo
Content-Type Indica o tipo de arquivo application/json
Authorization Este usuário e senha são os seus dados para logar como administrador em um grupo do SaaS Basic YWRtaW46MTIzbXVkYXI=

 

Params 

Nome Descrição
Grupo Nome do grupo
CNPJ CNPJ que está vinculado ao grupo que será usado para enviar a requisição de exporta

 

Body

{"dataInicial": "2021-01-27","dataFinal": "2021-01-28","pdf":false}

 

Body com parâmetros de numeração:

{"dataInicial": "2021-01-27","dataFinal": "2021-01-28","pdf":false,"serie": "123","numeroInicial": "1", "numeroFinal": "2"}
 

Observação: Os parâmetros devem ser enviados na mesma linha conforme os exemplos citados acima. Outro ponto importante, caso um protocolo não concluído em até 40 minutos será possível refazer uma nova requisição solicitando a exportação novamente com os mesmos parâmetros, essa ação descartará o processamento não concluído de forma automática.

Retorno

Exemplo de retorno:

{
    "mensagem": "Nota(as) em processamento",

    "protocolo": "f1b740ba-6899-4d80-83e8-43dacfb04351"

}

 

 Exemplo de retorno com erro:

{

    "mensagem": "dataInicial e dataFinal não podem ultrapassar limite de 31 dias de diferença."

}
 

 

2º Passo - Consultar protocolo

 

Na consulta do protocolo será verificado se o protocolo já realizou o processamento da solicitação.

 

GET

https://managersaas.tecnospeed.com.br:8081/api/v2/nfe/exporta/:protocol?grupo=SeuGrupo&cnpj=29062609000177

 

Headers

 

Nome Descrição Exemplo
Content-Type Indica o tipo de arquivo application/json
Authorization Este usuário e senha são os seus dados para logar como administrador em um grupo do SaaS Basic YWRtaW46MTIzbXVkYXI=

 

Params 

Nome Descrição
Grupo Nome do grupo
CNPJ CNPJ que está vinculado ao grupo que será usado para enviar a requisição de exporta

 

Variáveis

Nome Descrição
protocol Número do protocolo adquirido no retorno da consulta do 1ºpasso realizado desta rota.
 
Observação: Ao realizar uma consulta com o protocolo informado, caso ele possua mais de 40 minutos sem uma conclusão, essa ação descartará o processamento não concluído de forma automática retornando o status code 400 com a resposta da requisição abaixo:
 
{
"mensagem":"Timeout de 40m0s excedido para exportação",
"protocolo":"e43bbfc4-a78b-4bf7-8691-9f9158d74a2b"
}

Retorno

Exemplo de retorno de Operação Concluída:

{
    "mensagem": "Operação concluída, utilize a URL para baixar seus arquivos.",
    "protocolo": "57cd901d-4a80-4235-bac0-fc75dacf4d58",
    "filtros": {
        "dataInicial": "2020-01-01",
        "dataFinal": "2020-01-30",
        "pdf": true
    },
    "xmls": {
        "situacao": "CONCLUIDO",
        "url": "https://managersaas.tecnospeed.com.br:8081/api/v2/nfe/exporta/57cd405d-3a60-4235-bac0-fc75dacf4d57/xml"
    },
    "pdfs": {
        "situacao": "CONCLUIDO",
        "url": "https://managersaas.tecnospeed.com.br:8081/api/v2/nfe/exporta/57cd103e-4a84-4215-bac0-fc75ddrf3d13/pdf"
    }
}

 

Exemplo de retorno com erro: 

{
    "mensagem": "EXCEPTION|EspdConsultaException|Erro ao obter dados da consulta. Tente novamente mais tarde.",
    "protocolo": "33186c7c-abae-4dc2-87ad-dab39b9df835"
}
 
Exemplo de retorno da consulta sem dados para geração: 
{
    "mensagem": "Operação concluída, nenhum registro encontrado para o filtro utilizado.",
    "protocolo": "417de89c-e698-4297-abdb-c9355ccac794",
    "filtros": {
        "dataInicial": "2018-04-01",
        "dataFinal": "2018-04-30"
    }
}

 

3ºPasso - Baixar XML's

 

Nesse passo será realizado o dowload dos xml's solicitados.

 

GET

https://managersaas.tecnospeed.com.br:8081/api/v2/nfe/exporta/:protocol/xml?grupo=SeuGrupo&cnpj=29062609000177

 

Headers

 

Nome Descrição Exemplo
Content-Type Indica o tipo de arquivo application/json
Authorization Este usuário e senha são os seus dados para logar como administrador em um grupo do SaaS Basic YWRtaW46MTIzbXVkYXI=

 

Params 

Nome Descrição
Grupo Nome do grupo
CNPJ CNPJ que está vinculado ao grupo que será usado para enviar a requisição de exporta

 

Variáveis

Nome Descrição
protocol Número do protocolo adquirido no retorno da consulta do 1ºpasso realizado desta rota.

 

Retorno

exemplo de retorno sem dados para geração:

{
    "mensagem": "Nenhum registro encontrado.",
    "protocolo": "57cd935d-4a80-4235-bac0-fc75dacf4d5"
}
 
Exemplo de retorno com dados para geração:
 
Será recebido uma resposta com dados binários onde será preciso realizar a conversão para salvar o arquivo zip.
 
O arquivo zip irá separar as notas emitidas e as recebidas por pasta conforme imagem abaixo.
 
mceclip1.png
 

4ºPasso - Baixar PDF's

 

Nesse passo será realizado o dowload dos pdf's solicitados.

 

GET

https://managersaas.tecnospeed.com.br:8081/api/v2/nfe/exporta/:protocol/pdf?grupo=SeuGrupo&cnpj=29062609000177

 

Headers

 

Nome Descrição Exemplo
Content-Type Indica o tipo de arquivo application/json
Authorization Este usuário e senha são os seus dados para logar como administrador em um grupo do SaaS Basic YWRtaW46MTIzbXVkYXI=

 

Params 

Nome Descrição
Grupo Nome do grupo
CNPJ CNPJ que está vinculado ao grupo que será usado para enviar a requisição de exporta.

 

Variáveis

Nome Descrição
protocol Número do protocolo adquirido no retorno da consulta do 1ºpasso realizado desta rota.

 

Retorno

exemplo de retorno sem dados para geração:

{
    "mensagem": "Nenhum registro encontrado.",
    "protocolo": "57cd935d-4a80-4235-bac0-fc75dacf4d5"
}
 
Exemplo de retorno com dados para geração:
 
Será recebido uma resposta com dados binários onde será preciso realizar a conversão para salvar o arquivo zip.
 
O arquivo zip irá separar as notas emitidas e as recebidas por pasta conforme imagem abaixo.
 

ATENÇÃO

Os arquivos .pdf dentro da pasta "recebidas" são referentes as notas retornadas na consulta de destinadas, elas podem ou não conter o xml destinatário, isso varia de acordo com a manisfestação da ciência da operação da nota, se caso não foi feito o manifesto elas não terão esse xml e nesse caso não será possível imprimi-las e dentro da pasta terá um arquivo assim: "chave_da_nota-nfe.erro" com o conteúdo: EXCEPTION,EspdAPIWebServerErrorException,Não foi possível imprimir a nota pois não existe xml destinatário'

 

mceclip1.png

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.