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}/consultaLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Dispara una consulta activa al proveedor de CIOT para conciliar el estado de la operación en la ANTT con la base de FleetPay.
A diferencia de GET /fiscal/ciot/{ciot_uuid} (que realiza una lectura local del borrador sin consultar la red), este endpoint consulta al socio y actualiza protocolo, estado, número y código verificador.
fiscal — Fiscal[
{
"oauth2": []
},
{
"chaveApi": []
}
]ciot_uuidpath · stringObligatorioUUID de la operación de transporte.
{
"type": "string",
"format": "uuid"
}200 Respuesta HTTPOperación conciliada con éxito.
application/jsondataobjectObligatorioenvironmentobjectObligatorio202 Respuesta HTTPConsulta transmitida o 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.
409 Respuesta HTTPAcción conflictiva con el estado actual de la operación (acao_conflitante).
422 Respuesta HTTPRegla de negocio o CIOT no declarado (ciot_nao_declarado, regra_de_negocio).
503 Respuesta HTTPProveedor de CIOT no disponible (servico_indisponivel).
{
"tags": [
"CIOT"
],
"summary": "Reconciliar/consultar CIOT no provedor ANTT",
"operationId": "consultarCiotNoProvedor",
"description": "Dispara uma consulta ativa ao provedor de CIOT para reconciliar o estado da operação\nna ANTT com a base da FleetPay.\n\nDiferente de `GET /fiscal/ciot/{ciot_uuid}` (que faz leitura local do rascunho sem bater na rede),\neste endpoint consulta o parceiro e atualiza protocolo, status, número e código verificador.\n",
"parameters": [
{
"name": "ciot_uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "UUID da operação de transporte."
}
],
"responses": {
"200": {
"description": "Operação reconciliada com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaCiot"
}
}
}
},
"202": {
"description": "Consulta transmitida ou em processamento no provedor.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaCiot"
}
}
}
},
"401": {
"$ref": "#/components/responses/Erro401"
},
"403": {
"$ref": "#/components/responses/Erro403"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"description": "Ação conflitante com o estado atual da operação (`acao_conflitante`).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"422": {
"description": "Regra de negócio ou CIOT não declarado (`ciot_nao_declarado`, `regra_de_negocio`).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"503": {
"description": "Provedor de CIOT 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": "POST",
"path": "/fiscal/ciot/{ciot_uuid}/consulta"
}