Web service Com.senior.g5.co.mcm.est.ordemcompra
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.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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_mcm_est_ordemcompra?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mcm_est_ordemcompra?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_mcm_est_ordemcompra?wsdl
Portas
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Suprimentos - Gestão de Compras - Ordem de Compra - Ordens Pendentes
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 4
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:buscarPendentes> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <indicePagina>Integer</indicePagina> <limitePagina>Integer</limitePagina> <CodUsu>Integer</CodUsu> </parameters> </ser:buscarPendentes> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
indicePagina | Opcional | 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 | Opcional | 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. |
CodUsu | Opcional | Integer | (Opcional) - Number(010) - Código do usuário para ser utilizado como filtro. Se não for informado um código, será utilizado o usuário conectado no sistema. |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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:buscarPendentesResponse> <result> <ordemCompra> <usuarioSolicitante>Integer</usuarioSolicitante> <nomeSolicitante>String</nomeSolicitante> <codigoEmpresa>Integer</codigoEmpresa> <nomeEmpresa>String</nomeEmpresa> <codigoFilial>Integer</codigoFilial> <nomeFilial>String</nomeFilial> <numero>Integer</numero> <dataEmissao>String</dataEmissao> <nomeFornecedor>String</nomeFornecedor> <valorAproximado>Double</valorAproximado> <observacao>String</observacao> <MoedaOC>String</MoedaOC> <item> <descricao>String</descricao> <quantidadeSolicitada>Double</quantidadeSolicitada> <unidadeMedida>String</unidadeMedida> <valorUnitario>Double</valorUnitario> <observacao>String</observacao> <rateio> <codigoCentroCustos>String</codigoCentroCustos> <valorRateio>Double</valorRateio> <percentualRateio>Double</percentualRateio> <abreviaturaCentroCustos>String</abreviaturaCentroCustos> </rateio> <valorLiquido>Double</valorLiquido> <siglaMoeda>String</siglaMoeda> <descricaoMoeda>String</descricaoMoeda> <valorLiquidoMoeda>Double</valorLiquidoMoeda> <vlrFre>String</vlrFre> <vlrSeg>String</vlrSeg> <vlrEmb>String</vlrEmb> <vlrOut>String</vlrOut> <vlrBru>String</vlrBru> <vlrDsc>String</vlrDsc> <vlrDs1>String</vlrDs1> <vlrDs2>String</vlrDs2> <vlrDs3>String</vlrDs3> <vlrDs4>String</vlrDs4> <vlrDs5>String</vlrDs5> <vlrLpr>String</vlrLpr> </item> <rateio> <codigoCentroCustos>String</codigoCentroCustos> <valorRateio>Double</valorRateio> <percentualRateio>Double</percentualRateio> <abreviaturaCentroCustos>String</abreviaturaCentroCustos> </rateio> <observacaoMotivo>String</observacaoMotivo> <moedaOC>String</moedaOC> <moedaEmpresa>String</moedaEmpresa> </ordemCompra> <codigoResultado>String</codigoResultado> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:buscarPendentesResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | 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" |
ordemCompra | Opcional | Set | Lista de solicitações de compra pendentes |
ordemCompra.usuarioSolicitante | Opcional | Integer | (Obrigatório) - Number(010) - Usuário responsóvel pela geração da ordem de compra |
ordemCompra.nomeSolicitante | Opcional | String | (Opcional) - String(0255) - Nome do solicitante |
ordemCompra.codigoEmpresa | Opcional | Integer | (Obrigatório) - Number(04) - Código da empresa |
ordemCompra.nomeEmpresa | Opcional | String | (Obrigatório) - String(100) - Nome da empresa |
ordemCompra.codigoFilial | Opcional | Integer | (Obrigatório) - Number(04) - Código da filial |
ordemCompra.nomeFilial | Opcional | String | (Obrigatório) - String(100) - Razão social da filial da empresa |
ordemCompra.numero | Opcional | Integer | (Obrigatório) - Number(09) - Número da ordem de compra |
ordemCompra.dataEmissao | Opcional | DateTime | (Obrigatório) - Date(000) - Data de emissão |
ordemCompra.nomeFornecedor | Opcional | String | (Obrigatório) - String(100) - Nome do fornecedor |
ordemCompra.valorAproximado | Opcional | Double | (Obrigatório) - Number(15,6) - Valor aproximado da solicitação |
ordemCompra.observacao | Opcional | String | (Opcional) - String(250) - Observação da ordem de compra |
ordemCompra.MoedaOC | Opcional | String | (Opcional) - String(05) - Sigla da moeda do cabeçalho da ordem de compra |
ordemCompra.item | Opcional | Set | |
ordemCompra.item.descricao | Opcional | String | (Obrigatório) - String(100) - Descrição do produto ou do serviço |
ordemCompra.item.quantidadeSolicitada | Opcional | Double | (Obrigatório) - Number(014,5) - Quantidade solicitada |
ordemCompra.item.unidadeMedida | Opcional | String | (Opcional) - String(03) - Unidade de medida |
ordemCompra.item.valorUnitario | Opcional | Double | (Obrigatório) - Number(015,6) - Preço unitário do item |
ordemCompra.item.observacao | Opcional | String | (Opcional) - String(250) - Observação do item da ordem de compra |
ordemCompra.item.rateio | Opcional | Set | (Opcional) - Rateio do item da ordem de compra |
ordemCompra.item.rateio.codigoCentroCustos | Opcional | String | (Opcional) - String(009) - Código do centro de custos |
ordemCompra.item.rateio.valorRateio | Opcional | Double | (Opcional) - Number(15,2) - Valor rateado por centro de custos |
ordemCompra.item.rateio.percentualRateio | Opcional | Double | (Opcional) - Number(7,4) - Percentual rateado para o centro de custo |
ordemCompra.item.rateio.abreviaturaCentroCustos | Opcional | String | (Opcional) - String(020) - Abreviatura do centro de custos |
ordemCompra.item.valorLiquido | Opcional | Double | (Obrigatório) - Number(015,2) - Valor líquido |
ordemCompra.item.siglaMoeda | Opcional | String | (Opcional) - String(005) - Sigla da moeda |
ordemCompra.item.descricaoMoeda | Opcional | String | (Opcional) - String(030) - Descrição da moeda ou índice |
ordemCompra.item.valorLiquidoMoeda | Opcional | Double | (Obrigatório) - Number(015,2) - Valor líquido convertido para a moeda da empresa |
ordemCompra.item.VlrFre | Opcional | String | Number(015,2) - Valor frete |
ordemCompra.item.VlrSeg | Opcional | String | Number(015,2) - Valor do seguro |
ordemCompra.item.VlrEmb | Opcional | String | Number(015,2) - Valor embalagem |
ordemCompra.item.VlrOut | Opcional | String | Number(015,2) - Valor outras despesas destacado |
ordemCompra.item.VlrBru | Opcional | String | Number(015,2) - Valor bruto do item da nota fiscal de entrada |
ordemCompra.item.VlrDsc | Opcional | String | Number(015,2) - Valor do desconto do item da nota fiscal de entrada |
ordemCompra.item.VlrDs1 | Opcional | String | Number(015,2) - Valor do desconto 1 |
ordemCompra.item.VlrDs2 | Opcional | String | Number(015,2) - Valor do desconto 2 |
ordemCompra.item.VlrDs3 | Opcional | String | Number(015,2) - Valor do desconto 3 |
ordemCompra.item.VlrDs4 | Opcional | String | Number(015,2) - Valor do desconto 4 |
ordemCompra.item.VlrDs5 | Opcional | String | Number(015,2) - Valor do desconto 5 |
ordemCompra.item.VlrLpr | Opcional | String | Number(015,2) - Valor do produto |
ordemCompra.rateio | Opcional | Set | (Opcional) - Rateio da ordem de compra |
ordemCompra.rateio.codigoCentroCustos | Opcional | String | (Opcional) - String(009) - Código do centro de custos |
ordemCompra.rateio.valorRateio | Opcional | Double | (Opcional) - Number(15,2) - Valor rateado por centro de custos |
ordemCompra.rateio.percentualRateio | Opcional | Double | (Opcional) - Number(7,4) - Percentual rateado para o centro de custo |
ordemCompra.rateio.abreviaturaCentroCustos | Opcional | String | (Opcional) - String(020) - Abreviatura do centro de custos |
ordemCompra.observacaoMotivo | Opcional | String | |
ordemCompra.moedaOC | String | Código da moeda da ordem de compra | |
ordemCompra.moedaEmpresa | String | Código da moeda da empresa dos dados gerais OC | |
codigoResultado | Opcional | String | O campo tipo resultado irá retornar para:
Execução do serviço sem erros: "1" Execução do serviço com erros: "2" |
resultado | Opcional | String | O campo resultado irá retornar as seguintes mensagens:
Execução do serviço sem erros: "Processado com sucesso" Execução do serviço com erros: "ERRO: " concatenando a mensagem de erro |
erroExecucao | Opcional | String |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Suprimentos - Gestão de Compras - Ordem de Compra - Aprovar
Nota
A execução destes processos Enviar e-mail ao fornecedor após fechar e Fechar o documento após o último nível de aprovação depende dos valores contidos nos parâmetros globais MarDesFec e MarDesEnv e dos identificadores de regras CPR-420MAIAP01 e CPR-420EMAOC01.
Assim, os possíveis cenários são demonstrados conforme abaixo:
Caso os parâmetros MarDesFec e MarDesEnv estejam como "N":
- Aprovação do documento;
- Acionamento do identificador de regra CPR-420MAIAP01.
Caso o parâmetro MarDesFec esteja como "S" e o parâmetro MarDesEnv como "N":
- Aprovação do documento;
- Acionamento do identificador de regra CPR-420MAIAP01.
- Caso o processo de aprovação esteja no último estágio, realiza o fechamento do documento.
Caso os parâmetros MarDesFec e MarDesEnv estejam como "S":
- Aprovação do documento;
- Acionamento do identificador de regra CPR-420MAIAP01.
- Caso o processo de aprovação esteja no último estágio, realiza o fechamento do documento.
Após o processo de fechamento do documento parametrizado, caso o identificador de regras CPR-420EMAOC01 esteja ativo, faz o envio de e-mail para o fornecedor.
- Caso o processo de aprovação esteja no último estágio, realiza o fechamento do documento.
Caso o parâmetro MarDesFec esteja como "N" e o parâmetro MarDesEnv como "S":
- Aprovação do documento.
- Acionamento do identificador de regra CPR-420MAIAP01.
Se o controle de projetos e a aprovação com fechamento automático estiverem configurados para emitir mensagem de aviso em caso de orçamento excedido, não será disparada nenhuma mensagem neste cenário e o processo seguirá normalmente, tanto para aprovações via web service ou via mobilidade.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:aprovar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <ordemCompra> <sequência>Integer</sequência> <codigoEmpresa>Integer</codigoEmpresa> <codigoFilial>Integer</codigoFilial> <numero>Integer</numero> </ordemCompra> </parameters> </ser:aprovar> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
ordemCompra | Opcional | Set | Lista de ordens de compra para serem aprovadas |
ordemCompra.sequência | Opcional | Integer | (Obrigatório) - Number(009) - Número sequencial para identificar retornos |
ordemCompra.codigoEmpresa | Opcional | Integer | (Obrigatório) - Number(004) - Código da empresa |
ordemCompra.codigoFilial | Opcional | Integer | (Obrigatório) - Number(005) - Código da filial da ordem de compra |
ordemCompra.numero | Opcional | Integer | (Obrigatório) - Number(009) - Número da ordem de compra |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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:aprovarResponse> <result> <retorno> <sequência>Integer</sequência> <codigoEmpresa>Integer</codigoEmpresa> <codigoFilial>Integer</codigoFilial> <numero>Integer</numero> <resultado>Integer</resultado> <mensagemErro>String</mensagemErro> </retorno> <codigoResultado>String</codigoResultado> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:aprovarResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | 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" |
retorno | Opcional | Set | |
retorno.sequência | Opcional | Integer | (Obrigatório) - Number(09) - Número sequencial para identificar retornos |
retorno.codigoEmpresa | Opcional | Integer | (Obrigatório) - Number(004) - Código da empresa |
retorno.codigoFilial | Opcional | Integer | (Obrigatório) - Number(005) - Código da filial da ordem de compra |
retorno.numero | Opcional | Integer | (Obrigatório) - Number(009) - Número da ordem de compra |
retorno.resultado | Opcional | Integer | (Obrigatório) - Number (001) - Código de retorno:
1 - Sucesso 2 - Erro |
retorno.mensagemErro | Opcional | String | (Opcional) - String - Mensagem de retorno
Resultado: 1 - Será retornada a mensagem "Processado com sucesso" (sem aspas). 2 - Será retornada a mensagem do erro. |
codigoResultado | Opcional | String | O campo tipo resultado irá retornar para:
Execução do serviço sem erros: "1" Execução do serviço com erros: "2" |
resultado | Opcional | String | O campo resultado irá retornar as seguintes mensagens:
Execução do serviço sem erros: "Processado com sucesso" Execução do serviço com erros: "ERRO: " concatenando a mensagem de erro |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Suprimentos - Gestão de Compras - Ordem de Compra - Reprovar
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:reprovar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <ordemCompra> <sequência>Integer</sequência> <codigoEmpresa>Integer</codigoEmpresa> <codigoFilial>Integer</codigoFilial> <numero>Integer</numero> </ordemCompra> </parameters> </ser:reprovar> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
ordemCompra | Opcional | Set | Lista de ordens de compra para serem aprovadas |
ordemCompra.sequência | Opcional | Integer | (Obrigatório) - Number(009) - Número sequencial para identificar retornos |
ordemCompra.codigoEmpresa | Opcional | Integer | (Obrigatório) - Number(004) - Código da empresa |
ordemCompra.codigoFilial | Opcional | Integer | (Obrigatório) - Number(005) - Código da filial da ordem de compra |
ordemCompra.numero | Opcional | Integer | (Obrigatório) - Number(009) - Número da ordem de compra |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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:reprovarResponse> <result> <retorno> <sequência>Integer</sequência> <codigoEmpresa>Integer</codigoEmpresa> <codigoFilial>Integer</codigoFilial> <numero>Integer</numero> <resultado>Integer</resultado> <mensagemErro>String</mensagemErro> </retorno> <codigoResultado>String</codigoResultado> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:reprovarResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | 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" |
retorno | Opcional | Set | |
retorno.sequência | Opcional | Integer | (Obrigatório) - Number(09) - Número sequencial para identificar retornos |
retorno.codigoEmpresa | Opcional | Integer | (Obrigatório) - Number(004) - Código da empresa |
retorno.codigoFilial | Opcional | Integer | (Obrigatório) - Number(005) - Código da filial da ordem de compra |
retorno.numero | Opcional | Integer | (Obrigatório) - Number(009) - Número da ordem de compra |
retorno.resultado | Opcional | Integer | (Obrigatório) - Number (001) - Código de retorno:
1 - Sucesso 2 - Erro |
retorno.mensagemErro | Opcional | String | (Opcional) - String - Mensagem de retorno
Resultado: 1 - Será retornada a mensagem "Processado com sucesso" (sem aspas). 2 - Será retornada a mensagem do erro. |
codigoResultado | Opcional | String | O campo tipo resultado irá retornar para:
Execução do serviço sem erros: "1" Execução do serviço com erros: "2" |
resultado | Opcional | String | O campo resultado irá retornar as seguintes mensagens:
Execução do serviço sem erros: "Processado com sucesso" Execução do serviço com erros: "ERRO: " concatenando a mensagem de erro |