← InícioFleetPay / API

Registrar aceite formal programático em nota de débito

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

POST/notas-debito/{id}/aprovar
aprovarNotaDebitoBase 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.

Confirma formalmente o aceite da nota de débito pelo responsável técnico/financeiro autorizado, registrando evidência de IP/request e disparando webhook nota_debito.aprovada. Responde 409 se já aceita/rejeitada. Exige escopo operacao.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Acordos Comerciais e Notas de Débito
Perfis Aplicáveis
Gestor de Transporte · Embarcador
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

idpath · stringObrigatório

ID numérico ou UUID da nota de débito.

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

Corpo da Requisição

Obrigatório

Identificação do aprovador e confirmação formal.

application/json

accepted_by_namestringObrigatório
accepted_by_emailstring | nullOpcional
accepted_by_documentstring | nullOpcional
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

Nota de débito não encontrada.

409 Resposta HTTP

Nota de débito já processada ou em estado inválido.

Definição Completa da Operação
{
  "tags": [
    "Notas de Débito"
  ],
  "operationId": "aprovarNotaDebito",
  "summary": "Registrar aceite formal programático em nota de débito",
  "description": "Confirma formalmente o aceite da nota de débito pelo responsável técnico/financeiro autorizado, registrando evidência de IP/request e disparando webhook `nota_debito.aprovada`. Responde `409` se já aceita/rejeitada. Exige escopo `operacao`.",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "ID numérico ou UUID da nota de débito.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "description": "Identificação do aprovador e confirmação formal.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "accepted_by_name"
          ],
          "properties": {
            "accepted_by_name": {
              "type": "string"
            },
            "accepted_by_email": {
              "type": [
                "string",
                "null"
              ]
            },
            "accepted_by_document": {
              "type": [
                "string",
                "null"
              ]
            },
            "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": "Nota de débito não encontrada."
    },
    "409": {
      "description": "Nota de débito já processada ou em estado inválido."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "acordos-notas-debito",
  "x-fleetpay-profiles": [
    "gestor",
    "embarcador"
  ],
  "method": "POST",
  "path": "/notas-debito/{id}/aprovar"
}