← InícioFleetPay / API

Listar comprovantes e fotos por lote de serviços

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

GET/servicos/lote/{batch_id}/fotos
listarFotosLoteServicosBase 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.

Retorna URLs assinadas temporárias das fotos e comprovantes vinculados aos documentos importados em um lote. Exige escopo consultas.

Autenticação

Escopo Necessário
consultas — Consultas
Módulo
Repasses e Comprovantes
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · Transportador Frotista
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

batch_idpath · stringObrigatório

Identificador do lote de importação.

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

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.

404 Resposta HTTP

Lote não encontrado para a company autenticada.

Definição Completa da Operação
{
  "tags": [
    "Parcelas"
  ],
  "operationId": "listarFotosLoteServicos",
  "summary": "Listar comprovantes e fotos por lote de serviços",
  "description": "Retorna URLs assinadas temporárias das fotos e comprovantes vinculados aos documentos importados em um lote. Exige escopo `consultas`.",
  "parameters": [
    {
      "name": "batch_id",
      "in": "path",
      "required": true,
      "description": "Identificador do lote de importação.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "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": "Lote não encontrado para a company autenticada."
    }
  },
  "x-fleetpay-scope": "consultas",
  "x-fleetpay-module": "repasses-comprovantes",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/servicos/lote/{batch_id}/fotos"
}