← InícioFleetPay / API

Reconciliar/consultar CIOT no provedor ANTT

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/fiscal/ciot/{ciot_uuid}/consulta
consultarCiotNoProvedorBase de Homologação: https://api.fleetpay.site/v1

Descriçõ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.

Autenticação

Escopo Necessário
fiscal — Fiscal
Módulo
Fiscal, CT-e, MDF-e e CIOT
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

ciot_uuidpath · stringObrigatório

UUID da operação de transporte.

Restrições
{
  "type": "string",
  "format": "uuid"
}

Respostas

200 Resposta HTTP

Operação reconciliada com sucesso.

application/json

202 Resposta HTTP

Consulta transmitida ou em processamento no provedor.

application/json

401 Resposta HTTP

Nã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.

application/json

errorobjectOpcional
403 Resposta HTTP

Escopo não habilitado para esta credencial

application/json

errorobjectOpcional
404 Resposta HTTP

Recurso não encontrado no tenant autenticado.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

409 Resposta HTTP

Ação conflitante com o estado atual da operação (acao_conflitante).

application/json

errorobjectOpcional
422 Resposta HTTP

Regra de negócio ou CIOT não declarado (ciot_nao_declarado, regra_de_negocio).

application/json

errorobjectOpcional
503 Resposta HTTP

Provedor de CIOT indisponível (servico_indisponivel).

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "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"
}