← HomeFleetPay / API

Query delivery photos and receipts for a counter-CT-e batch

Parameters, data structure and responses from the versioned contract.

GET/fiscal/cte-subcontratacao/lote/{batch_id}/fotos
getContraCteBatchFotosSandbox Base: https://api.fleetpay.site/v1

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

Returns delivery photos and receipts captured by drivers for all counter-CT-es generated by the batch, each identified with sequencia, cte_uuid, contra_cte_key and source_cte_key.

Image URLs are signed and valid for 15 minutes. When no photo has been captured yet, returns 200 with data: [].

Authentication

Required Scope
fiscal — Tax & Fiscal
Module
Subcontracting
Target Profiles
Fleet Carrier
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

batch_idpath · stringRequired

Batch UUID returned by POST /fiscal/cte-subcontratacao/lote.

Constraints
{
  "type": "string",
  "format": "uuid"
}
tipoquery · stringOptional

Filters photos by type:

  • P: Package
  • R: Receipt
  • C: Proof of delivery
  • O: Occurrence
Constraints
{
  "type": "string",
  "enum": [
    "P",
    "R",
    "C",
    "O"
  ]
}

Responses

200 HTTP Response

List of batch photos and receipts.

application/json

401 HTTP Response

FleetPay API key missing or invalid.

application/json

Headers

X-Request-Id

Call correlation identifier.

403 HTTP Response

Fiscal scope disabled for the key, or no active carrier associated with the key.

application/json

Headers

X-Request-Id

Call correlation identifier.

404 HTTP Response

Batch not found (lote_nao_encontrado).

application/json

422 HTTP Response

Invalid parameter (parametro_invalido).

application/json

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