← InicioFleetPay / API

Consultar fotos y comprobantes de entrega del lote de contra-CT-e

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

GET/fiscal/cte-subcontratacao/lote/{batch_id}/fotos
getContraCteBatchFotosBase 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.

Devuelve las fotos y comprobantes de entrega capturados por los conductores para todos los contra-CT-e generados por el lote, cada uno identificado con sequencia, cte_uuid, contra_cte_key y source_cte_key.

Las URL de las imágenes están firmadas con validez de 15 minutos. Cuando aún no se ha capturado ninguna foto, responde 200 con data: [].

Autenticación

Permiso Requerido
fiscal — Fiscal
Módulo
Subcontratación
Perfiles Aplicables
Transportista Flotista
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

batch_idpath · stringObligatorio

UUID del lote devuelto por POST /fiscal/cte-subcontratacao/lote.

Restricciones
{
  "type": "string",
  "format": "uuid"
}
tipoquery · stringOpcional

Filtra las fotos por tipo:

  • P: Paquete
  • R: Recibo
  • C: Comprobante
  • O: Ocurrencia
Restricciones
{
  "type": "string",
  "enum": [
    "P",
    "R",
    "C",
    "O"
  ]
}

Respuestas

200 Respuesta HTTP

Lista de fotos y comprobantes del lote.

application/json

401 Respuesta HTTP

Clave de API FleetPay ausente o no válida.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

403 Respuesta HTTP

Ámbito fiscal deshabilitado en la clave, o clave sin transportista activo.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

404 Respuesta HTTP

Lote no encontrado (lote_nao_encontrado).

application/json

422 Respuesta HTTP

Parámetro inválido (parametro_invalido).

application/json

Definición Completa de la Operación
{
  "tags": [
    "CT-e de subcontratação"
  ],
  "summary": "Consultar fotos e comprovantes de entrega do lote de contra-CT-e",
  "operationId": "getContraCteBatchFotos",
  "description": "Retorna as fotos e comprovantes de entrega capturados pelos motoristas para todos os\ncontra-CT-e gerados pelo lote, cada um identificado com `sequencia`, `cte_uuid`,\n`contra_cte_key` e `source_cte_key`.\n\nAs URLs das imagens são assinadas com validade de 15 minutos. Quando nenhuma foto foi\ncapturada ainda, responde `200` com `data: []`.\n",
  "parameters": [
    {
      "$ref": "#/components/parameters/ContraCteBatchId"
    },
    {
      "name": "tipo",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "P",
          "R",
          "C",
          "O"
        ]
      },
      "description": "Filtra as fotos por tipo:\n- `P`: Pacote\n- `R`: Recibo\n- `C`: Comprovante\n- `O`: Ocorrência\n"
    }
  ],
  "responses": {
    "200": {
      "description": "Lista de fotos e comprovantes do lote.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/FotosLoteContraCteEnvelope"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "description": "Lote não encontrado (`lote_nao_encontrado`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorEnvelope"
          }
        }
      }
    },
    "422": {
      "description": "Parâmetro inválido (`parametro_invalido`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorEnvelope"
          }
        }
      }
    }
  },
  "x-fleetpay-scope": "fiscal",
  "x-fleetpay-module": "subcontratacao",
  "x-fleetpay-profiles": [
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/fiscal/cte-subcontratacao/lote/{batch_id}/fotos"
}