Integração para Validação de Saldo CD

Com esta integração será possível visualizar uma validação na finalização do pedido do saldo disponível no Centro de Distribuição (CD). Além disso, o saldo disponível será confrontado com o limite máximo de compra definido no cadastro do produto, garantindo que as lojas/franquias tenham visibilidade da disponibilidade real dos produtos e não ultrapassem o saldo disponível e limite máximo definido pela franqueadora. A integração também contemplará a API de cancelamento de pedidos, permitindo que o sistema da franqueadora realize o cancelamento de pedidos diretamente no Microvix, assegurando a sincronização de status entre as plataformas e maior consistência nos processos de compra e gestão de estoque.

Configurações da Rotina

Neste tópico serão descritas as configurações necessárias para a disponibilização e execução da rotina.

Parametrização Restrita

• Para utilizar esta integração, é necessário entrar em contato com o Suporte Técnico para realizar a seguinte configuração:

Na rotina de Sugestão de compras, ao clicar no botão Configurações gerais, poderá marcar o parâmetro "Aprovar pedido automaticamente na finalização" para que após as validações e finalização do pedido, já seja aprovado automaticamente, otimizando o processo de pedidos.

Como funcionará a Integração?

Quando uma franquia for realizar uma sugestão para pedido de compra, na finalização do pedido, com a integração ativada e configurada, o sistema irá validar qual o saldo disponível do produto na franqueadora. Assim, só será finalizado o pedido caso haja saldo suficiente disponível para o pedido. Além disso, com o parâmetro "Validar limite mínimo e máximo no cadastro de produto" habilitado, será feita a validação de qual a quantidade a franquia poderá fazer no pedido daquele produto. Por exemplo, se na franqueadora o saldo do produto é 100, mas no cadastro do produto o limite máximo de compra é 10 e o parâmetro está ativado, então no pedido a sugestão deve ser de no máximo 10.

Como será a validação?

A validação do saldo acontecerá na finalização do pedido. Após preencher todos os dados necessários para o pedido, será apresentada a aba de Validação de saldo, exibindo as divergências. Na validação, o sistema seguirá os seguintes cenários e regras:

Cenário 1: Saldo suficiente, limites min e máx desabilitados

Ocorre quando o parâmetro “Ativar validação de saldo via API na Sugestão de Compras” está habilitado e a API retorna saldo suficiente para todos os produtos selecionados, porém o parâmetro “Validar limite mínimo e máximo na finalização do pedido” está desabilitado.

• Regras:
  • Quando o parâmetro “Ativar validação de saldo via API na Sugestão de Compras” estiver habilitado e o parâmetro “Validar limite mínimo e máximo na finalização do pedido” desabilitado:
  • O sistema irá consultar a API e obterá o saldo total disponível para cada produto. Para cada item validado:
    • Se saldo retornado ≥ Sugestão, considerar o item válido.
    • Se saldo retornado < quantidade solicitada, abrirá painel permitindo que o usuário digite nova Sugestão conforme o saldo disponível.

Cenário 2: Saldo suficiente e dentro dos limites mín/máx

Ocorre quando os parâmetros “Ativar validação de saldo via API na Sugestão de Compras” e “Validar limite mínimo e máximo na finalização do pedido” estão habilitados, a API retorna saldo suficiente e as quantidades estão dentro dos limites mínimo e máximo definidos no cadastro do produto.

• Regras:
  • Quando ambos os parâmetros “Ativar validação de saldo via API na Sugestão de Compras” e “Validar limite mínimo e máximo na finalização do pedido” estiverem habilitados, o sistema irá consultar a API para obter o saldo total disponível e vai realizar as seguintes validações:
    • • Se saldo retornado ≥ Sugestão e a quantidade estiver dentro dos limites definidos no cadastro do produto (mín ≤ sugestão ≤ máx), será considerado o item válido.
      • Se quantidade mínima ou máxima não estiver preenchida, será ignorado o limite.
      • Caso todos os itens estejam válidos, o pedido será gravado normalmente e nenhum painel será aberto. 

Cenário 3: Saldo zerado

Ocorre quando a API de validação de saldo retorna saldo igual a zero (0) para um ou mais produtos selecionados na rotina de Sugestão de Compras. Esse cenário indica que o produto não possui disponibilidade no CD da franqueadora no momento da finalização do pedido, impossibilitando a sua compra.

• Regras: 
  • Quando o parâmetro “Ativar validação de saldo via API na Sugestão de Compras” estiver habilitado e o saldo retornado pela API for igual a zero (0):
    • O sistema irá recalcular automaticamente a coluna Sugestão do item com o valor = 0, garantindo que a quantidade fique alinhada ao saldo informado pela franqueadora.
    • O novo valor de sugestão (0) será exibido no painel na coluna Sugestão, permitindo ao usuário visualizar que o produto não possui saldo disponível para compra.
    • Nenhum item com quantidade = 0, será removido da listagem no painel. Se finalizado, o pedido será gravado com esse item e quantidade 0. 

Cenário 4: Abaixo do limite mínimo

Ocorre quando o parâmetro “Validar limite mínimo e máximo na finalização do pedido” está habilitado e a quantidade informada na coluna Sugestão está abaixo da quantidade mínima configurada no cadastro do produto, mesmo havendo saldo disponível retornado pela API. Esse cenário indica que o produto possui disponibilidade em estoque na franqueadora, porém a quantidade solicitada não atende ao limite mínimo definido, impossibilitando a finalização do pedido até que o valor seja ajustado.

• Regras: 
• Quando o parâmetro “Ativar validação de saldo via API na Sugestão de Compras” e o parâmetro “Validar limite mínimo e máximo na finalização do pedido” estiverem habilitados, e o campo Quantidade mínima estiver configurado no cadastro do produto (Suprimentos > Estoque > Produtos > Editar > Quantidade mínima):
  • O sistema irá consultar a API de saldo para obter a quantidade disponível na franqueadora.
• Após o retorno da API, o sistema irá comparar o valor do campo Sugestão com o Saldo retornado e a Quantidade mínima do cadastro do produto. A validação irá respeitar as seguintes condições:
  • Se o saldo da franqueadora retornar > 0 e a quantidade mínima do cadastro do produto for > 0 e a sugestão for < do que a quantidade mínima, o item será considerado inválido.
  • Se o saldo da franqueadora retornar < que a quantidade mínima, o sistema irá considerar o item inválido, pois a franqueadora não possui estoque suficiente nem para atender o limite mínimo.
  • Se o saldo da franqueadora retornar ≥ que a quantidade mínima e a sugestão ≥ que a quantidade mínima, o item será considerado válido, desde que respeite também o limite máximo (quando configurado). 
• Quando identificado o item inválido (por sugestão abaixo do mínimo ou saldo inferior ao mínimo), o sistema irá exibir divergências permitindo que o usuário edite o valor de maneira que se encaixe nos parâmetros.

Cenário 5: Acima do limite máximo

Ocorre quando o parâmetro “Validar limite mínimo e máximo na finalização do pedido” está habilitado e a quantidade informada na coluna Sugestão está acima da quantidade máxima configurada no cadastro do produto, mesmo havendo saldo disponível retornado pela API. Esse cenário indica que o produto possui estoque suficiente na franqueadora, porém a quantidade solicitada ultrapassa o limite máximo permitido, impossibilitando a finalização do pedido até que o valor seja ajustado.

• Regras: 
  • Quando o parâmetro “Ativar validação de saldo via API na Sugestão de Compras” e o parâmetro “Validar limite mínimo e máximo na finalização do pedido” estiverem habilitados, e o campo Quantidade máxima estiver configurado no cadastro do produto (Suprimentos > Estoque > Produtos > Editar > Quantidade máxima):
    • O sistema irá consultar a API de saldo para obter a quantidade disponível na franqueadora.
  • Após o retorno da API, o sistema irá comparar o valor do campo Sugestão com o saldo retornado da franqueadora e a Quantidade máxima do cadastro do produto. A validação deverá respeitar as seguintes condições:
    • Se o saldo da franqueadora retornar > 0, a quantidade máxima > 0 e sugestão > que a quantidade máxima, o item será considerado inválido, pois a quantidade máxima é maior que o valor sugerido.
    • Se a sugestão for ≤ menor entre (saldo retornado, quantidade máxima), o item será considerado válido, desde que também respeite o limite mínimo (quando configurado).
  • Quando identificado o item inválido (por sugestão acima do máximo permitido ou acima do saldo retornado), abrirá a tela para ajuste. 

Cenário 6: Saldo parcial

Ocorre quando a API de validação de saldo retorna saldo maior que zero, porém inferior à quantidade informada na coluna Sugestão. Esse cenário indica que o produto possui disponibilidade em estoque na franqueadora, mas em quantidade menor do que a solicitada, impossibilitando a finalização do pedido até que o valor seja ajustado manualmente pelo usuário.

• Regras: 
  • Quando os parâmetros “Ativar validação de saldo via API na Sugestão de Compras” e “Validar limite mínimo e máximo na finalização do pedido” estiverem habilitados:
    • O sistema irá consultar a API de saldo para obter a quantidade disponível (saldo retornado) da franqueadora.
  • Após o retorno da API, o sistema irá comparar o valor da coluna Sugestão com o saldo retornado e os limites mínimo e máximo configurados no cadastro do produto (Suprimentos > Estoque > Produtos > Editar > Quantidade mínima / Quantidade máxima).
    • Se o saldo da franqueadora retornar > 0 e sugestão > saldo retornado, o item será considerado inválido, permitindo a edição e respeitando os demais parâmetros. 
    • O sistema permitirá o ajuste manual na tela de divergências. 

Cenário 7: Limites não configurados no produto

Ocorre quando o parâmetro “Validar limite mínimo e máximo na finalização do pedido” está habilitado, mas o produto não possui valores definidos para os campos Quantidade mínima e Quantidade máxima. Esse cenário indica que o produto não possui limites configurados no cadastro, portanto o sistema deverá validar apenas o saldo retornado pela API para determinar se a sugestão é válida.

• Regras: 
  • Quando o parâmetro “Ativar validação de saldo via API na Sugestão de Compras” estiver habilitado e o parâmetro “Validar limite mínimo e máximo na finalização do pedido” também estiver habilitado, mas o produto não possuir limites configurados:
    • O sistema irá consultar a API de saldo para obter a quantidade disponível (saldo retornado) na franqueadora.
    • Será considerado os valores não configurados no produto sempre que estiver com quantidade mínima = 0 ou quantidade máxima = 0.
  • Após o retorno da API, o sistema irá comparar a Sugestão apenas com o saldo retornado da franqueadora.
    • Se saldo retornado > 0 e Sugestão ≤ saldo retornado, o item será considerado válido.
    • Se saldo retornado = 0 ou Sugestão > saldo retornado, o item será considerado inválido.
  • Quando identificado item inválido, o sistema irá exibir o painel de divergências para ajuste. 

Cenário 8: Produto não encontrado (EAN inexistente na API)

Ocorre quando a API de validação de saldo não localiza o produto informado (EAN inexistente, inválido ou não reconhecido pela franqueadora). Esse cenário indica que o produto não foi identificado na base da franqueadora e, portanto, não é possível determinar o saldo disponível para compra.

• Regras: 
  • Quando o parâmetro “Ativar validação de saldo via API na Sugestão de Compras” estiver habilitado e a API retornar erro de produto não encontrado:
    • O sistema irá tratar o saldo retornado como zero (0) para o produto correspondente.
    • O painel será aberto com o item na listagem com nova sugestão = 0.

Cenário 9: Soma das empresas

Quando é selecionada mais de uma empresa para gerar o pedido, o sistema considera que todas elas compartilham um único saldo disponível para o produto, ou seja, o saldo informado pela franqueadora é consolidado.

• Regras:
  • O saldo exibido na coluna Saldo Disponível é um saldo total único, não individual por empresa.
  • Ao ajustar as quantidades na coluna Nova Sugestão, o resultado da soma das quantidades de todas as empresas selecionadas no pedido não pode ultrapassar o saldo total disponível pela franqueadora.
  • Sempre que o resultado da soma ultrapassar o saldo disponível, o sistema exibe a mensagem de validação: “A soma das sugestões para as empresas neste item não pode exceder o saldo total disponível.”

Aba de divergências de saldo

No processo de finalização do pedido, caso haja divergências, será exibido o alerta Divergências Saldo. Para os devidos ajustes, o sistema irá:

• Guardar o valor inválido na coluna Sugestão anterior com a quantidade inserida anteriormente;
• Exibir os valores disponíveis em Saldo disponível para que seja gerada uma Nova sugestão;

API de Cancelamento de Pedidos

A API permitirá que a franqueadora ou sistemas externos integrados solicitem o cancelamento de pedidos de compra gerados pelas franquias, informando o número do pedido, o motivo e eventuais observações associadas à operação. Essa integração permitirá o controle centralizado dos fluxos de cancelamento, evitando que franquias executem cancelamentos diretos no ERP.

Para a API de cancelamento será feita a chamada do método LinxCancelamentoPedidoCompra.

• Regras e validações:
  • Se existir pedido para o CNPJ informado, será alterado o status do pedido para "Cancelado".
  • Caso não encontre pedido para o CNPJ será retornado erro na API.
  • Caso o pedido já esteja cancelado será retornad erro na API com uma mensagem informando que o pedido já está cancelado.