← InícioFleetPay / API

Executar auditoria automática e abrir caso em CT-e recebido

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

POST/embarcador/auditoria-frete/auditar
auditarCteEmbarcadorBase 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.

Executa os checks automáticos (tabela, bloqueio, duplicidade, execução, tributário, conformidade e confirmação) sobre um CT-e recebido do embarcador e registra o AuditCase. Exige escopo operacao.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Faturas e Auditoria de Fretes
Perfis Aplicáveis
Embarcador · Gestor de Transporte
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

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

Identificação do CT-e recebido e tabela de referência opcional.

application/json

inbound_cte_idinteger | nullOpcional
access_keystring | nullOpcional

Chave de acesso de 44 dígitos do CT-e.

freight_rate_table_idinteger | nullOpcional

Respostas

201 Resposta HTTP

Caso de auditoria criado com resultados dos checks.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Resposta HTTP

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

404 Resposta HTTP

CT-e não encontrado.

422 Resposta HTTP

Falha de validação.

Definição Completa da Operação
{
  "tags": [
    "Auditoria de Frete"
  ],
  "operationId": "auditarCteEmbarcador",
  "summary": "Executar auditoria automática e abrir caso em CT-e recebido",
  "description": "Executa os checks automáticos (tabela, bloqueio, duplicidade, execução, tributário, conformidade e confirmação) sobre um CT-e recebido do embarcador e registra o `AuditCase`. Exige escopo `operacao`.",
  "requestBody": {
    "required": true,
    "description": "Identificação do CT-e recebido e tabela de referência opcional.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "inbound_cte_id": {
              "type": [
                "integer",
                "null"
              ]
            },
            "access_key": {
              "type": [
                "string",
                "null"
              ],
              "description": "Chave de acesso de 44 dígitos do CT-e."
            },
            "freight_rate_table_id": {
              "type": [
                "integer",
                "null"
              ]
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Caso de auditoria criado com resultados dos checks.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "meta": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true
              },
              "ambiente": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    },
    "404": {
      "description": "CT-e não encontrado."
    },
    "422": {
      "description": "Falha de validação."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "faturas-auditoria",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor"
  ],
  "method": "POST",
  "path": "/embarcador/auditoria-frete/auditar",
  "parameters": []
}