idpath · integerRequiredNumeric ID of the invoice.
Constraints
{
"type": "integer"
}Parameters, data structure and responses from the versioned contract.
/embarcador/faturas/{id}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.
consultas — Queries[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · integerRequiredNumeric ID of the invoice.
{
"type": "integer"
}200 HTTP ResponseOperation processed successfully.
application/jsondata—Optionalmetaobject | nullOptionaladditionalPropertiestrueambientestringOptional"homologacao" · "producao"401 HTTP ResponseMissing, invalid or cross-environment credential.
403 HTTP ResponseDashboard scope not enabled or resource outside company scope.
404 HTTP ResponseInvoice not found for the shipper.
{
"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}"
}