Web service Com.senior.g5.co.cad.deposito
O serviço de Depósito é usado para permitir a exportação de registros com controle de integração utilizando a porta exportar. Esse mesmo serviço também contém portas de consulta que permitem obter informações específicas da entidade principal, podendo realizar alguns filtros pré-definidos no serviço.
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_cad_deposito?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_cad_deposito?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_cad_deposito?wsdl
Portas
Após executar o web service será retornado um número de lote, esse número deve ser usado com o código da integração "14" para retornar ao ERP a confirmação de recebimento dos registros,executando o web service com.senior.g5.co.int.geral.exportacao, porta Confirmar.
Quando a sigla do sistema integrado for WMW os registros serão exportados apenas quando o parâmetro Integra WMW do cadastro estiver definido como Sim.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Exportar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <CodEmp>Integer</CodEmp> <CodDep>String</CodDep> <CodFil>Integer</CodFil> <IdentificadorSistema>String</IdentificadorSistema> <QuantidadeRegistros>Integer</QuantidadeRegistros> <TipoIntegracao>String</TipoIntegracao> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
CodDep | String | (Opcional) - String(010) - Código do depósito |
CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
IdentificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
QuantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação. Quando o tipo de integração for "E", este valor não é utilizado. |
TipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarResponse> <result> <Erros> <MensagemErro>String</MensagemErro> </Erros> <FinalizaramRegistros>String</FinalizaramRegistros> <Deposito> <SeqInt>Integer</SeqInt> <CodEmp>Integer</CodEmp> <CodDep>String</CodDep> <DesDep>String</DesDep> <AbrDep>String</AbrDep> <TipDep>Integer</TipDep> <CodMde>Integer</CodMde> <MskDep>String</MskDep> <NivDep>Integer</NivDep> <QtdPos>Integer</QtdPos> <PriBus>Integer</PriBus> <CpmDep>Double</CpmDep> <LarDep>Double</LarDep> <AltDep>Double</AltDep> <CapPes>Double</CapPes> <CapVol>Double</CapVol> <CodFil>Integer</CodFil> <DepCpr>String</DepCpr> <EstNeg>String</EstNeg> <DisXpl>String</DisXpl> <IndClt>String</IndClt> <CodCcu>String</CodCcu> <CriRat>Integer</CriRat> <CtaRed>Integer</CtaRed> <CtaRcr>Integer</CtaRcr> <CtaFdv>Integer</CtaFdv> <CtaFcr>Integer</CtaFcr> <SitDep>String</SitDep> <ObsDep>String</ObsDep> <SeqDep>Integer</SeqDep> <GerEmb>String</GerEmb> <ConAep>String</ConAep> <DepVen>String</DepVen> <DepIql>String</DepIql> <InvEmb>String</InvEmb> <IntWms>String</IntWms> <MsgEsn>String</MsgEsn> <DepVir>String</DepVir> <CriOrd>Integer</CriOrd> <CamposUsuario> <Campo>String</Campo> <Valor>String</Valor> </CamposUsuario> </Deposito> <MensagemRetorno>String</MensagemRetorno> <TipoRetorno>Integer</TipoRetorno> <NumeroLote>Integer</NumeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
Erros | Set | (Opcional) - Lista dos erros |
Erros.MensagemErro | String | (Opcional) - Itens da lista de erros |
FinalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
Deposito | Set | Lista de depósitos |
Deposito.SeqInt | Integer | (Opcional) Number(008) - Número sequencial do registro de exportação |
Deposito.CodEmp | Integer | Number(004) - Código da empresa |
Deposito.CodDep | String | String(010) - Código do depósito |
Deposito.DesDep | String | String(030) - Descrição do depósito |
Deposito.AbrDep | String | String(010) - Abreviatura do depósito |
Deposito.TipDep | Integer | Number(001) - Tipo de depósito/localização - [ 1=Aceita ligação ao produto;2=Não aceita ligação ao produto ] |
Deposito.CodMde | Integer | Number(004) - Código da máscara de depósito |
Deposito.MskDep | String | String(018) - Máscara do depósito |
Deposito.NivDep | Integer | Number(001) - Nível do depósito conforme a máscara |
Deposito.QtdPos | Integer | Number(001) - Quantidade de posições do nível da máscara de depósito |
Deposito.PriBus | Integer | Number(006) - Prioridade de busca no depósito/localização |
Deposito.CpmDep | Double | Number(008,3) - Comprimento do depósito/localização |
Deposito.LarDep | Double | Number(008,3) - Largura do depósito/localização |
Deposito.AltDep | Double | Number(008,3) - Altura do depósito/localização |
Deposito.CapPes | Double | Number(009,3) - Capacidade em peso do depósito/localização |
Deposito.CapVol | Double | Number(009,3) - Capacidade em volume do depósito/localização |
Deposito.CodFil | Integer | Number(005) - Código da filial que o depósito pertence |
Deposito.DepCpr | String | String(001) - Indicativo se o depósito é comprador - [ S=Sim;N=Não ] |
Deposito.EstNeg | String | String(001) - Indicativo se o depósito aceita saldo de estoque negativo - [ S=Sim;N=Não ] |
Deposito.DisXpl | String | String(001) - Considera (S=Sim/N=Não) produtos deste depósito p/ o Cálculo de Necessidades avaliar o estoque disponível (Explosão Nec.) - [ S=Sim;N=Não ] |
Deposito.IndClt | String | String(001) - Indica se o depósito é de coleta (Permite faturar somente de depósitos de coleta) - [ S=Sim;N=Não ] |
Deposito.CodCcu | String | String(009) - Código do Centro de Custo associado ao depósito p/ apuração dos valorização dos estoques por depósito |
Deposito.CriRat | Integer | Number(001) - Critério utilizado para rateio - [ 1=Receitas - Conta X C. Custos;2=Receitas - C. Custos X Conta;3=Despesas - Conta X C. Custos;4=Despesas - C. Custos X Conta;5=Nenhum ] |
Deposito.CtaRed | Integer | Number(007) - Conta contábil reduzida - 1 |
Deposito.CtaRcr | Integer | Number(007) - Conta contábil reduzida - 2 |
Deposito.CtaFdv | Integer | Number(007) - Conta contábil reduzida - 3 |
Deposito.CtaFcr | Integer | Number(007) - Conta contábil reduzida - 4 |
Deposito.SitDep | String | String(001) - Situação do depósito - [ A=Ativo;I=Inativo ] |
Deposito.ObsDep | String | String(250) - Texto da observação do Depósito |
Deposito.SeqDep | Integer | Number(004) - Sequência do Depósito para separação de mercadorias |
Deposito.GerEmb | String | String(001) - Indicativo se são geradas embalagens de estocagem para o produto - [ S=Sim;N=Não ] |
Deposito.ConAep | String | String(001) - Indicativo se considera o depósito na análise de estoque para atendimento do pedido - [ S=Sim;N=Não ] |
Deposito.DepVen | String | String(001) - Indicativo se o depósito é vendedor - [ S=Sim;N=Não ] |
Deposito.DepIql | String | String(001) - Indicativo se o depósito é utilizado para inspeções do SGQ - [ S=Sim;N=Não ] |
Deposito.InvEmb | String | String(001) - Indicativo se o depósito está em processo de inventário de embalagens - [ S=Sim;N=Não ] |
Deposito.IntWms | String | String(001) - Indicativo se o depósito integra com o sistema de WMS - [ S=Sim;N=Não ] |
Deposito.MsgEsn | String | String(001) - Exibir mensagem de estoque negativo - [ S=Sim;N=Não ] |
Deposito.DepVir | String | String(001) - Identificar se depósito é virtual - [ S=Sim;N=Não ] |
Deposito.CriOrd | Integer | Number(004) - Critério de ordenação para formação das pré-faturas |
CamposUsuario | Set | Lista de campos de usuário |
CamposUsuario.Campo | String | Nome do campo |
CamposUsuario.Valor | String | Valor do campo |
MensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
TipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
NumeroLote | Integer | Obrigatório - Inteiro - Identificação do Lote de Exportação |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Nessa porta é possível obter uma coleção de dados através dos filtros disponíveis.
Quando a sigla do sistema integrado for WMW os registros serão exportados apenas quando o parâmetro Integra WMW do cadastro estiver definido como Sim.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ConsultarGeral> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <CodEmp>Integer</CodEmp> <CodDep> <CodDep>String</CodDep> </CodDep> <CodFil>Integer</CodFil> <CodFilDep> <CodFilDep>Integer</CodFilDep> </CodFilDep> <IdentificadorSistema>String</IdentificadorSistema> <SitDep>String</SitDep> <IndicePagina>Integer</IndicePagina> <DepCpr>String</DepCpr> <LimitePagina>Integer</LimitePagina> <EstNeg>String</EstNeg> <IntWms>String</IntWms> </parameters> </ser:ConsultarGeral> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
CodDep | Set | (Opcional) - Lista de abrangência |
CodDep.CodDep | String | (Opcional) - String(010) - Código do depósito |
CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
CodFilDep | Set | (Opcional) - Lista de abrangência |
CodFilDep.CodFilDep | Integer | (Opcional) - Number(005) - Código da filial que o depósito pertence |
IdentificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
SitDep | String | (Opcional) - String(001) - Situação do depósito |
IndicePagina | Integer | (Opcional) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais. |
DepCpr | String | (Opcional) - String(001) - Indicativo se o depósito é comprador |
LimitePagina | Integer | (Opcional) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais. |
EstNeg | String | (Opcional) - String(001) - Indicativo se o depósito aceita saldo de estoque negativo |
IntWms | String | (Opcional) - String(001) - Indicativo se o depósito integra com o sistema WMS |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ConsultarGeralResponse> <result> <Erros> <MensagemErro>String</MensagemErro> </Erros> <MensagemRetorno>String</MensagemRetorno> <Deposito> <CodEmp>Integer</CodEmp> <CodDep>String</CodDep> <DesDep>String</DesDep> <AbrDep>String</AbrDep> <TipDep>Integer</TipDep> <CodMde>Integer</CodMde> <MskDep>String</MskDep> <NivDep>Integer</NivDep> <QtdPos>Integer</QtdPos> <PriBus>Integer</PriBus> <CpmDep>Double</CpmDep> <LarDep>Double</LarDep> <AltDep>Double</AltDep> <CapPes>Double</CapPes> <CapVol>Double</CapVol> <CodFil>Integer</CodFil> <DepCpr>String</DepCpr> <EstNeg>String</EstNeg> <DisXpl>String</DisXpl> <IndClt>String</IndClt> <CodCcu>String</CodCcu> <CriRat>Integer</CriRat> <CtaRed>Integer</CtaRed> <CtaRcr>Integer</CtaRcr> <CtaFdv>Integer</CtaFdv> <CtaFcr>Integer</CtaFcr> <SitDep>String</SitDep> <ObsDep>String</ObsDep> <SeqDep>Integer</SeqDep> <GerEmb>String</GerEmb> <ConAep>String</ConAep> <DepVen>String</DepVen> <DepIql>String</DepIql> <InvEmb>String</InvEmb> <IntWms>String</IntWms> <MsgEsn>String</MsgEsn> <DepVir>String</DepVir> <CriOrd>Integer</CriOrd> <CamposUsuario> <Campo>String</Campo> <Valor>String</Valor> </CamposUsuario> </Deposito> <TipoRetorno>Integer</TipoRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarGeralResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
Erros | Set | (Opcional) - Lista dos erros |
Erros.MensagemErro | String | (Opcional) - Itens da lista de erros |
MensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
Deposito | Set | Lista de depósitos |
Deposito.CodEmp | Integer | Number(004) - Código da empresa |
Deposito.CodDep | String | String(010) - Código do depósito |
Deposito.DesDep | String | String(030) - Descrição do depósito |
Deposito.AbrDep | String | String(010) - Abreviatura do depósito |
Deposito.TipDep | Integer | Number(001) - Tipo de depósito/localização - [ 1=Aceita ligação ao produto;2=Não aceita ligação ao produto ] |
Deposito.CodMde | Integer | Number(004) - Código da máscara de depósito |
Deposito.MskDep | String | String(018) - Máscara do depósito |
Deposito.NivDep | Integer | Number(001) - Nível do depósito conforme a máscara |
Deposito.QtdPos | Integer | Number(001) - Quantidade de posições do nível da máscara de depósito |
Deposito.PriBus | Integer | Number(006) - Prioridade de busca no depósito/localização |
Deposito.CpmDep | Double | Number(008,3) - Comprimento do depósito/localização |
Deposito.LarDep | Double | Number(008,3) - Largura do depósito/localização |
Deposito.AltDep | Double | Number(008,3) - Altura do depósito/localização |
Deposito.CapPes | Double | Number(009,3) - Capacidade em peso do depósito/localização |
Deposito.CapVol | Double | Number(009,3) - Capacidade em volume do depósito/localização |
Deposito.CodFil | Integer | Number(005) - Código da filial que o depósito pertence |
Deposito.DepCpr | String | String(001) - Indicativo se o depósito é comprador - [ S=Sim;N=Não ] |
Deposito.EstNeg | String | String(001) - Indicativo se o depósito aceita saldo de estoque negativo - [ S=Sim;N=Não ] |
Deposito.DisXpl | String | String(001) - Considera (S=Sim/N=Não) produtos deste depósito p/ o Cálculo de Necessidades avaliar o estoque disponível (Explosão Nec.) - [ S=Sim;N=Não ] |
Deposito.IndClt | String | String(001) - Indica se o depósito é de coleta (Permite faturar somente de depósitos de coleta) - [ S=Sim;N=Não ] |
Deposito.CodCcu | String | String(009) - Código do Centro de Custo associado ao depósito p/ apuração dos valorização dos estoques por depósito |
Deposito.CriRat | Integer | Number(001) - Critério utilizado para rateio - [ 1=Receitas - Conta X C. Custos;2=Receitas - C. Custos X Conta;3=Despesas - Conta X C. Custos;4=Despesas - C. Custos X Conta;5=Nenhum ] |
Deposito.CtaRed | Integer | Number(007) - Conta contábil reduzida - 1 |
Deposito.CtaRcr | Integer | Number(007) - Conta contábil reduzida - 2 |
Deposito.CtaFdv | Integer | Number(007) - Conta contábil reduzida - 3 |
Deposito.CtaFcr | Integer | Number(007) - Conta contábil reduzida - 4 |
Deposito.SitDep | String | String(001) - Situação do depósito - [ A=Ativo;I=Inativo ] |
Deposito.ObsDep | String | String(250) - Texto da observação do Depósito |
Deposito.SeqDep | Integer | Number(004) - Sequência do Depósito para separação de mercadorias |
Deposito.GerEmb | String | String(001) - Indicativo se são geradas embalagens de estocagem para o produto - [ S=Sim;N=Não ] |
Deposito.ConAep | String | String(001) - Indicativo se considera o depósito na análise de estoque para atendimento do pedido - [ S=Sim;N=Não ] |
Deposito.DepVen | String | String(001) - Indicativo se o depósito é vendedor - [ S=Sim;N=Não ] |
Deposito.DepIql | String | String(001) - Indicativo se o depósito é utilizado para inspeções do SGQ - [ S=Sim;N=Não ] |
Deposito.InvEmb | String | String(001) - Indicativo se o depósito está em processo de inventário de embalagens - [ S=Sim;N=Não ] |
Deposito.IntWms | String | String(001) - Indicativo se o depósito integra com o sistema de WMS - [ S=Sim;N=Não ] |
Deposito.MsgEsn | String | String(001) - Exibir mensagem de estoque negativo - [ S=Sim;N=Não ] |
Deposito.DepVir | String | String(001) - Identificar se depósito é virtual - [ S=Sim;N=Não ] |
Deposito.CriOrd | Integer | Number(004) - Critério de ordenação para formação das pré-faturas |
CamposUsuario | Set | Lista de campos de usuário |
CamposUsuario.Campo | String | Nome do campo |
CamposUsuario.Valor | String | Valor do campo |
TipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |