ciot_uuidpath · stringObrigatórioUUID da operação de transporte.
Restrições
{
"type": "string",
"format": "uuid"
}Parâmetros, estrutura de dados e respostas do contrato versionado.
/fiscal/ciot/{ciot_uuid}/consultaDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Dispara uma consulta ativa ao provedor de CIOT para reconciliar o estado da operação na ANTT com a base da FleetPay.
Diferente de GET /fiscal/ciot/{ciot_uuid} (que faz leitura local do rascunho sem bater na rede),
este endpoint consulta o parceiro e atualiza protocolo, status, número e código verificador.
fiscal — Fiscal[
{
"oauth2": []
},
{
"chaveApi": []
}
]ciot_uuidpath · stringObrigatórioUUID da operação de transporte.
{
"type": "string",
"format": "uuid"
}200 Resposta HTTPOperação reconciliada com sucesso.
application/jsondataobjectObrigatórioenvironmentobjectObrigatório202 Resposta HTTPConsulta transmitida ou em processamento no provedor.
application/jsondataobjectObrigatórioenvironmentobjectObrigatório401 Resposta HTTPNã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.
403 Resposta HTTPEscopo não habilitado para esta credencial
404 Resposta HTTPRecurso não encontrado no tenant autenticado.
X-Request-IdIdentificador de correlação da chamada.
409 Resposta HTTPAção conflitante com o estado atual da operação (acao_conflitante).
422 Resposta HTTPRegra de negócio ou CIOT não declarado (ciot_nao_declarado, regra_de_negocio).
503 Resposta HTTPProvedor de CIOT indisponível (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"
}