API : domain_product_cte_query_for_file
PRODUTO: CT-e
Funcionalidade: A Dokfile, através da chave de acesso do arquivo fiscal passada como argumento, busca um CT-e armazenado e retorna um resultado, sendo este resultado algumas breves informações ou o próprio XML completo.
Método: GET
Retorno: XML
Parâmetros
Token
Neste parâmetro deve ser passado a sua chave de acesso para autenticar o uso da API.
Chave de acesso
Neste parâmetro deve ser passado a Chave de acesso referente ao arquivo desejado.
Retorno de arquivo
Com este parâmetro é definido se o retorno irá ter o XML completo do arquivo, caso não tenha será retornado algumas informações básicas.
Consulta na SEFAZ
Neste parâmetro é informado para o sistema buscar informações referentes ao status da nota diretamente na SEFAZ.
Exemplo e Estrutura de uma chamada:
Método:
URL: https://Base/domain_product_cte_query_for_file?access-key=SEUTOKEN&cte-key=CHAVEDOARQUIVO&return-full-file=false&gov-check=true
Base: Domínio da api (entre em contato para receber o domínio)
API: /domain_product_cte_query_for_file
Token: ?access-key=SEUTOKEN
Chave de acesso: &cte-key=CHAVEDOARQUIVO
Retorno do arquivo: &return-full-file=false (true ou false)
Consulta SEFAZ: &gov-check=true ( true ou false )
Exemplo de Retorno
OBS: Por motivo de praticidade, o exemplo não será da busca de XML completo.
<?xml version="1.0" encoding="UTF-8"?>
<QueryForFileResult>
<rid>d8519f69-ea1d-49c0-b512-fcb4ed12cc35</rid>
<Error>
<Code>0</Code>
<Message>Success!</Message>
</Error>
<Cte>
<CteKey>35180288085485006064570000019685431692318880</CteKey>
<Exist>true</Exist>
<OnCloud>true</OnCloud>
<CdP>PENDENTE</CdP>
<Gov>
<cStat>731</cStat>
<xMotivo>Rejeição: Consulta a uma Chave de Acesso muito antiga</xMotivo>
<DateOfCheck>2018-10-11T13:30:02</DateOfCheck>
<From>2</From>
<FromStatus>Success!</FromStatus>
</Gov>
</Cte>
</QueryForFileResult>
Onde:
QueryForFileListResult
tag pai que englobará toda a resposta;
rid
id do retorno obtido;
Error
Status de erro do arquivo
- Code -> Código do erro
- 101: Key to Access(access-key) does not exist -> Chave passada não existe;
- 102: Required parameter (access-key) not supplied -> Chave não fornecida;
- 103: Composed parameter find is bad formed -> Falha nos parâmetro passados;
- 0: Success -> Sucesso na requisição;
- Message: Mensagem de retorno da API;
Cte
tag pai da CT-e onde terá as informações do arquivo
- CteKey: Chave de acesso do Conhecimento de Transporte;
- Exist: Arquivo está ou não armazenado;
- OnCLoud: sempre será true;
- CdP: Status do Controle de Portaria para a Nota buscada;
- Gov: Tag pai para o resultado do status da nota na SEFAZ
- cStat: Código do status;
- xMotivo: Descrição do status de operação da nota na SEFAZ;
- DateOfCheck: Data que foi registrado a ciência da operação da nota na SEFAZ;
- From: Indica “2” quando houve consulta no SEFAZ e “1” quando não houve;
- FromStatus: Descrição do Código do Status;
Performance nas buscas
Esta API tem por finalidade lhe trazer as informações de um CT-e específico, funcionando muito bem quando chamada através dos dados obtidos pela API domain_product_cte_query_for_file_list! Permite ainda haver uma consulta personalizada para o seu ERP, já que, através do parâmetro return-full-file é possível buscar o XML Completo da nota ou apenas conferir algumas informações.