Consulta de DOCCOB por Período
GET https://freterapido.com/api/external/embarcador/v1/quote/doccob/find?token=[seu_token]&tipo_data=[tipo_data]&status_fatura=[status_fatura]&data_inicio=[data_inicio]&data_fim=[data_fim]
Método que permite consultar os componentes de um DOCCOB (fatura), dentro de um período especificado.
Serão retornado os dados disponíveis sobre o DOCCOB. Basta informar o token de integração, tipo da data desejado (emissão, processamento, criação), o intervalo desejado de início e fim, e caso queira, a quantidade por página, CNPJ da transportadora e do expedidor, e o status 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 a fatura por (0 - emissão, 1 - processamento ou 2 - criação) | Inteiro | * |
| status_fatura | Status da fatura (0 - aberta, 1 - paga, 2 - vencida, 3 - cancelada) | 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) | * |
| por_pagina | Quantidade de faturas exibidas por página na consulta | Inteiro | Opcional |
| cnpj_transportadora | CNPJ da transportadora | Inteiro | Opcional |
| cnpj_expedidor | CNPJ do expedidor | Inteiro | Opcional |
| status_cte | Status do CT-e (0 - pendente, 1 - liberado, 2 - rejeitado)Se informado, os CT-es virão na resposta | 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 DOCCOB (fatura) 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 | * |
| fatura | Array com os dados da fatura paginados | Array | * |
| versao | Versão da fatura | String Númerica | * |
| cnpj_transportadora | CNPJ da transportadora | String Númerica | * |
| tipo_documento | Tipo do documento | String | * |
| serie | Série da fatura | String Númerica | * |
| numero | Número da fatura | String Númerica | * |
| data_emissao | Data da emissão da fatura | DateTime ("YYYY-MM-DD hh:mm:ss") | * |
| data_vencimento | Data do vencimento da fatura | DateTime ("YYYY-MM-DD hh:mm:ss") | * |
| valor_total | Valor total da fatura | String Númerica | * |
| percentual_multa_atraso | Percentual de multa por atraso | String Númerica | Opcional |
| valor_juros_dia_atraso | Valor de juros por dia de atraso | String Númerica | Opcional |
| data_limite_desconto | Data limite de desconto | Date ("YYYY-MM-DD") | Opcional |
| valor_desconto | Valor do desconto | String Númerica | Opcional |
| codigo_banco | Código do banco | String Númerica | Opcional |
| nome_banco | Nome do banco | String | Opcional |
| numero_agencia | Número da agência | String Númerica | Opcional |
| digito_agencia | Dígito da agência | String Numérica | Opcional |
| numero_conta_corrente | Número da conta corrente | String Númerica | Opcional |
| digito_conta_corrente | Dígito da conta corrente | String Númerica | Opcional |
| acao_documento | Ação do documento | String | * |
| identificacao | Identificação | String Numérica | Opcional |
| identificacao_complementar | Identificação complementar | String | Opcional |
| cfop | Código de CFOP | String Númerica | Opcional |
| chave_acesso_nfe | Chave de acesso da Nota Fiscal | String Númerica | Opcional |
| chave_acesso_nfe_dv | Dígito Verificador da chave de acesso da Nota Fiscal | String Númerica | Opcional |
| protocolo_nfe | Protocolo de autorização da Nota Fiscal | String | Opcional |
| total_icms | Valor da taxa de ICMS | String Númerica | Opcional |
| aliquota_icms | Alíquota ICMS | String Númerica | Opcional |
| base_calculo_icms | Base ICMS utilizado | String Númerica | Opcional |
| total_iss | Valor da taxa de ISS | String Númerica | Opcional |
| base_calculo_iss | Base de cálculo do ISS | String Númerica | Opcional |
| total_icms_st | Valor da taxa de ICMS ST | String Númerica | Opcional |
| aliquota_icms_st | Alíquota ICMS ST | String Númerica | Opcional |
| base_calculo_icms_st | Base ICMS ST utilizado | String Númerica | Opcional |
| total_ir | Valor da taxa de IR | String Númerica | Opcional |
| status | Status da fatura | String | * |
| data | Data da fatura | DateTime ("YYYY-MM-DD hh:mm:ss") | * |
| quantidade_ctes | Quantidade de CT-es | Inteiro | * |
| quantidade_ctes_faltando | Quandidade de CT-es faltando | Inteiro | * |
| ctes | Array de CT-es (retornarão somente se "status_cte" for informado na URL) | String Númerica | Opcional |
*Dados Obrigatórios |
digito verfificador Fiscal
Exemplo:
{
"total": 0,
"per_page": 0,
"last_page": 0,
"current_page": 0,
"data": {
"fatura": [
{
"versao": "0",
"cnpj_transportadora": "01234567891011",
"tipo_documento": "",
"serie": "0",
"numero": "0000000",
"data_emissao": "0000-00-00 00:00:00",
"data_vencimento": "0000-00-00",
"valor_total": "0.00",
"percentual_multa_atraso": "0.00",
"valor_juros_dia_atraso": "0.00",
"data_limite_desconto": "0000-00-00",
"valor_desconto": "0.00",
"codigo_banco": "0",
"nome_banco": "",
"numero_agencia": "0",
"digito_agencia": "",
"numero_conta_corrente": "0",
"digito_conta_corrente": "",
"acao_documento": "",
"identificacao": "0",
"identificacao_complementar": "",
"cfop": "",
"chave_acesso_nfe": "0",
"chave_acesso_nfe_dv": "",
"protocolo_nfe": "",
"total_icms": "0.00",
"aliquota_icms": "0.00",
"base_calculo_icms": "0.00",
"total_iss": "0.00",
"base_calculo_iss": "0.00",
"total_icms_st": "0.00",
"aliquota_icms_st": "0.00",
"base_calculo_icms_st": "0.00",
"total_ir": "0.00",
"status": "",
"data": "0000-00-00 00:00:00",
"quantidade_ctes": 0,
"quantidade_ctes_faltando": 0,
"ctes": []
}
]
}
}