ciot_uuidpath · stringRequiredTransport operation UUID.
Constraints
{
"type": "string",
"format": "uuid"
}Parameters, data structure and responses from the versioned contract.
/fiscal/ciot/{ciot_uuid}/resumoTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Queries the CIOT provider and returns the consolidated operation summary from the partner (number, verification code, protocol, status and regulatory message).
fiscal — Tax & Fiscal[
{
"oauth2": []
},
{
"chaveApi": []
}
]ciot_uuidpath · stringRequiredTransport operation UUID.
{
"type": "string",
"format": "uuid"
}200 HTTP ResponseCIOT summary.
application/jsondataobjectRequiredenvironmentobjectRequired202 HTTP ResponseSummary processing at the provider.
application/jsondataobjectRequiredenvironmentobjectRequired401 HTTP ResponseUnauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.
404 HTTP ResponseResource not found in the authenticated tenant.
X-Request-IdCall correlation identifier.
503 HTTP ResponseProvider unavailable (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"
}