WS615 - Exportar relatório de Frete Extra

Esta integração tem por objetivo exportar o relatório de Frete Extra do Comprovei

Autenticação

• As chamadas terão autenticação a nível de transporte (Basic Authentication);
• Solicite o user / password ao administrador da conta.

Características

• URL

  https://api.comprovei.com.br/api/1.1/util/export/extraFreights

• Método:

  POST

• Parâmetro URL:

  Sem parâmetros

Filtros

Campo	Tipo	Descrição
data_rota_inicial	string (data)	Data inicial do período da rota
data_rota_final	string (data)	Data final do período da rota
data_transporte_inicial	string (data)	Data inicial do período de transporte
data_transporte_final	string (data)	Data final do período de transporte
numero_rota	array de strings	Números de rota
regioes	array de strings	Regiões
numero_guia	array de strings	Números de guia
approve_status	array de números	Status de aprovação (valores de 0 a 4; ver tabela abaixo)

Valores de approve_status

O filtro approve_status aceita os valores numéricos abaixo, com o seguinte significado:

Valor	Significado
0	Lançado
1	Para Aprovação
2	Aprovado
3	Reprovado
4	Excluído

• Exemplo:

  {
      "headers": {
          "username": "usuario",
          "password": "senha"
      },
      "body": {
          "formato_exportacao" : "xml",
          "filtros": {
              "data_rota_inicial": "2020-01-01",
              "data_rota_final": "2020-01-31",
              "data_transporte_inicial": "2020-01-01",
              "data_transporte_final": "2020-01-31",
              "numero_rota": ["String", "String2"],
              "regioes": ["String", "String2"],
              "numero_guia": ["String", "String2"],
              "approve_status": [0, 1, 2]
          },
          "campos": [
              "Rota",
              "Marca",
              "CD",
              "Data Faturamento",
              "Prestador do Serviço",
              "CNPJ Prestador",
              "Tipo Lançamento",
              "Motorista",
              "Causa",
              "Motivo",
              "Região Rota",
              "UF",
              "Volume",
              "C. Custo",
              "Valor Transportado",
              "Valor Frete",
              "Status de Aprovação",
              "Número Guia",
              "Assinado",
              "Registrador",
              "Líquido",
              "ICMS",
              "PIS/COFINS",
              "Aprovado/Reprovado por",
              "Placa",
              "Observação",
              "Tipo Rota",
              "Data de criação",
              "Perfil Veículo",
              "Início da Rota",
              "Data de Importação",
              "Data de Transporte"
          ],
          "campos_inclusos": [
              "Rota",
              "Marca",
              "CD",
              "Data Faturamento",
              "Prestador do Serviço",
              "CNPJ Prestador",
              "Tipo Lançamento",
              "Motorista",
              "Causa",
              "Motivo",
              "Região Rota",
              "UF",
              "Volume",
              "C. Custo",
              "Valor Transportado",
              "Valor Frete",
              "Status de Aprovação",
              "Número Guia",
              "Assinado",
              "Registrador",
              "Líquido",
              "PIS/COFINS",
              "ICMS",
              "Aprovado/Reprovado por",
              "Placa",
              "Observação",
              "Tipo Rota",
              "Data de criação",
              "Perfil Veículo",
              "Início da Rota",
              "Data de Importação",
              "Data de Transporte"
          ]
      }
  }
  

  Importante

  • "campos" é usado para definir os nomes dos campos que devem ser utilizados na exportação. Nenhum campo deve ser adicionado ou retirado, apenas alterados.
  • O campo "campos" não deve ter sua ordem alterada, porém o nome dos campos pode ser alterado para a exportação.
  • Se o campo "campos" e "campos_inclusos" não forem passados, serão usados o padrão do sistema determinado pelo time suporte.
  • Alguns campos não serão enviados por padrão por exigirem muito processamento, mesmo quando passados nos parâmetros, devido ao grande nivel de processamento exigido. Caso o campo seja realmente necessário, entre em contato com o suporte para que seja liberado para o seu usuário em questão.
  • Em "campos_inclusos" é possível selecionar quais campos e em que ordem eles serão exportados, os nomes dos campos devem ser iguais ao do campo "campos". Caso queira exportar todos os campos, não acrescentar "campos_inclusos".
  • Em "formato_exportação" é possível selecionar qual modelo da exportação, são aceitos: xml, xls, json e csv;

  Exemplo de Response

  • Sucesso:

    {
        "statusCode": 200,
        "headers": {
            "Content-Type": "application/json",
            "Access-Control-Allow-Origin": "*",
            "Access-Control-Allow-Credentials": true
        },
        "body": {
            "user_message": "https://comprovei.s3.amazonaws.com/producao/report_requests/export/21/routeExport-20200525192526.csv.zip?  X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJELIIV2RATTMVK7A%2F20200525%2Fus-east-1%2Fs3%2Faws4_request&    X-Amz-Date=20200525T192538Z&X-Amz-Expires=259200&   X-Amz-Signature=19d54276cff1a3f1e074bac3e5f7737d670030f5bfb8267fbfebeb335a2dfca4&X-Amz-SignedHeaders=host",
            "code": 0,
            "internal_message": "Exportação gerada com sucesso!",
            "response_data": ""
        }
    }
    

  • Erro:

    {
        "statusCode": 400,
        "headers": {
            "Content-Type": "application/json",
            "Access-Control-Allow-Origin": "*",
            "Access-Control-Allow-Credentials": true
        },
        "body": {
            "message": "Não foram encontrados resultados para os filtros selecionados!"
        }
    }
    

  • Erro:

    {
        "statusCode": 400,
        "headers": {
            "Content-Type": "application/json",
            "Access-Control-Allow-Origin": "*",
            "Access-Control-Allow-Credentials": true
        },
        "body": {
            "message": "Algum campo de data está no formato errado. Tente (aaaa-mm-dd)"
        }
    }
    

    • Erro:

      {
          "statusCode": 400,
          "headers": {
              "Content-Type": "application/json",
              "Access-Control-Allow-Origin": "*",
              "Access-Control-Allow-Credentials": true
          },
          "body": {
              "message": "O intervalo de datas não pode ter mais de 31 dias"
          }
      }