idpath · integerObligatorioID numérico de la factura.
Restricciones
{
"type": "integer"
}Parámetros, estructura de datos y respuestas del contrato versionado.
/embarcador/faturas/{id}Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Devuelve el detalle completo de la factura consolidada, datos de cobro bancario (boleto y PIX EMV) e historial de pagos. Requiere permiso consultas.
consultas — Consultas[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · integerObligatorioID numérico de la factura.
{
"type": "integer"
}200 Respuesta HTTPOperación procesada con éxito.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTPCredencial ausente, inválida o de otro entorno.
403 Respuesta HTTPPermiso del panel no habilitado o recurso fuera del alcance de la company.
404 Respuesta HTTPFactura no encontrada para el embarcador.
{
"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}"
}