← HomeFleetPay / API

Get shipper consolidated invoice details

Parameters, data structure and responses from the versioned contract.

GET/embarcador/faturas/{id}
consultarFaturaEmbarcadorSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Returns full breakdown of the consolidated invoice, bank collection data (boleto and PIX EMV) and payment history. Requires consultas scope.

Authentication

Required Scope
consultas — Queries
Module
Invoices & Freight Audit
Target Profiles
Shipper · Transport Manager
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

idpath · integerRequired

Numeric ID of the invoice.

Constraints
{
  "type": "integer"
}

Responses

200 HTTP Response

Operation processed successfully.

application/json

data—Optional
metaobject | nullOptional
additionalPropertiestrue
ambientestringOptional
"homologacao" · "producao"
401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

404 HTTP Response

Invoice not found for the shipper.

Complete Operation Definition
{
  "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}"
}