ciot_uuidpath · stringObligatorioUUID de la operación de transporte.
Restricciones
{
"type": "string",
"format": "uuid"
}Parámetros, estructura de datos y respuestas del contrato versionado.
/fiscal/ciot/{ciot_uuid}/resumoLas 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).
fiscal — Fiscal[
{
"oauth2": []
},
{
"chaveApi": []
}
]ciot_uuidpath · stringObligatorioUUID de la operación de transporte.
{
"type": "string",
"format": "uuid"
}200 Respuesta HTTPResumen del CIOT.
application/jsondataobjectObligatorioenvironmentobjectObligatorio202 Respuesta HTTPResumen en procesamiento en el proveedor.
application/jsondataobjectObligatorioenvironmentobjectObligatorio401 Respuesta HTTPSin 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.
403 Respuesta HTTPÁmbito no habilitado para esta credencial
404 Respuesta HTTPRecurso no encontrado en el tenant autenticado.
X-Request-IdIdentificador de correlación de la llamada.
503 Respuesta HTTPProveedor no disponible (servico_indisponivel).
{
"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"
}