← InícioFleetPay / API

Registrar decisão comercial ou contestação em caso de auditoria

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

POST/embarcador/auditoria-frete/casos/{uuid}/decisao
decidirCasoAuditoriaFreteBase 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.

Aprova integralmente (approve_full), aceita valor faturado (accept_charged), envia contraproposta (counterproposal, validada contra o piso mínimo da ANTT) ou rejeita (reject), disparando webhook auditoria.caso_decidido. Exige escopo operacao.

Autenticação

Escopo Necessário
operacao — Operação
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

uuidpath · stringObrigatório

UUID ou ID numérico do caso de auditoria.

Restrições
{
  "type": "string"
}

Corpo da Requisição

Obrigatório

Decisão comercial sobre o caso de auditoria.

application/json

decisionstringObrigatório
"approve_full" · "accept_charged" · "counterproposal" · "reject"
counterproposal_amountnumber | nullOpcional

Obrigatório quando decision = counterproposal.

notesstring | 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.

404 Resposta HTTP

Caso não encontrado.

422 Resposta HTTP

Violação do piso ANTT ou transição inválida.

Definição Completa da Operação
{
  "tags": [
    "Auditoria de Frete"
  ],
  "operationId": "decidirCasoAuditoriaFrete",
  "summary": "Registrar decisão comercial ou contestação em caso de auditoria",
  "description": "Aprova integralmente (`approve_full`), aceita valor faturado (`accept_charged`), envia contraproposta (`counterproposal`, validada contra o piso mínimo da ANTT) ou rejeita (`reject`), disparando webhook `auditoria.caso_decidido`. Exige escopo `operacao`.",
  "parameters": [
    {
      "name": "uuid",
      "in": "path",
      "required": true,
      "description": "UUID ou ID numérico do caso de auditoria.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "description": "Decisão comercial sobre o caso de auditoria.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "decision"
          ],
          "properties": {
            "decision": {
              "type": "string",
              "enum": [
                "approve_full",
                "accept_charged",
                "counterproposal",
                "reject"
              ]
            },
            "counterproposal_amount": {
              "type": [
                "number",
                "null"
              ],
              "description": "Obrigatório quando decision = counterproposal."
            },
            "notes": {
              "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."
    },
    "404": {
      "description": "Caso não encontrado."
    },
    "422": {
      "description": "Violação do piso ANTT ou transição inválida."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "faturas-auditoria",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor"
  ],
  "method": "POST",
  "path": "/embarcador/auditoria-frete/casos/{uuid}/decisao"
}