Blog

Endpoint: Consulta de Saldo de Estoque

Objetivo

Permite consultar o saldo atual dos produtos, empenhos, saldo líquido, estoque mínimo, estoque máximo e consumo médio.

Rota

GET /v1/produto_saldoestoque_get

Parâmetros

ParâmetroTipoDescrição
PageIntegerNúmero da página.
PageSizeIntegerQuantidade de registros por página.
CodigoEmpresaStringCódigo da empresa.
CodigoFilialStringCódigo da filial.
CodigoProdutoStringCódigo do produto.
GrupoProdutoInicialStringGrupo inicial do intervalo.
GrupoProdutoFinalStringGrupo final do intervalo.

Parâmetros obrigatórios

codigoEmpresa e codigoFilial são obrigatórios.

Exemplo de requisição

GET /v1/produto_saldoestoque_get?Page=1&PageSize=50&CodigoEmpresa=1&CodigoFilial=1&CodigoProduto=B1

Estrutura do retorno

{
  "pageSize": 50,
  "currentPage": 1,
  "maxPageSize": 200,
  "totalPages": 1,
  "totalItens": 1,
  "data": [
    {
      "codigoProduto": "B1",
      "descricaoProduto": "Produto",
      "unidadeMedida": "UN",
      "codigoEmpresa": "1",
      "codigoFilial": "1",
      "saldoBrutoEstoque": 39208,
      "empenhoPositivo": 1235,
      "empenhoNegativo": -2386,
      "saldoLiquidoEstoque": 38057,
      "estoqueMaximo": 50000,
      "estoqueMinimo": 1000,
      "consumoMedioUltimos3Meses": 120,
      "consumoMedioUltimos6Meses": 115.5,
      "consumoMedioUltimos12Meses": 108.75
    }
  ]
}

Campos do retorno

CampoDescrição
codigoProdutoCódigo do produto.
descricaoProdutoDescrição do produto.
unidadeMedidaUnidade de medida.
codigoEmpresaCódigo da empresa.
codigoFilialCódigo da filial.
saldoBrutoEstoqueSaldo físico atual.
empenhoPositivoQuantidade de empenhos positivos.
empenhoNegativoQuantidade de empenhos negativos.
saldoLiquidoEstoqueSaldo considerando os empenhos.
estoqueMaximoEstoque máximo configurado.
estoqueMinimoEstoque mínimo configurado.
consumoMedioUltimos3MesesConsumo médio dos últimos três meses.
consumoMedioUltimos6MesesConsumo médio dos últimos seis meses.
consumoMedioUltimos12MesesConsumo médio dos últimos 12 meses.
Compartilhe!