agreement_statusquery · stringOpcionalFiltro por status de aceite do acordo (ex: pending_acceptance, accepted).
Restrições
{
"type": "string"
}Parâmetros, estrutura de dados e respostas do contrato versionado.
/notas-debitoDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Lista notas de débito onde a company autenticada é devedora titular ou gestora originadora em modo manager_remuneration_compensation. Exige escopo consultas.
consultas — Consultas[
{
"oauth2": []
},
{
"chaveApi": []
}
]agreement_statusquery · stringOpcionalFiltro por status de aceite do acordo (ex: pending_acceptance, accepted).
{
"type": "string"
}limitquery · integerOpcionalItens por página.
{
"type": "integer"
}cursorquery · integerOpcionalCursor ID para paginação.
{
"type": "integer"
}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.
{
"tags": [
"Notas de Débito"
],
"operationId": "listarNotasDebito",
"summary": "Listar notas de débito e acordos de compensação B2B",
"description": "Lista notas de débito onde a company autenticada é devedora titular ou gestora originadora em modo `manager_remuneration_compensation`. Exige escopo `consultas`.",
"parameters": [
{
"name": "agreement_status",
"in": "query",
"required": false,
"description": "Filtro por status de aceite do acordo (ex: pending_acceptance, accepted).",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Itens por página.",
"schema": {
"type": "integer"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"description": "Cursor ID para paginação.",
"schema": {
"type": "integer"
}
}
],
"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."
}
},
"x-fleetpay-scope": "consultas",
"x-fleetpay-module": "acordos-notas-debito",
"x-fleetpay-profiles": [
"gestor",
"embarcador",
"agregado_empresarial"
],
"method": "GET",
"path": "/notas-debito"
}