← InícioFleetPay / API

Simular memória de cálculo e auditoria de tabela de frete

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/embarcador/auditoria-frete/simular
simularAuditoriaFreteEmbarcadorBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

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.

Autenticação

Escopo Necessário
consultas — Consultas
Módulo
Faturas e Auditoria de Fretes
Perfis Aplicáveis
Embarcador · Gestor de Transporte
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

Parâmetros do frete e ID da tabela de frete.

application/json

freight_rate_table_idintegerObrigatório
charged_amountnumberObrigatório
weight_kgnumber | nullOpcional
distance_kmnumber | nullOpcional
origin_ufstring | nullOpcional
destination_ufstring | nullOpcional

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

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

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

422 Resposta HTTP

Parâmetros de simulação inválidos.

Definição Completa da Operação
{
  "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": []
}