API : domain_product_cte_query_for_canceled_file_list
PRODUTO: CT-e

Funcionalidade: A Dokfile, através de uma série de argumentos, busca todas as CT-es armazenadas que tenham status de Autorizada ou então status de Cancelada e retorna uma lista com informações de cada nota.

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.

Data Inicial

Neste parâmetro é escolhido uma data inicial para referência na busca dos arquivos.

Data Final

Neste parâmetro é escolhido uma data final para referência na busca dos arquivos.

Trazer

Neste parâmetro deve ser definido um sub-tipo de arquivo, que pode ser todos arquivos, somente autorizadas ou somente saída.

CNPJ Tomador

Neste parâmetro deve ser definido o CNPJ do tomador das notas.

Tipo do CT-e

Neste parâmetro deve ser definido uma Operação CT-e, que pode ser entrada ou saída.

CIF-FOB

Neste parâmetro é selecionado o tipo de transporte, podendo ser CIF ou FOB.


Exemplo e Estrutura de uma chamada:

Método:

URL: https://Base/domain_product_cte_query_for_canceled_file_list?access-key=SEUTOKEN&start-date=d:01:m:09:y:2018&end-date=d:30:m:09:y:2018&bring=3&cnpj-toma=cnjp&cte-type=2&cif-fob=1

Base: Domínio da api (entre em contato para receber o domínio)

API: /domain_product_cte_query_for_canceled_file_list

Token: ?access-key=SEUTOKEN

Data inicial: &start-date:d:01:m:09:y:2018 ( d = dia; m = mês; y = ano; )

Data final: &end-date:d:30:m:09:y:2018 ( d = dia; m = mês; y = ano; )

Trazer: &bring=3 (1 = Todos arquivos; 2 = arquivos autorizados; 3 = arquivos canceladas;)

CPNJ Tomador: &cnpj-toma=cnpj

Tipo do CT-e: &cte-type=2 ( 0 = desconhecido; 1 = entrada; 2 = saída; )

CIF-FOB: &cif-fob=1 (1 = CIF; 2 = FOB)


Exemplo de Retorno


<?xml version="1.0" encoding="UTF-8"?>
    <QueryForCanceledFileListResult>
        <rid>40507de3-d9ff-42d3-88ec-0fed1d44ac79</rid>
        <StartDate>20180901</StartDate>
        <EndDate>20180930</EndDate>
        <CountFile>1</CountFile>
        <Error>
            <Code>0</Code>
            <Message>Success!</Message>
        </Error>
        <Cte>
            <CteType>2</CteType>
            <CteKey>35180926430486000191570010000402591000953216</CteKey>
            <CNPJ>26430486000191</CNPJ>
            <cStat>101</cStat>
            <xMotivo>Cancelamento de CT-e homologado</xMotivo>
            <DateOfCheck>2018-09-19 23:43:08</DateOfCheck>
            <dhEmi>2018-09-19 17:24:18</dhEmi>
            <cloud>0</cloud>
            <toma>0</toma>
            <tomaType>1</tomaType>
            <CNPJToma>53199741000100</CNPJToma>
        </Cte>
    </QueryForCanceledFileListResult>

Onde:

QueryForCanceledFileListResult
tag pai que englobará toda a resposta;

rid
id do retorno obtido;

StartDate
Data de inicio da busca dos arquivos;

EndDate
Data limite da busca dos arquivos;

CountFile
Quantidade de eventos de CT-es retornadas;

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 do evento de CT-e onde terá as informações do arquivo

  • CteType: 2;
  • CteKey: Chave de acesso de Conhecimento de Transporte;
  • CNPJ: CNPJ do emitente;
  • cStat-> Código do evento
    • 100: Autorizado;
    • 101: Cancelada;
    • 127: Anulada pelo emissor;
  • xMotivo: Descrição do cStat;
  • DateOfCheck: Data da última checagem do sistema à SEFAZ;
  • dhEmi: Data da emissão do arquivo;
  • cloud: Sempre será 0(zero);
  • toma:
  • tomaType:
  • CNPJToma: CNPJ do tomador;

Performance nas buscas

Esta API tem por finalidade lhe trazer as informações mais cruciais sobre os CT-es através de alguns filtros como, Data, tipo de arquivo e até mesmo CT-es CIF ou FOB.

 

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *