← InícioFleetPay / API

Listar faturas consolidadas do embarcador

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/embarcador/faturas
listarFaturasEmbarcadorBase de Homologação: https://api.fleetpay.site/v1

Descriçõ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.

Autenticação

Escopo Necessário
consultas — Consultas
Módulo
Faturas e Auditoria de Fretes
Perfis Aplicáveis
Embarcador · Gestor de Transporte
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

statusquery · integerOpcional

Filtro pelo código numérico do status da fatura.

Restrições
{
  "type": "integer"
}
fromquery · stringOpcional

Data inicial (YYYY-MM-DD).

Restrições
{
  "type": "string"
}
toquery · stringOpcional

Data final (YYYY-MM-DD).

Restrições
{
  "type": "string"
}
limitquery · integerOpcional

Itens por página (máx 100, padrão 25).

Restrições
{
  "type": "integer"
}
cursorquery · integerOpcional

Cursor ID para paginação descendente.

Restrições
{
  "type": "integer"
}

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

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

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

Definição Completa da Operação
{
  "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"
}