Métodos
Esta interface disponibiliza os seguintes métodos:
Busca de saldos de produtos que se encaixam no filtro informado. Nesta busca é possível buscar saldo pelas definições de produtos, através da informação de lote, código de filial, volume, local e terceiros. É possível ainda delimitar uma data final.
Um exemplo de retorno: Código Produto Nome Produto Custo Médio Item Grade 1 Cód. Local Quant. Quant. Pré-Baixa Quant. Reserva Cód. Filial 55 Linha 0,47 Amarela 0 0 1,6 1 55 Linha 0,39 Amarela 1271 500 0 0 20 55 Linha 0,47 Amarela 6122 240 0 0 1 55 Linha 0,47 Amarela 1112 9 1 0 1 55 Linha 0,47 Amarela 1121 9 0,6 0 1
Neste cenário o saldo total é de 758 itens em distribuídos em diversos locais (500 + 240 + 9 + 9). Desta quantidade não está descontado as quantidades pré-baixadas, nem as reservas.
Sendo assim, o “saldo disponível” para comercialização a ser considerado seria os 758 itens menos as quantidades em pré-baixa de 1 item e a quantidade reservada de 1,6 itens, totalizando 755,4 itens disponíveis.
A quantidade reservada não possui um local definido, mas possui uma filial, pois apenas a operação de pré- baixa define o local naquela filial de onde os produtos serão retirados.
SaldoProduto[] BuscarSaldos(Login login, FiltroSaldoProduto filtro);
Busca de saldo disponível dos produtos, conforme filtros informados.
Nesta busca é possível buscar saldo disponível dos produtos através dos filtros Produtos/Grades, Locais, Estoque Próprio, Estoque em Poder de Terceiros e Estoque de Terceiro em Poder da Empresa.
O resultado é agrupado por Produto/Grades, e na quantidade disponível, já está deduzido a quantidade reservada e a quantidade de pré-baixa.
SaldoProdutoResumido BuscarSaldoProduto(Login login, FiltroSaldoProdutoResumido filtro);
Busca de Saldo disponível dos produtos do tipo Kit, conforme filtros informados.
Nesta busca é possível buscar saldo disponível dos produtos através dos filtros Produtos/Grades, Locais, Estoque Próprio, Estoque em Poder de Terceiros, Estoque de Terceiro em Poder da Empresa e Filial. Sendo obrigatório informar uma filial.
A quantidade disponível é calculada para cada item do Kit, o resultado é agrupado por Produto/Grades, e na quantidade disponível, já está deduzido a quantidade reservada e a quantidade de pré-baixa. A quantidade disponível de cada item é dividida pela quantidade de vezes que ele aparece no Kit, e o menor resultado passa a ser a quantidade disponível do Kit.
SaldoProdutoResumido BuscarSaldoProdutoKit(Login login, FiltroSaldoProdutoResumidoKit filtro);
Grava os dados de recebimento de produtos informados na classe RecebimentoProdutos.
Busca os Locais de Armazenagem ou Estocagem, conforme filtros informados.
Para verificar os possíveis filtros para a busca de locais verificar a classe FiltroLocalArmazenagem desse documento.
Ao realizar um filtro por uma das opções de local do Tipo Estocagem (Consumo Próprio, Expedição, Estoque em Poder de Terceiros; Estoque de Terceiros em Poder da Empresa), sem informar no filtro o Tipo de Local(Armazenagem ou Estocagem), a busca irá filtrar por Locais de Estocagem levando em consideração as opções marcadas.
Se a busca tiver filtro for por Tipo de Local igual a Armazenagem, as opções de local do Tipo Estocagem (Consumo Próprio, Expedição, Estoque em Poder de Terceiros; Estoque de Terceiros em Poder da Empresa), serão desconsideradas do filtro, já que se referem somente ao Tipo Estocagem.
LocaisArmazenagem[] BuscarLocaisArmazenagem(Login login, FiltroLocalArmazenagem filtro);
Busca uma lista de atendimentos de requisição interna presentes na base de acordo com as informações definidas no filtro.
AtendimentoRequisicaoInterna[] BuscarAtendimentosRequisicaoInterna(Login login, FiltroAtendimentoRequisicaoInterna filtro);
Enumerações
Para as enumerações, o primeiro valor apresentado pode ser considerado o valor padrão quando associado a um campo nas classes.
Enumeração de TipoProducao SOAP JSON
EXTERNA = 0 0
INTERNA = 1 1
TODOS = 255 255
Enumeração de TipoLocalArmazenagem SOAP JSON
TODOS = 0 0
ARMAZENAGEM = 1 1
ESTOCAGEM = 2 2
Classes
A seguir serão apresentadas as classes contidas nesta interface.
Classe Lote
1 NumeroLote String Número do lote
2 DataFabricacao String Data de Fabricação do lote 3 DataValidade String Data de Validade do lote 4 DataEntrada String Data de Entrada do lote 5 NumeroDias Inteiro Numero de Dias do lote Classe SaldoProduto
1 DefinicaoProduto DefinicaoProduto Definição do Produto do saldo de produto 2 CodigoFilial String Código da Filial do saldo de produto
3 Lote Lote Lote do saldo de produto
5 Local String Local do saldo de produto
6 TipoProducao TipoProducao Tipo de Produção do saldo de produto 7 EstoqueProprio Bool
Indicador de Estoque Próprio para o saldo de produto
8 EstoquePoderTerceiros Bool
Indicador de Estoque em Poder de Terceiros para o saldo de produto
9 EstoqueTerceiroPoderEmpresa Bool
Indicador de Estoque de Terceiro em Poder da Empresa para o saldo de produto
10 ConteudoImportado Bool
Indicador de Conteúdo Importado para o saldo de produto
11 LocalIndisponivel Bool
Indicador de Local Indisponível para o saldo de produto
12 SaldoMonetario String Valor do Saldo Monetário do saldo de produto 13 Quantidade String Valor de Quantidade do saldo de produto 14 QuantidadeReserva String
Valor de Quantidade em Reserva do saldo de produto
15 QuantidadePreBaixa String
Valor de Quantidade em Pre-Baixa do saldo de produto
16 CustoMedio String Valor de Custo Médio do saldo de produto 17 AVP String Valor de AVP do saldo de produto
18 UltimoCMNaoZerado String
Valor do Último Custo Médio Não Zerado de saldo de produto
19 ValorUltimaCompra String Valor da última compra do produto.
20 Custo String
Valor da última entrada do produto em estoque.
21 EstoqueMinimo String Valor do estoque mínimo. 22 EstoqueMaximo String Valor do estoque máximo. Classe FiltroLote
1 NumeroLote String NumeroLote do filtro por lote 2 DataFabricacaoInicial String
Data de Fabricação Inicial a ser considerada para filtro por lote
3 DataFabricacaoFinal String
Data de Fabricação Final a ser considerada para filtro por lote
4 DataVencimentoInicial String
Data de Vencimento Inicial a ser considerada para filtro por lote
5 DataVencimentoFinal String
Data de Vencimento Final a ser considerada para filtro por lote
Classe FiltroSaldoProduto
1 DefinicaoProdutos DefinicaoProduto[]
Lista de itens de Definição de Produtos a serem considerados
2 Lotes FiltroLote[] Lista de itens de Lotes a serem considerados 3 CodigoFiliais String[]
Lista de itens de Código de Filiais a serem considerados
4 CodigoVolumes String[]
Lista de itens de Código de Volumes a serem considerados
5 CodigoLocais String[]
Lista de itens de Código de Locais a serem considerados
6 CodigoTerceiros String[]
Lista de itens de Código de Terceiros a serem considerados
7 DataFinal String
Data Final a ser considerada (no formato ‘dd/MM/yyyy’)
8 TipoProducao TipoProducao Tipo de Produção a ser considerada 9 EstoqueProprio Bool
Indicador se Estoque Próprio deve ser considerada
10 EstoquePoderTerceiros Bool
Indicador se Estoque em Poder de Terceiros deve ser considerada
11 EstoqueTerceiroPoderEmpresa Bool
Indicador se Estoque de Terceiro em Poder da Empresa deve ser considerada
12 ListarProdutosSubordinados Bool
Indicador de busca pelos produtos
subordinados. Com esta propriedade definida para verdadeiro, todas as variações possíveis para um determinado produto/variação serão consideradas para a busca do saldo.
13 DataHoraBaseAlteracao String
Busca somente os Saldos de Produtos atualizados após a Data/Hora(no formato ‘dd/MM/yyyy HH:mm:ss’) informado.
14 DataHoraBaseAlteracaoInicial String
Busca somente os Saldos de Produtos atualizados com o início na Data/Hora(no formato ‘dd/MM/yyyy HH:mm:ss’) informado.
15 DataHoraBaseAlteracaoFinal String
Busca somente os Saldos de Produtos atualizados até a Data/Hora(no formato ‘dd/MM/yyyy HH:mm:ss’) informado.
16 ControlePaginacao ControlePaginacao Informações da pagina desejada. Classe ProdutoResumido
1 CodigoProduto String Código do Produto 2 CodigoGrade1 String Código da Grade 1 3 CodigoGrade2 String Código da Grade 2 4 CodigoGrade3 String Código da Grade 3 Classe FiltroSaldoProdutoResumido
1 Produtos ProdutoResumido[] Lista de Códigos de Produtos/Grades 2 CodigoLocais String[] Lista de Código de Locais
3 EstoqueProprio Bool
Indicador se Estoque Próprio deve ser considerada
4 EstoquePoderTerceiros Bool
Indicador se Estoque em Poder de Terceiros deve ser considerada
5 EstoqueTerceiroPoderEmpresa Bool
Indicador se Estoque de Terceiro em Poder da Empresa deve ser considerada
6 DataHoraBaseAlteracao String
Busca somente os Saldos de Produtos atualizados após a Data/Hora (no formato ‘dd/MM/yyyy HH:mm:ss’) informado 7 ControlePaginacao ControlePaginacao Informações da pagina desejada. Classe FiltroSaldoProdutoResumidoKit
1 Produtos ProdutoResumido[] Lista de Códigos de Produtos Kit/Grades 2 CodigoLocais String[] Lista de Código de Locais
3 EstoqueProprio Bool
Indicador se Estoque Próprio deve ser considerada
4 EstoquePoderTerceiros Bool
Indicador se Estoque em Poder de Terceiros deve ser considerada
5 EstoqueTerceiroPoderEmpresa Bool
Indicador se Estoque de Terceiro em Poder da Empresa deve ser considerada
6 CodigoFilial String Código da Filial do Kit
7 ControlePaginacao ControlePaginacao Informações da pagina desejada. Classe QuantidadeDisponivelProduto
1 CodigoProduto String Código do Produto 2 CodigoGrade1 String Código da Grade 1 3 CodigoGrade2 String Código da Grade 2 4 CodigoGrade3 String Código da Grade 3
5 QuantidadeDisponivel String Valor da Quantidade disponível do produto
Classe SaldoProdutoResumido
1 QuantidadeDisponivelProduto QuantidadeDisponivelProduto[]
Lista de Códigos de Produtos/Grades e suas respectivas quantidades disponíveis
Classe ItemRecebimentoProdutos
1 CodigoProduto String Código do Produto 2 CodigoBarras String Código de Barras
3 Grade1 String Código da Grade 1
4 Grade2 String Código da Grade 2
5 Grade3 String Código da Grade 3
6 Embalagem String Embalagem do Produto
7 QuantidadeEmbalagens String Quantidade de Embalagens do produto 8 Tara String Tara da embalageme
9 PesoBruto String Peso bruto 10 Quantidade String Quantide 11 NumeroLote String Numero do lote 12 FabricadoEm String Data da Fabricação
13 NumeroDiasValidade String Numero de dias da validade 14 DataValidade String Data da Validade
Classe RecebimentoProdutos
1 Recebimento String Código do Recebimento
2 Filial String Código da filial
4 CodigoFornecedor String Código do Fornecedor 5 CNPJFornecedor String CNPJ do Fornecedor
6 Itens ItemRecebimentoProdutos[] Itens de recebimento do produto Classe LocalArmazenagem (somente leitura)
1 Codigo String Código do local
2 Filial String Código da filial
3 Classificacao String Classificação do local
4 Nome String Nome do local
5 Inativo Bool Indica se o local está inativo ou não 6 Tipo TipoLocalArmazenagem
Tipo do local, Armazenagem ou Estocagem.
7 ConsumoProprio Bool
Uma das opções de local do tipo Estocagem. Indica que o local é de estoque de consumo próprio
8 Expedicao Bool
Uma das opções de local do tipo Estocagem. Indica que o local é de estoque de expedição
9 EstoquePoderTerceiros Bool
Uma das opções de local do tipo Estocagem. Indica que o local é de estoque da empresa em poder de terceiros
10 EstoqueTerceirosPoderEmpresa Bool
Uma das opções de local do tipo Estocagem. Indica que o local é de estoque de terceiros em poder da empresa
Classe FiltroLocalArmazenagem
1 Codigo String Código do local
2 Tipo TipoLocalArmazenagem
Tipo do local, Armazenagem ou Estocagem.
3 ConsumoProprio Bool
Indicador se Estoque Próprio deve ser considerado
4 Expedicao Bool
Indicador se Estoque de Expedição deve ser considerado
5 EstoquePoderTerceiros Bool
Indicador se Estoque em Poder de Terceiros deve ser considerado
6 EstoqueTerceirosPoderEmpresa Bool
Indicador se Estoque de Terceiro em Poder da Empresa deve ser
considerado Classe FiltroAtendimentoRequisicaoInterna
1 CodigoRequisicaoInterna String
Código da requisição interna para o filtro.
2 DataEmissaoInicial String Data de emissão inicial do filtro. 3 DataEmissaoFinal String Data de final inicial do filtro. 4 ChaveRequisicaoInicial String
Chave inicial da requisição interna para o filtro.
5 ChaveRequisicaoFinal String
Chave final da requisição interna para o filtro.
6 DataNecessidadeInicial String Data inicial da necessidade do filtro. 7 DataNecessidadeFinal String Data final da necessidade do filtro.
8 ControlePaginacao ControlePaginacao Informações da pagina desejada. Classe ItemAtendimentoRequisicaoInterna (somente leitura)
1 EhServico Bool Identificador se o item é um serviço 2 CodigoItem String Código do item.
3 DescricaoGrade1 DescricaoGrade Descrição da Grade1(somente produto) do item.
4 DescricaoGrade2 DescricaoGrade Descrição da Grade2(somente produto) do item.
5 DescricaoGrade3 DescricaoGrade Descrição da Grade3(somente produto) do item.
6 CodigoUnidadeMedida String Código da Unidade de Medida do item. 7 Quantidade String Quantidade do item.
8 CodigoResponsavel String Código do Responsável do item. 9 IdAtendente String Código do Atendente do item. 10 CodigoLocalAtendimento String Código do Local do item.
11 IgnorarAtendimento Bool Indicador se o item deve ser ignorado. 12 RateiosEmpresariais RateioEmpresarial[] Rateios Contábeis/Gerenciais do item. Classe AtendimentoRequisicaoInterna (somente leitura)
1 CodigoFilial String Código da filial do atendimento. 2 ChaveAtendimento String Chave do atendimento.
3 DataAtendimento String Data do atendimento. 4 CodigoResponsavel String
Código do Responsável do atendimento.
5 Observação String Observação do atendimento. 6 ItensAtendimento
ItemAtendimentoRequisicaoInte