← InicioFleetPay / API

Registrar aceptación formal programática en nota de débito

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

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

Confirma formalmente la aceptación de la nota de débito por el responsable técnico/financiero autorizado, registrando evidencia de IP/request y disparando el webhook nota_debito.aprovada. Responde 409 si ya fue aceptada/rechazada. Exige alcance operacao.

Autenticación

Permiso Requerido
operacao — Operación
Módulo
Acuerdos Comerciales y Notas de Débito
Perfiles Aplicables
Gestor de Transporte · Embarcador
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

idpath · stringObligatorio

ID numérico o UUID de la nota de débito.

Restricciones
{
  "type": "string"
}

Cuerpo de la Solicitud

Obligatorio

Identificación del aprobador y confirmación formal.

application/json

accepted_by_namestringObligatorio
accepted_by_emailstring | nullOpcional
accepted_by_documentstring | nullOpcional
notesstring | 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.

404 Respuesta HTTP

Nota de débito no encontrada.

409 Respuesta HTTP

Nota de débito ya procesada o en estado inválido.

Definición Completa de la Operación
{
  "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"
}