idpath · stringObligatorioID numérico o UUID de la nota de débito.
Restricciones
{
"type": "string"
}Parámetros, estructura de datos y respuestas del contrato versionado.
/notas-debito/{id}/aprovarLas 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.
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringObligatorioID numérico o UUID de la nota de débito.
{
"type": "string"
}Obligatorio
Identificación del aprobador y confirmación formal.
application/jsonaccepted_by_namestringObligatorioaccepted_by_emailstring | nullOpcionalaccepted_by_documentstring | nullOpcionalnotesstring | nullOpcional200 Respuesta HTTPOperación procesada con éxito.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTPCredencial ausente, inválida o de otro entorno.
403 Respuesta HTTPPermiso del panel no habilitado o recurso fuera del alcance de la company.
404 Respuesta HTTPNota de débito no encontrada.
409 Respuesta HTTPNota de débito ya procesada o en estado inválido.
{
"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"
}