English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.cad.agrupamentos
Web service Com.senior.g5.co.cad.agrupamentos
O serviço de Agrupamento é 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.
Campos que representam valores monetários, quantidade e percentual e estão declarados como String
- 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
Exemplo:
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.
Campos que representam valores monetários, quantidade e percentual e não estão declarados como String
- 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
Exemplo:
- 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_agrupamentos?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_cad_agrupamentos?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_cad_agrupamentos?wsdl
Portas
Exportar
Após executar o web service, será retornado um número de lote. Este número deve ser usado com o código da integração 89 para retornar ao sistema a confirmação de recebimento dos registros, executando o web service com.senior.g5.co.int.geral.exportacao, porta Confirmar.
Necessita autenticação: sim.
Situação da versão: atual.
Versão: 1.
Requisição:
<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>
<CodAgp>String</CodAgp>
<CodFil>Integer</CodFil>
<IdentificadorSistema>String</IdentificadorSistema>
<QuantidadeRegistros>Integer</QuantidadeRegistros>
<TipoIntegracao>String</TipoIntegracao>
</parameters>
</ser:Exportar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| CodAgp | String | (Opcional) - String(005) - Código da forma de agrupamento dos produtos |
| 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 |
Resposta:
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>
<TipoRetorno>Integer</TipoRetorno>
<Agrupamento>
<SeqInt>Integer</SeqInt>
<CodEmp>Integer</CodEmp>
<CodAgp>String</CodAgp>
<DesAgp>String</DesAgp>
<AbrAgp>String</AbrAgp>
<TipAgp>String</TipAgp>
<CriRat>Integer</CriRat>
<CtaRed>Integer</CtaRed>
<CtaRcr>Integer</CtaRcr>
<CtaFdv>Integer</CtaFdv>
<CtaFcr>Integer</CtaFcr>
<CodFif>String</CodFif>
<CodFie>String</CodFie>
<CodFim>String</CodFim>
<MgcMin>Double</MgcMin>
<MgcLim>Double</MgcLim>
<PerVen>Double</PerVen>
<AplAtx>String</AplAtx>
<CodAtx>Double</CodAtx>
<PreRef>Double</PreRef>
<CamposUsuario>
<Campo>String</Campo>
<Valor>String</Valor>
</CamposUsuario>
</Agrupamento>
<MensagemRetorno>String</MensagemRetorno>
<FinalizaramRegistros>String</FinalizaramRegistros>
<NumeroLote>Integer</NumeroLote>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| Erros | Set | (Opcional) - Lista dos erros |
| Erros.MensagemErro | String | (Opcional) - Itens da lista de erros |
| TipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
| Agrupamento | Set | Lista de agrupamentos para produtos |
| Agrupamento.SeqInt | Integer | (Opcional) Number(008) - Número sequencial do registro de exportação |
| Agrupamento.CodEmp | Integer | Number(004) - Código da empresa |
| Agrupamento.CodAgp | String | String(005) - Código da forma de agrupamento dos produtos |
| Agrupamento.DesAgp | String | String(030) - Descrição da forma de agrupamento dos produtos |
| Agrupamento.AbrAgp | String | String(010) - Abreviatura da forma de agrupamento dos produtos |
| Agrupamento.TipAgp | String | String(001) - Código do tipo de agrupamento dos produtos - [ E=Para Estoques;C=Para Comercial (Compras e Vendas);T=Para Cotas Vendas;P=Para Produção;U=Para Custos;O=Orçamento;F=Para Impostos;M=Para Preço;A=Aprovação multinível;G=Garantia Estendida ] |
| Agrupamento.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 ] |
| Agrupamento.CtaRed | Integer | Number(007) - Conta contábil reduzida - 1 |
| Agrupamento.CtaRcr | Integer | Number(007) - Conta contábil reduzida - 2 |
| Agrupamento.CtaFdv | Integer | Number(007) - Conta contábil reduzida - 3 |
| Agrupamento.CtaFcr | Integer | Number(007) - Conta contábil reduzida - 4 |
| Agrupamento.CodFif | String | String(010) - Código Fiscal Federal do Agrupamento |
| Agrupamento.CodFie | String | String(010) - Código Fiscal Estadual do Agrupamento |
| Agrupamento.CodFim | String | String(010) - Código Fiscal Municipal do Agrupamento |
| Agrupamento.MgcMin | Double | Number(015,6) - Percentual de margem de contribuição mínima |
| Agrupamento.MgcLim | Double | Number(015,6) - Percentual de margem de contribuição limite |
| Agrupamento.PerVen | Double | Number(024,12) - Percentual adicional do vendedor no cálculo da margem |
| Agrupamento.AplAtx | String | String(004) - Código da aplicação do autotexto - [ SREB=Suprimentos - Recebimento - Entrada via Balança;VAAT=Serviços - Assistência Técnica - Registro de Ocorrências ] |
| Agrupamento.CodAtx | Double | Number(010) - Código do autotexto |
| Agrupamento.PreRef | Double | Number(024,12) - Preço de referência vinculada a margem de contribuição |
| 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 |
| FinalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Nã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" |
ConsultarGeral
Nesta porta é possível obter uma coleção de dados através dos filtros.
Necessita autenticação: sim.
Situação da versão: atual.
Versão: 1.
Requisição:
<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>
<CodAgp>
<CodAgp>String</CodAgp>
</CodAgp>
<CodFil>Integer</CodFil>
<TipAgp>
<TipAgp>String</TipAgp>
</TipAgp>
<IdentificadorSistema>String</IdentificadorSistema>
<IndicePagina>Integer</IndicePagina>
<LimitePagina>Integer</LimitePagina>
</parameters>
</ser:ConsultarGeral>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| CodAgp | Set | (Opcional) - Lista de abrangência |
| CodAgp.CodAgp | String | (Opcional) - String(005) - Código da forma de agrupamento dos produto |
| CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| TipAgp | Set | (Opcional) - Lista de abrangência |
| TipAgp.TipAgp | String | (Opcional) - String(001) - Código do tipo de agrupamento dos produtos |
| IdentificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
| IndicePagina | Integer | (Obrigatório) - 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. |
| LimitePagina | Integer | (Obrigatório) - 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. |
Resposta:
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>
<Agrupamento>
<CodEmp>Integer</CodEmp>
<CodAgp>String</CodAgp>
<DesAgp>String</DesAgp>
<AbrAgp>String</AbrAgp>
<TipAgp>String</TipAgp>
<CriRat>Integer</CriRat>
<CtaRed>Integer</CtaRed>
<CtaRcr>Integer</CtaRcr>
<CtaFdv>Integer</CtaFdv>
<CtaFcr>Integer</CtaFcr>
<CodFif>String</CodFif>
<CodFie>String</CodFie>
<CodFim>String</CodFim>
<MgcMin>Double</MgcMin>
<MgcLim>Double</MgcLim>
<PerVen>Double</PerVen>
<AplAtx>String</AplAtx>
<CodAtx>Double</CodAtx>
<PreRef>Double</PreRef>
<CamposUsuario>
<Campo>String</Campo>
<Valor>String</Valor>
</CamposUsuario>
</Agrupamento>
<TipoRetorno>Integer</TipoRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarGeralResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| 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 |
| Agrupamento | Set | Lista de formas de agrupamento para o produto |
| Agrupamento.CodEmp | Integer | Number(004) - Código da empresa |
| Agrupamento.CodAgp | String | String(005) - Código da forma de agrupamento dos produtos |
| Agrupamento.DesAgp | String | String(030) - Descrição da forma de agrupamento dos produtos |
| Agrupamento.AbrAgp | String | String(010) - Abreviatura da forma de agrupamento dos produtos |
| Agrupamento.TipAgp | String | String(001) - Código do tipo de agrupamento dos produtos - [ E=Para Estoques;C=Para Comercial (Compras e Vendas);T=Para Cotas Vendas;P=Para Produção;U=Para Custos;O=Orçamento;F=Para Impostos;M=Para Preço;A=Aprovação multinível;G=Garantia Estendida ] |
| Agrupamento.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 ] |
| Agrupamento.CtaRed | Integer | Number(007) - Conta contábil reduzida - 1 |
| Agrupamento.CtaRcr | Integer | Number(007) - Conta contábil reduzida - 2 |
| Agrupamento.CtaFdv | Integer | Number(007) - Conta contábil reduzida - 3 |
| Agrupamento.CtaFcr | Integer | Number(007) - Conta contábil reduzida - 4 |
| Agrupamento.CodFif | String | String(010) - Código Fiscal Federal do Agrupamento |
| Agrupamento.CodFie | String | String(010) - Código Fiscal Estadual do Agrupamento |
| Agrupamento.CodFim | String | String(010) - Código Fiscal Municipal do Agrupamento |
| Agrupamento.MgcMin | Double | Number(015,6) - Percentual de margem de contribuição mínima |
| Agrupamento.MgcLim | Double | Number(015,6) - Percentual de margem de contribuição limite |
| Agrupamento.PerVen | Double | Number(024,12) - Percentual adicional do vendedor no cálculo da margem |
| Agrupamento.AplAtx | String | String(004) - Código da aplicação do autotexto - [ SREB=Suprimentos - Recebimento - Entrada via Balança;VAAT=Serviços - Assistência Técnica - Registro de Ocorrências ] |
| Agrupamento.CodAtx | Double | Number(010) - Código do autotexto |
| Agrupamento.PreRef | Double | Number(024,12) - Preço de referência vinculada a margem de contribuição |
| 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" |
English
Español
