← InicioFleetPay / API

Obtener resumen regulatorio del CIOT en el proveedor

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

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

Consulta al proveedor de CIOT y devuelve el resumen de la operación consolidado por el socio (número, código verificador, protocolo, estado y mensaje regulatorio).

Autenticación

Permiso Requerido
fiscal — Fiscal
Módulo
Fiscal, CT-e, MDF-e y CIOT
Perfiles Aplicables
Gestor de Transporte · Agregado Empresarial · 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

ciot_uuidpath · stringObligatorio

UUID de la operación de transporte.

Restricciones
{
  "type": "string",
  "format": "uuid"
}

Respuestas

200 Respuesta HTTP

Resumen del CIOT.

application/json

202 Respuesta HTTP

Resumen en procesamiento en el proveedor.

application/json

401 Respuesta HTTP

Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.

application/json

errorobjectOpcional
403 Respuesta HTTP

Ámbito no habilitado para esta credencial

application/json

errorobjectOpcional
404 Respuesta HTTP

Recurso no encontrado en el tenant autenticado.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

503 Respuesta HTTP

Proveedor no disponible (servico_indisponivel).

application/json

errorobjectOpcional
Definición Completa de la Operación
{
  "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"
}