Consulta de Conhecimento de Transporte por Período
GET https://freterapido.com/api/external/embarcador/v1/quote/cte/find?data_inicio=[data_inicio]&data_fim=[data_fim]&tipo_data=[tipo_data]&pagina=[pagina]&tipo_cte[tipo_cte]token=[seu_token]
Método que permite consultar os componentes de um conhecimento de transporte vinculado à uma nota fiscal, dentro de um período especificado.
Serão retornado os dados disponíveis sobre o conhecimento de transporte paginado. Basta informar o token de integração, tipo da data desejado (emissão, processamento, criação), intervalo desejado de início e fim, a página, e o tipo do CT-e conforme a estrutura abaixo.
Envio:
Parâmetros da URL:
| Nome | Descrição | Formato / Exemplo | Obrigatório |
|---|---|---|---|
| token | Token de integração | String de 32 caracteres | * |
| tipo_data | Consulta o conhecimento de transporte por (1 - emissão, 2 - processamento ou 3 - criação) | Inteiro | * |
| data_inicio | Data inicial do período | Datetime (YYYY-MM-DD hh:mm) | * |
| data_fim | Data final do período | Datetime (YYYY-MM-DD hh:mm) | * |
| pagina | Página desejada na consulta, caso não informe, por padrão será retornado a primeira página | Inteiro | Opcional |
| tipo_cte | Informação do CT-e vinculado ao módulo de auditoria de frete (0 - Pendente, 1 - Aprovado ou 2 - Rejeitado) | Inteiro | Opcional |
| * Dados obrigatórios |
Resposta:
- Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200, juntamente com um array dos dados do conhecimento de transporte consultado naquele período escolhido.
| Nome | Descrição | Formato / Exemplo | Obrigatório |
|---|---|---|---|
| total | Total de registros retornados | Inteiro | * |
| per_page | Quantidade de registros por página | Inteiro | * |
| last_page | Última página | Inteiro | * |
| current_page | Página atual | Inteiro | * |
| data | Array com os dados do CT-e paginado | Array | * |
| link | Link para download do arquivo quando disponível | String | Opcional |
| chave | Chave de acesso do CT-e | String de 44 caracteres | * |
| serie | Série do CT-e | String Númerica | Opcional |
| numero | Número do CT-e | String Númerica | Opcional |
| valor | Valor total do frete (CT-e) | String Númerica | Opcional |
| valor_frete | Valor total do frete | String Númerica | Opcional |
| peso_bruto | Peso bruto da mercadoria | String Númerica | Opcional |
| peso_cubado | Peso cubado aferido | String Númerica | Opcional |
| tipo_operacao | Código do tipo de operação | String | Opcional |
| data | Data e hora que recebemos o CT-e | DateTime ("YYYY-MM-DD hh:mm:ss") | * |
| data_emissao | Data e hora de emissão do Conhecimento pela transportadora | DateTime ("YYYY-MM-DD hh:mm:ss") | Opcional |
| cnpj_consignatario | CNPJ do consignatário | String de 14 caracteres | Opcional |
| cnpj_emissor_conhecimento | CNPJ do emissor do Conhecimento | String de 14 caracteres | Opcional |
| cnpj_emissor_nf | CNPJ do emissor da Nota Fiscal | String de 14 caracteres | Opcional |
| peso_taxado | Peso considerado no cálculo | String Númerica | Opcional |
| tipo_frete | Tipo de frete | String (C or F) | Opcional |
| base_calculo_icms | Base ICMS utilizado | String Númerica | Opcional |
| percentual_icms | Alíquota ICMS | String Númerica | Opcional |
| valor_icms | ICMS calculado | String Númerica | Opcional |
| quantidade_volumes | Quantidade de volumes | Inteiro | Opcional |
| valor_frete_peso_volume | Valor frete peso | String Númerica | Opcional |
| valor_coleta | Valor da taxa de coleta | String Númerica | Opcional |
| valor_despacho | Valor da taxa de despacho | String Númerica | Opcional |
| valor_redespacho | Valor da taxa redespacho | String Númerica | Opcional |
| valor_adicional | Outras taxas extras | String Númerica | Opcional |
| pedagio | Valor taxa de pedágio | String Númerica | Opcional |
| aliquota_difal_origem | Alíquota DIFAL de origem | String Númerica | Opcional |
| aliquota_difal_destino | Alíquota DIFAL de origem | String Númerica | Opcional |
| difal_icms_origem | Percentual DIFAL origem | String Númerica | Opcional |
| difal_icms_destino | Percentual DIFAL destino | String Númerica | Opcional |
| advalorem | Ad Valorem | String Númerica | Opcional |
| ademe | Valor da taxa de ADEME | String Númerica | Opcional |
| sec_cat | Valor taxa SEC/CAT | String Númerica | Opcional |
| itr | Valor taxa ITR | String Númerica | Opcional |
| tep | Valor do TEP | String Númerica | Opcional |
| trt | Valor do TRT | String Númerica | Opcional |
| tas | Valor do TAS | String Númerica | Opcional |
| suframa | Valor da taxa de SUFRAMA | String Númerica | Opcional |
| iss | Valor da taxa de ISS | String Númerica | Opcional |
| iss_base_calculo | Base de cálculo do ISS | String Númerica | Opcional |
| iss_percentual | Percentual do ISS | String Númerica | Opcional |
| gris | Valor do GRIS | String Númerica | Opcional |
| pis | Valor do tributo PIS | String Númerica | Opcional |
| cofins | Valor do tributo COFINS | String Númerica | Opcional |
| imposto_renda | Imposto renda | String Númerica | Opcional |
| cubagem | Cubagem da mercadoria | String Númerica | Opcional |
| substituicao_tributaria | Se tem ou não substituição tributária | Inteiro | Opcional |
| cfop | Código de CFOP | Inteiro | Opcional |
| tipo_transporte | Código do tipo de transporte | String (vide códigos anexos) | Opcional |
| processamento | Data e hora do processamento do EDI na Transportadora | DateTime ("YYYY-MM-DD hh:mm:ss") | Opcional |
| protocolo | Número do Protocolo do CT-e na SEFAZ | String | Opcional |
| codigo_status_auditoria | Código do satus_auditoria, sendo 0 - pendente, 1 - aprovado e 2 - rejeitado. Caso o CT-e não esteja presente no módulo retornará como NULL. | Inteiro | * |
| status_auditoria | Informa se o CT-e está pendente, aprovado ou rejeitado no módulo de auditoria. Caso o CT-e não esteja presente no módulo retornará como NULL. | String | * |
*Dados Obrigatórios
Exemplo:
{
"total": 0,
"per_page": 0,
"last_page": 0,
"current_page": 0,
"data": [
{
"link": "",
"chave": "",
"serie": "",
"numero": "",
"valor": "0.00",
"valor_frete": "0.00",
"peso_bruto": "0.00",
"peso_bruto": "0.00",
"tipo_operacao": "",
"data": "",
"data_emissao": "",
"cnpj_consignatario": "",
"cnpj_emissor_conhecimento": "",
"cnpj_emissor_nf": "",
"peso_taxado": "0.00",
"tipo_frete": "",
"base_calculo_icms": "0.0",
"percentual_icms": "0.0",
"valor_icms": "0.0",
"quantidade_volumes": 0,
"valor_frete_peso_volume": "",
"valor_coleta": "",
"valor_despacho": "",
"valor_redespacho": "",
"valor_adicional": "",
"pedagio": "",
"aliquota_difal_origem": "",
"aliquota_difal_destino": "",
"difal_icms_origem": "",
"difal_icms_destino": "",
"advalorem": "",
"ademe": "",
"sec_cat": "",
"itr": "",
"tep": "",
"trt": "",
"tas": "",
"suframa": "",
"iss": "",
"iss_base_calculo": "",
"iss_percentual": "",
"gris": "",
"pis": "",
"cofins": "",
"cubagem": "",
"substituicao_tributaria": 0,
"cfop": 0,
"tipo_transporte": "",
"processamento": "",
"protocolo": "",
"codigo_status_auditoria": 0,
"status_auditoria": ""
}
]
}