← InícioFleetPay / API

Consultar fotos e comprovantes de entrega do lote de contra-CT-e

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

GET/fiscal/cte-subcontratacao/lote/{batch_id}/fotos
getContraCteBatchFotosBase 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 as fotos e comprovantes de entrega capturados pelos motoristas para todos os contra-CT-e gerados pelo lote, cada um identificado com sequencia, cte_uuid, contra_cte_key e source_cte_key.

As URLs das imagens são assinadas com validade de 15 minutos. Quando nenhuma foto foi capturada ainda, responde 200 com data: [].

Autenticação

Escopo Necessário
fiscal — Fiscal
Módulo
Subcontratação
Perfis Aplicáveis
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

UUID do lote devolvido pelo POST /fiscal/cte-subcontratacao/lote.

Restrições
{
  "type": "string",
  "format": "uuid"
}
tipoquery · stringOpcional

Filtra as fotos por tipo:

  • P: Pacote
  • R: Recibo
  • C: Comprovante
  • O: Ocorrência
Restrições
{
  "type": "string",
  "enum": [
    "P",
    "R",
    "C",
    "O"
  ]
}

Respostas

200 Resposta HTTP

Lista de fotos e comprovantes do lote.

application/json

401 Resposta HTTP

Chave de API FleetPay ausente ou inválida.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

403 Resposta HTTP

Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

404 Resposta HTTP

Lote não encontrado (lote_nao_encontrado).

application/json

422 Resposta HTTP

Parâmetro inválido (parametro_invalido).

application/json

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