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}/retificacaoDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Retifica dados de uma Operação de Transporte ativa junto à ANTT.
É obrigatório informar ao menos um campo para alteração: valor_frete, data_fim_viagem,
origem_destino ou dados_carga.
fiscal — Fiscal[
{
"oauth2": []
},
{
"chaveApi": []
}
]ciot_uuidpath · stringObrigatórioUUID da operação de transporte.
{
"type": "string",
"format": "uuid"
}Obrigatório
application/jsonjustificativastringOpcionalMotivo da retificação do CIOT.
maxLength500valor_fretenumber · floatOpcionalNovo valor total do frete em reais.
minimum0.01data_fim_viagemstring · dateOpcionalNova data prevista para término da viagem (AAAA-MM-DD).
origem_destinoarrayOpcionalTrechos de origem e destino da operação.
minItems1maxItems20dados_cargaobjectOpcional200 Resposta HTTPRetificação concluída.
application/jsondataobjectObrigatórioenvironmentobjectObrigatório202 Resposta HTTPRetificação em processamento.
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.
422 Resposta HTTPFalha de validação ou recusa pelo provedor (operacao_recusada).
503 Resposta HTTPProvedor indisponível (servico_indisponivel).
{
"tags": [
"CIOT"
],
"summary": "Retificar CIOT",
"operationId": "retificarOperacaoCiot",
"description": "Retifica dados de uma Operação de Transporte ativa junto à ANTT.\nÉ obrigatório informar ao menos um campo para alteração: `valor_frete`, `data_fim_viagem`,\n`origem_destino` ou `dados_carga`.\n",
"parameters": [
{
"name": "ciot_uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "UUID da operação de transporte."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetificarCiotInput"
}
}
}
},
"responses": {
"200": {
"description": "Retificação concluída.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaCiot"
}
}
}
},
"202": {
"description": "Retificação em processamento.",
"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 (`acao_conflitante`).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"422": {
"description": "Falha de validação ou recusa pelo provedor (`operacao_recusada`).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"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": "POST",
"path": "/fiscal/ciot/{ciot_uuid}/retificacao"
}