← InicioFleetPay / API

Simular cálculo y auditoría de tabla de fletes

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/embarcador/auditoria-frete/simular
simularAuditoriaFreteEmbarcadorBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Calcula el flete esperado a partir de una tabla (freight_rate_table_id), peso, distancia y componentes informados, indicando la divergencia estimada sin grabar caso definitivo. Requiere permiso consultas.

Autenticación

Permiso Requerido
consultas — Consultas
Módulo
Facturas y Auditoría de Fletes
Perfiles Aplicables
Embarcador · Gestor de Transporte
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Cuerpo de la Solicitud

Obligatorio

Parámetros del flete e ID de la tabla de fletes.

application/json

freight_rate_table_idintegerObligatorio
charged_amountnumberObligatorio
weight_kgnumber | nullOpcional
distance_kmnumber | nullOpcional
origin_ufstring | nullOpcional
destination_ufstring | nullOpcional

Respuestas

200 Respuesta HTTP

Operación procesada con éxito.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Respuesta HTTP

Credencial ausente, inválida o de otro entorno.

403 Respuesta HTTP

Permiso del panel no habilitado o recurso fuera del alcance de la company.

422 Respuesta HTTP

Parámetros de simulación inválidos.

Definición Completa de la Operación
{
  "tags": [
    "Auditoria de Frete"
  ],
  "operationId": "simularAuditoriaFreteEmbarcador",
  "summary": "Simular memória de cálculo e auditoria de tabela de frete",
  "description": "Calcula o frete esperado a partir de uma tabela (`freight_rate_table_id`), peso, distância e componentes informados, indicando divergência estimada sem gravar caso definitivo. Exige escopo `consultas`.",
  "requestBody": {
    "required": true,
    "description": "Parâmetros do frete e ID da tabela de frete.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "freight_rate_table_id",
            "charged_amount"
          ],
          "properties": {
            "freight_rate_table_id": {
              "type": "integer"
            },
            "charged_amount": {
              "type": "number"
            },
            "weight_kg": {
              "type": [
                "number",
                "null"
              ]
            },
            "distance_km": {
              "type": [
                "number",
                "null"
              ]
            },
            "origin_uf": {
              "type": [
                "string",
                "null"
              ]
            },
            "destination_uf": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Operação processada com sucesso.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "meta": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true
              },
              "ambiente": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    },
    "422": {
      "description": "Parâmetros de simulação inválidos."
    }
  },
  "x-fleetpay-scope": "consultas",
  "x-fleetpay-module": "faturas-auditoria",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor"
  ],
  "method": "POST",
  "path": "/embarcador/auditoria-frete/simular",
  "parameters": []
}