WS609 - Export Collections report

This integration aims to export the Comprovei Collections report

Authentication

• Calls will have transport-level authentication (Basic Authentication);
• Request user / password from the account administrator.

Features

• URL

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

• Method:

  POST

• URL parameter:

  No parameters

• Example:

  {
      "headers": {
          "username": "usuario",
          "password": "senha"
      },
      "body": {
          "formato_exportacao" : "xml",
          "filtros": {
              "data_inicial": "2020-01-01",
              "data_final": "2020-01-01",
              "tipo_rota": ["int", "int2"],
              "regioes": ["String", "string2"],
              "codigo_transportador":["String", "String2"],
              "embarcadores":["String", "String2"]
          },
          "campos": [
              "Data da Rota",
              "Nome da Rota",
              "Status",
              "Placa Carreta",
              "Nome do Motorista",
              "CNPJ Emitente",
              "Emitente",
              "CNPJ Destinatário",
              "Destinatário",
              "Data de Emissão",
              "NF",
              "Volumes Documento",
              "Volumes Conferidos",
              "Valor",
              "44digitos",
              "Série"
          ],
          "campos_inclusos": [
              "Nome do Motorista",
              "CNPJ Emitente",
              "Emitente",
              "CNPJ Destinatário",
              "Destinatário",
              "Data de Emissão"
          ]
      }
  }
  

  Important

  • "fields" is used to define the names of the fields that should be used in the export. No fields should be added or removed, just changed.
  • The "fields" field must not have its order changed, however the name of the fields can be changed for export.
  • If the "fields" and "included_fields" fields are not passed, the system default determined by the support team will be used.
  • Some fields will not be sent by default because they require a lot of processing, even when passed in the parameters, due to the high level of processing required. If the field is really necessary, contact support to have it released to your user in question.
  • In "included_fields" it is possible to select which fields and in what order they will be exported, the field names must be the same as the "fields" field. If you want to export all fields, do not add "included_fields".
  • In "formato_exportação" it is possible to select which export model, the following are accepted: xml, xls, json and csv;

  Response Example

  • Success:

    {
        "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": ""
        }
    }
    

  • Error:

    {
        "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!"
        }
    }
    

  • Error:

    {
        "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)"
        }
    }
    

    • Error:

      {
          "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"
          }
      }