← InicioFleetPay / API

Listar facturas consolidadas del embarcador

Parámetros, estructura de datos y respuestas del contrato versionado.

GET/embarcador/faturas
listarFaturasEmbarcadorBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Lista facturas por pagar vinculadas al embarcador autenticado (propias y consolidadas por grupo financiero), con boleto activo, línea digitada, PIX EMV y totales pagados/pendientes. Requiere permiso consultas.

Autenticación

Permiso Requerido
consultas — Consultas
Módulo
Facturas y Auditoría de Fletes
Perfiles Aplicables
Embarcador · Gestor de Transporte
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

statusquery · integerOpcional

Filtro por el código numérico del estado de la factura.

Restricciones
{
  "type": "integer"
}
fromquery · stringOpcional

Fecha inicial (YYYY-MM-DD).

Restricciones
{
  "type": "string"
}
toquery · stringOpcional

Fecha final (YYYY-MM-DD).

Restricciones
{
  "type": "string"
}
limitquery · integerOpcional

Elementos por página (máx. 100, por defecto 25).

Restricciones
{
  "type": "integer"
}
cursorquery · integerOpcional

Cursor ID para paginación descendente.

Restricciones
{
  "type": "integer"
}

Respuestas

200 Respuesta HTTP

Operación procesada con éxito.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Respuesta HTTP

Credencial ausente, inválida o de otro entorno.

403 Respuesta HTTP

Permiso del panel no habilitado o recurso fuera del alcance de la company.

Definición Completa de la Operación
{
  "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"
}