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}Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Retorna metadados completos da nota de débito, valores pendentes, parcelas programadas e estado de aceite formal. Exige escopo consultas.
consultas — Consultas[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringObrigatórioID numérico ou UUID da nota de débito.
{
"type": "string"
}200 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.
{
"tags": [
"Notas de Débito"
],
"operationId": "consultarNotaDebito",
"summary": "Detalhar nota de débito com cronograma de parcelas",
"description": "Retorna metadados completos da nota de débito, valores pendentes, parcelas programadas e estado de aceite formal. Exige escopo `consultas`.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "ID numérico ou UUID da nota de débito.",
"schema": {
"type": "string"
}
}
],
"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."
}
},
"x-fleetpay-scope": "consultas",
"x-fleetpay-module": "acordos-notas-debito",
"x-fleetpay-profiles": [
"gestor",
"embarcador",
"agregado_empresarial"
],
"method": "GET",
"path": "/notas-debito/{id}"
}