← InícioFleetPay / API

Listar comprovantes e fotos de um serviço

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

GET/servicos/{documento}/fotos
listarFotosServicoBase 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 fotos e comprovantes de entrega vinculados a um documento/serviço específico. 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

documentopath · stringObrigatório

ID numérico, internal_id, chave de 44 dígitos ou UUID do documento.

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

Documento não encontrado.

Definição Completa da Operação
{
  "tags": [
    "Parcelas"
  ],
  "operationId": "listarFotosServico",
  "summary": "Listar comprovantes e fotos de um serviço",
  "description": "Lista fotos e comprovantes de entrega vinculados a um documento/serviço específico. Exige escopo `consultas`.",
  "parameters": [
    {
      "name": "documento",
      "in": "path",
      "required": true,
      "description": "ID numérico, internal_id, chave de 44 dígitos ou UUID do documento.",
      "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": "Documento não encontrado."
    }
  },
  "x-fleetpay-scope": "consultas",
  "x-fleetpay-module": "repasses-comprovantes",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/servicos/{documento}/fotos"
}