← InícioFleetPay / API

Detalhar nota de débito com cronograma de parcelas

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

GET/notas-debito/{id}
consultarNotaDebitoBase 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.

Retorna metadados completos da nota de débito, valores pendentes, parcelas programadas e estado de aceite formal. 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

idpath · stringObrigatório

ID numérico ou UUID da nota de débito.

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

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.

404 Resposta HTTP

Nota de débito não encontrada.

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