statusquery · integerOpcionalFiltro pelo código numérico do status da fatura.
Restrições
{
"type": "integer"
}Parâmetros, estrutura de dados e respostas do contrato versionado.
/embarcador/faturasDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Lista faturas a pagar vinculadas ao embarcador autenticado (próprias e consolidadas via grupo financeiro), com boleto ativo, linha digitável, PIX EMV e totais pagos/pendentes. Exige escopo consultas.
consultas — Consultas[
{
"oauth2": []
},
{
"chaveApi": []
}
]statusquery · integerOpcionalFiltro pelo código numérico do status da fatura.
{
"type": "integer"
}fromquery · stringOpcionalData inicial (YYYY-MM-DD).
{
"type": "string"
}toquery · stringOpcionalData final (YYYY-MM-DD).
{
"type": "string"
}limitquery · integerOpcionalItens por página (máx 100, padrão 25).
{
"type": "integer"
}cursorquery · integerOpcionalCursor ID para paginação descendente.
{
"type": "integer"
}200 Resposta HTTPOperação processada com sucesso.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTPCredencial ausente, inválida ou de outro ambiente.
403 Resposta HTTPEscopo do painel não habilitado ou recurso fora do escopo da company.
{
"tags": [
"Faturas Consolidadas"
],
"operationId": "listarFaturasEmbarcador",
"summary": "Listar faturas consolidadas do embarcador",
"description": "Lista faturas a pagar vinculadas ao embarcador autenticado (próprias e consolidadas via grupo financeiro), com boleto ativo, linha digitável, PIX EMV e totais pagos/pendentes. Exige escopo `consultas`.",
"parameters": [
{
"name": "status",
"in": "query",
"required": false,
"description": "Filtro pelo código numérico do status da fatura.",
"schema": {
"type": "integer"
}
},
{
"name": "from",
"in": "query",
"required": false,
"description": "Data inicial (YYYY-MM-DD).",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"required": false,
"description": "Data final (YYYY-MM-DD).",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Itens por página (máx 100, padrão 25).",
"schema": {
"type": "integer"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"description": "Cursor ID para paginação descendente.",
"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."
}
},
"x-fleetpay-scope": "consultas",
"x-fleetpay-module": "faturas-auditoria",
"x-fleetpay-profiles": [
"embarcador",
"gestor"
],
"method": "GET",
"path": "/embarcador/faturas"
}