Evolução das APIs de Auditoria

• Data de publicação: 17 de Setembro de 2026
• Versão necessária: plugin de Auditorias 11.261.2125

Objetivo

Aprimorar e flexibilizar a integração e o consumo de dados de auditoria no sistema RUB, incluindo data e hora por item auditado, maior precisão e consistência nas informações sumarizadas de auditoria e suporte transparente a identificadores internos do RUB ou códigos externos vindos do ERP.

Essas alterações atendem às necessidades de extração contínua de dados e integrações com sistemas externos, garantindo rastreabilidade temporal e total correspondência entre os totais sumarizados e o detalhamento de itens.

Detalhamento das Alterações

1. Inclusão de timestamp na API de Itens de Auditoria

Endpoint: GET /{tenant}/api/rest/audit/itens/{store}/{auditId}

Cada item retornado pela API passa a conter a propriedade timestamp com a data e hora do registro da auditoria daquele produto.

Exemplo de Resposta:

[
  {
    "store": 30001,
    "auditId": 1,
    "product": "7699",
    "categoryL1Code": "2",
    "categoryL1Description": "2 - Bebidas",
    "status": 1,
    "statusDescription": "Sem Presença e Com Estoque",
    "auditStock": 7699,
    "timestamp": "2026-09-16 10:01:07"
  },
  {
    "store": 30001,
    "auditId": 1,
    "product": "12454",
    "categoryL1Code": "2",
    "categoryL1Description": "2 - Bebidas",
    "status": 1,
    "statusDescription": "Sem Presença e Com Estoque",
    "auditStock": 12454,
    "timestamp": "2026-09-16 10:01:07"
  }
]

2. Suporte a Código Interno e Externo no Parâmetro store

Endpoint: GET /{tenant}/api/rest/audit/itens/{store}/{auditId}

O integrador pode utilizar no caminho da requisição o identificador que for mais adequado à sua arquitetura:

• Por código externo do ERP:
  GET /{tenant}/api/rest/audit/itens/1/{auditId}
• Por código interno do RUB:
  GET /{tenant}/api/rest/audit/itens/30001/{auditId}

O sistema traduz automaticamente o identificador informado para a loja correspondente no RUB, retornando os itens da auditoria com total transparência. Caso o identificador informado não exista, a API mantém o retorno padrão de loja não encontrada.

3. Correção e Consistência na Sumarização da Auditoria

Endpoint: GET /{tenant}/api/rest/audit

O endpoint consolidado de auditorias garante que os valores sumarizados correspondam fielmente aos dados detalhados:

• O campo itensWithStock reflete a quantidade real de itens com estoque;
• Inclusão do novo campo readedItens, que não existia anteriormente na API, representando a quantidade total de itens lidos (com e sem estoque);
• O array statuses agrupa os status da auditoria, assegurando que a soma dos itens em cada status seja idêntica ao total de itens auditados.

Exemplo de Resposta:

[
  {
    "store": 30001,
    "auditId": 1,
    "auditedIn": "Loja inteira",
    "date": "2026-09-16 10:01:07",
    "lastReading": "2026-09-16 10:01:07",
    "closingDate": null,
    "disruptionCost": 1037118.7619,
    "itensWithStock": 25,
    "auditItens": 25,
    "readedItens": 25,
    "situation": "Aberta",
    "startedBy": "root (Super Usuário)",
    "closedBy": "",
    "type": 1,
    "typeDescription": "Presença",
    "statuses": [
      {
        "status": 5,
        "statusDescription": "Com Presença e com Estoque",
        "amount": 0
      },
      {
        "status": 3,
        "statusDescription": "Lido não pertence",
        "amount": 0
      },
      {
        "status": 4,
        "statusDescription": "Com Presença e sem Estoque",
        "amount": 0
      },
      {
        "status": 2,
        "statusDescription": "Sem Presença e Sem Estoque",
        "amount": 0
      },
      {
        "status": 1,
        "statusDescription": "Sem Presença e Com Estoque",
        "amount": 25
      }
    ]
  }
]

Benefícios

• Rastreabilidade Temporal: Permite acompanhar a ordem cronológica e o exato momento da auditoria de cada item;
• Consistência Contábil e Operacional: Assegura que indicadores e relatórios gerados a partir do resumo correspondam com precisão ao detalhe de itens;
• Facilidade e Flexibilidade de Integração: Elimina etapas intermediárias de conversão de identificadores de loja no cliente, suportando chamadas tanto com o ID interno quanto com o código do ERP;
• Retrocompatibilidade Garantida: Contratos existentes de API foram mantidos, garantindo estabilidade para todas as integrações atuais.