← InícioFleetPay / API

Detalhar fatura consolidada do embarcador

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

GET/embarcador/faturas/{id}
consultarFaturaEmbarcadorBase 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 detalhamento completo da fatura consolidada, dados de cobrança bancária (boleto e PIX EMV) e histórico de pagamentos. Exige escopo consultas.

Autenticação

Escopo Necessário
consultas — Consultas
Módulo
Faturas e Auditoria de Fretes
Perfis Aplicáveis
Embarcador · Gestor de Transporte
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 · integerObrigatório

ID numérico da fatura.

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.

404 Resposta HTTP

Fatura não encontrada para o embarcador.

Definição Completa da Operação
{
  "tags": [
    "Faturas Consolidadas"
  ],
  "operationId": "consultarFaturaEmbarcador",
  "summary": "Detalhar fatura consolidada do embarcador",
  "description": "Retorna detalhamento completo da fatura consolidada, dados de cobrança bancária (boleto e PIX EMV) e histórico de pagamentos. Exige escopo `consultas`.",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "ID numérico da fatura.",
      "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."
    },
    "404": {
      "description": "Fatura não encontrada para o embarcador."
    }
  },
  "x-fleetpay-scope": "consultas",
  "x-fleetpay-module": "faturas-auditoria",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor"
  ],
  "method": "GET",
  "path": "/embarcador/faturas/{id}"
}