← InícioFleetPay / API

Listar notas de débito e acordos de compensação B2B

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/notas-debito
listarNotasDebitoBase de Homologação: https://api.fleetpay.site/v1

Descriçõ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.

Autenticação

Escopo Necessário
consultas — Consultas
Módulo
Acordos Comerciais e Notas de Débito
Perfis Aplicáveis
Gestor de Transporte · Embarcador · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

agreement_statusquery · stringOpcional

Filtro por status de aceite do acordo (ex: pending_acceptance, accepted).

Restrições
{
  "type": "string"
}
limitquery · integerOpcional

Itens por página.

Restrições
{
  "type": "integer"
}
cursorquery · integerOpcional

Cursor ID para paginação.

Restrições
{
  "type": "integer"
}

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Resposta HTTP

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

Definição Completa da Operação
{
  "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"
}