inbound_cte_idinteger | nullOpcionalEjecutar auditoría automática y abrir caso sobre CT-e recibido
Parámetros, estructura de datos y respuestas del contrato versionado.
/embarcador/auditoria-frete/auditarLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Ejecuta las verificaciones automáticas (tabla, bloqueo, duplicidad, ejecución, tributario, cumplimiento y confirmación) sobre un CT-e recibido del embarcador y registra el AuditCase. Requiere permiso operacao.
Autenticación
- Permiso Requerido
operacao— Operación- Módulo
- Facturas y Auditoría de Fletes
- Perfiles Aplicables
- Embarcador · Gestor de Transporte
- Mecanismos
- OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
{
"oauth2": []
},
{
"chaveApi": []
}
]Parámetros
No hay parámetros declarados para esta operación.
Cuerpo de la Solicitud
Obligatorio
Identificación del CT-e recibido y tabla de referencia opcional.
application/json
access_keystring | nullOpcionalClave de acceso de 44 dígitos del CT-e.
freight_rate_table_idinteger | nullOpcionalRespuestas
201 Respuesta HTTP
Caso de auditoría creado con resultados de las verificaciones.
application/json
data—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTP
Credencial ausente, inválida o de otro entorno.
403 Respuesta HTTP
Permiso del panel no habilitado o recurso fuera del alcance de la company.
404 Respuesta HTTP
CT-e no encontrado.
422 Respuesta HTTP
Falla de validación.
Definición Completa de la Operación
{
"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": []
}