← HomeFleetPay / API

Record commercial decision or dispute on audit case

Parameters, data structure and responses from the versioned contract.

POST/embarcador/auditoria-frete/casos/{uuid}/decisao
decidirCasoAuditoriaFreteSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Fully approves (approve_full), accepts the billed amount (accept_charged), submits a counterproposal (counterproposal, validated against the ANTT minimum floor) or rejects (reject), triggering webhook auditoria.caso_decidido. Requires operacao scope.

Authentication

Required Scope
operacao — Operations
Module
Invoices & Freight Audit
Target Profiles
Shipper · Transport Manager
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

uuidpath · stringRequired

UUID or numeric ID of the audit case.

Constraints
{
  "type": "string"
}

Request Body

Required

Commercial decision on the audit case.

application/json

decisionstringRequired
"approve_full" · "accept_charged" · "counterproposal" · "reject"
counterproposal_amountnumber | nullOptional

Required when decision = counterproposal.

notesstring | nullOptional

Responses

200 HTTP Response

Operation processed successfully.

application/json

data—Optional
metaobject | nullOptional
additionalPropertiestrue
ambientestringOptional
"homologacao" · "producao"
401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

404 HTTP Response

Case not found.

422 HTTP Response

ANTT minimum floor violation or invalid state transition.

Complete Operation Definition
{
  "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"
}