← HomeFleetPay / API

List shipper consolidated invoices

Parameters, data structure and responses from the versioned contract.

GET/embarcador/faturas
listarFaturasEmbarcadorSandbox Base: https://api.fleetpay.site/v1

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

Lists payable invoices linked to the authenticated shipper (own and consolidated via financial group), with active boleto, digitable line, PIX EMV and paid/pending totals. 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

statusquery · integerOptional

Filter by numeric invoice status code.

Constraints
{
  "type": "integer"
}
fromquery · stringOptional

Start date (YYYY-MM-DD).

Constraints
{
  "type": "string"
}
toquery · stringOptional

End date (YYYY-MM-DD).

Constraints
{
  "type": "string"
}
limitquery · integerOptional

Items per page (max 100, default 25).

Constraints
{
  "type": "integer"
}
cursorquery · integerOptional

Cursor ID for descending pagination.

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.

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