Ir para o conteúdo

Consulta de Faturas por Período V2

GET https://freterapido.com/api/external/embarcador/v2/quote/doccob/find?token=[seu_token]&start_date=[data_inico]&end_date=[data_fim]&payment_status=[status_pagamento_fatura]

Método que permite consultar os componentes de uma Fatura (DOCCOB), dentro de um período especificado.

Serão retornado os dados disponíveis sobre a Fatura. Basta informar o token de integração, o intervalo desejado de início e fim, status de pagamento da fatura(0 -> "open" (aberta), 1 -> "paid"(paga) e 2 -> "cancelled" (cancelada)), e, caso queira, também retorna os CT-es contidos na fatura.

Envio:

Parâmetros da URL:

Nome Descrição Formato / Exemplo Obrigatório
token Token de integração String de 32 caracteres *
start_date Data inicial do período Datetime (YYYY-MM-DD hh:mm) *
end_date Data final do período Datetime (YYYY-MM-DD hh:mm) *
payment_status Status de pagamento da Fatura (0 - aberta, 1 - paga e 2 - cancelada) Inteiro *
page Quantidade de faturas exibidas por página na consulta Inteiro *
status Status da Fatura em auditoria (1 - em processamento, 2 - com divergência, 3 - em negociação, 4 - liberada, 6 - cancelada)
Se informado, as faturas virão na resposta de acordo com o status informado		 Inteiro *
cte_status Filtro por CT-es que gera uma URL de consulta para a 'API' de CT-es (0 - em processamento, 1 - com divergência, 2 - em negociação, 3 - pré-liberado, 4 - liberado, 5 - rejeitado)
Se informado, a URL vira na resposta, em "uri_list_ctes"		 Inteiro *
* 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 da Fatura (doccob) 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 *
next_page Próxima página Inteiro *
data Array com os dados da fatura paginados Array *
 id Identificador interno Inteiro *
 file_type Tipo de arquivo Inteiro *
 user_cnpj CNPJ do usuário String Numérica *
 document_version Versão da fatura String Numérica *
 document_type Tipo do documento String *
 serie Série da fatura String Numérica *
 number Número da fatura String Numérica *
 billing_document_id ID do documento de faturamento String Numérica *
 carrier_id Identificador da transportadora Inteiro *
 carrier_register_number CNPJ da transportadora String Numérica *
 carrier_corporate_name Razão social da transportadora String Numérica *
 shipper_id Identificador do embarcador Inteiro *
 shipper_register_number CNPJ do embarcador String Numérica *
 shipper_corporate_name Razão social do embarcador String *
 dispatcher_id Identificador do expedidor Inteiro *
 issue_date Data da emissão da fatura DateTime ("YYYY-MM-DD hh:mm:ss") *
 due_date Data do vencimento da fatura DateTime ("YYYY-MM-DD hh:mm:ss") *
 total_value Valor total da fatura String Numérica *
 divergence_total Valor de divergência String Numérica *
 total_ctes Quantidade de CT-es Inteiro *
 charge_type Tipo de cobrança String *
 status Status da fatura String *
 status_log Log de status JSON *
 payment_status Status de pagamento String *
 code Código da fatura String *
 late_fee_percentage Percentual de multa por atraso String Numérica *
 interest_value_day_delay Valor de juros por dia de atraso String Numérica *
 discount_date_limit Data limite de desconto Date ("YYYY-MM-DD") *
 discount_value Valor do desconto String Numérica *
 bank_code Código do banco String Numérica *
 bank_name Nome do banco String *
 agency_number Número da agência String Numérica *
 agency_digit Dígito da agência String Numérica *
 account_number Número da conta corrente String Numérica *
 account_digit Dígito da conta corrente String Numérica *
 action Ação do documento String *
 identification Identificação String Numérica *
 complementary_identification Identificação complementar String *
 cfop Código de CFOP String Numérica *
 invoice_access_key Chave de acesso da Nota Fiscal String Numérica *
 invoice_return_access_key Chave de retorno da NF-e String Numérica *
 invoice_protocol Protocolo de autorização da Nota Fiscal String *
 value_icms Valor da taxa de ICMS String Numérica *
 percentage_icms Alíquota ICMS String Numérica *
 base_icms Base ICMS utilizado String Numérica *
 value_iss Valor da taxa de ISS String Numérica *
 percentage_iss Alíquota ISS String Numérica *
 base_iss Base de cálculo do ISS String Numérica *
 value_icms_st Valor da taxa de ICMS ST String Numérica *
 percentage_icms_st Alíquota ICMS ST String Numérica *
 base_icms_st Base ICMS ST utilizado String Numérica *
 value_income_tax Valor da taxa de IR String Numérica *
 created_at Data de criação Date ("YYYY-MM-DD") *
 updated_at Data de atualização Date ("YYYY-MM-DD") *
 uri_list_ctes URL para consulta de CT-es String *

*Dados Obrigatórios

Exemplo: 

    {
        "total": 0,
        "per_page": 0,
        "last_page": 0,
        "current_page": 0,
         "data": [
             {
                    "id": "0",
                    "file_type": "",
                    "user_cnpj": "",
                    "document_version": "0",
                    "document_type": "0",
                    "serie": "0",
                    "number": "0",
                    "billing_document_id": "",
                    "carrier_id": "0",
                    "carrier_register_number": "",
                    "carrier_corporate_name": "",
                    "shipper_id": "0",
                    "shipper_register_number": "",
                    "shipper_corporate_name": "",
                    "dispatcher_id": "0",
                    "issue_date": "0000-00-00",
                    "due_date": "0000-00-00",
                    "total_value": "0",
                    "divergence_total": "0",
                    "total_ctes": "0",
                    "charge_type": "",
                    "status": "",
                    "status_log": "",
                    "payment_status": "",
                    "code": "",
                    "late_fee_percentage": "0",
                    "interest_value_day_delay": "0",
                    "discount_date_limit": "0000-00-00",
                    "discount_value": "0",
                    "bank_code": "0",
                    "bank_name": "",
                    "agency_number": "0",
                    "agency_digit": "0",
                    "account_number": "0",
                    "account_digit": "0",
                    "action": "",
                    "identification": "",
                    "complementary_identification": "",
                    "cfop": "0",
                    "invoice_access_key": "",
                    "invoice_return_access_key": "",
                    "invoice_protocol": "",
                    "value_icms": "0",
                    "percentage_icms": "0",
                    "base_icms": "0",
                    "value_iss": "0",
                    "percentage_iss": "0",
                    "base_iss": "0",
                    "value_icms_st": "0",
                    "percentage_icms_st": "0",
                    "base_icms_st": "0",
                    "value_income_tax": "0",
                    "created_at": "0000-00-00 00:00:00",
                    "updated_at": "0000-00-00 00:00:00",
                    "uri_list_ctes": "https://freterapido.com/api/external/embarcador/v2/quote/cte/$",
                }
            ]
        }
Voltar ao topo