← InícioFleetPay / API

Obter resumo regulamentar do CIOT no provedor

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

GET/fiscal/ciot/{ciot_uuid}/resumo
resumoOperacaoCiotBase 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.

Consulta o provedor de CIOT e devolve o resumo da operação consolidado pelo parceiro (número, código verificador, protocolo, status e mensagem regulamentar).

Autenticação

Escopo Necessário
fiscal — Fiscal
Módulo
Fiscal, CT-e, MDF-e e CIOT
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

ciot_uuidpath · stringObrigatório

UUID da operação de transporte.

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

Respostas

200 Resposta HTTP

Resumo do CIOT.

application/json

202 Resposta HTTP

Resumo em processamento pelo provedor.

application/json

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

application/json

errorobjectOpcional
403 Resposta HTTP

Escopo não habilitado para esta credencial

application/json

errorobjectOpcional
404 Resposta HTTP

Recurso não encontrado no tenant autenticado.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

503 Resposta HTTP

Provedor indisponível (servico_indisponivel).

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "tags": [
    "CIOT"
  ],
  "summary": "Obter resumo regulamentar do CIOT no provedor",
  "operationId": "resumoOperacaoCiot",
  "description": "Consulta o provedor de CIOT e devolve o resumo da operação consolidado pelo parceiro\n(número, código verificador, protocolo, status e mensagem regulamentar).\n",
  "parameters": [
    {
      "name": "ciot_uuid",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "UUID da operação de transporte."
    }
  ],
  "responses": {
    "200": {
      "description": "Resumo do CIOT.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaCiotComResumo"
          }
        }
      }
    },
    "202": {
      "description": "Resumo em processamento pelo provedor.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaCiotComResumo"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "503": {
      "description": "Provedor indisponível (`servico_indisponivel`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "x-fleetpay-scope": "fiscal",
  "x-fleetpay-module": "fiscal-ciot",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/fiscal/ciot/{ciot_uuid}/resumo"
}