idpath · stringObrigatórioID numérico ou UUID da nota de débito.
Restrições
{
"type": "string"
}Parâmetros, estrutura de dados e respostas do contrato versionado.
/notas-debito/{id}/aprovarDescriçõ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.
operacao — Operação[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringObrigatórioID numérico ou UUID da nota de débito.
{
"type": "string"
}Obrigatório
Identificação do aprovador e confirmação formal.
application/jsonaccepted_by_namestringObrigatórioaccepted_by_emailstring | nullOpcionalaccepted_by_documentstring | nullOpcionalnotesstring | nullOpcional200 Resposta HTTPOperação processada com sucesso.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTPCredencial ausente, inválida ou de outro ambiente.
403 Resposta HTTPEscopo do painel não habilitado ou recurso fora do escopo da company.
404 Resposta HTTPNota de débito não encontrada.
409 Resposta HTTPNota de débito já processada ou em 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"
}