idpath · stringRequiredNumeric ID or UUID of the debit note.
Constraints
{
"type": "string"
}Parameters, data structure and responses from the versioned contract.
/notas-debito/{id}/aprovarTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Formally confirms debit note acceptance by the authorized technical/financial approver, recording IP/request evidence and firing webhook nota_debito.aprovada. Responds 409 if already accepted/rejected. Requires operacao scope.
operacao — Operations[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringRequiredNumeric ID or UUID of the debit note.
{
"type": "string"
}Required
Approver identification and formal confirmation.
application/jsonaccepted_by_namestringRequiredaccepted_by_emailstring | nullOptionalaccepted_by_documentstring | nullOptionalnotesstring | nullOptional200 HTTP ResponseOperation processed successfully.
application/jsondata—Optionalmetaobject | nullOptionaladditionalPropertiestrueambientestringOptional"homologacao" · "producao"401 HTTP ResponseMissing, invalid or cross-environment credential.
403 HTTP ResponseDashboard scope not enabled or resource outside company scope.
404 HTTP ResponseDebit note not found.
409 HTTP ResponseDebit note already processed or in invalid state.
{
"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"
}