Agora no Bluesoft ERP, é possível consultar os dados de saldo retido e de média de ICMS-ST (060) de um produto por loja via API.

Como Irá Funcionar a Partir de Agora?

A partir de agora, as frentes de caixa e integrações de venda poderão realizar chamadas via método GET para as seguintes rotas públicas:

1. Rota de Consulta por Saldo

  • Endpoint: GET /api/fiscal/icms-st/consulta-por-saldo
  • Comportamento: Retorna os registros consolidados de saldo retido de ICMS-ST disponíveis para o produto na loja.
  • Critérios: Retorna apenas os registros que possuírem o campo saldoDisponivel maior que zero.

2. Rota de Consulta por Média

  • Endpoint: GET /api/fiscal/icms-st/consulta-por-media
  • Comportamento: Retorna os dados e valores médios de ICMS-ST mantidos pelo ERP, utilizando a Ficha de Estoque como fonte existente.

Regras Gerais de Execução das Rotas:

  • Parâmetros Obrigatórios: Em ambas as rotas, os parâmetros informados na URL lojaKey e produtoKey são estritamente obrigatórios. Caso algum parâmetro não seja enviado ou seja inválido, o sistema rejeitará a requisição retornando o status HTTP 400 com mensagens explícitas de erro.
  • Ausência de Dados: Caso não existam dados fiscais registrados para os parâmetros informados, a API responderá com sucesso técnico (HTTP 200), retornando a estrutura padrão do contrato vazia e marcando as flags de controle (possuiSaldoRetido ou possuiMedia) como false.

Observações / Validações:

  • Autonomia do PDV: As rotas são exclusivamente consultivas. A decisão de negócio sobre adotar a estratégia de saldo ou de média no cálculo fiscal permanece sob total responsabilidade da frente de caixa.
  • Segurança e Permissões: O acesso aos novos endpoints é restrito e controlado por meio das permissões dedicadas da API pública sob os códigos 4641 e 4642.
  • Documentação: O contrato e as descrições detalhadas dos parâmetros e campos principais foram adicionados e enriquecidos na documentação do Swagger/OpenAPI.

Para saber mais sobre a utilização das APIs do ERP, clique aqui.

Disponível a partir da versão r370.01