Serviço atualizarBudget
34.1 - Requisição
O serviço atualizarBudget realiza lançamentos (Créditos ou Débitos) de aportes e saldos no Budget. O lançamento pode ser vinculado em uma Regional, Centro de Custo ou Sub Centro de Custo. Somente um dos três vinculos acima podem ser informados em uma requisição, por exemplo, se for informado uma Regional, não deverá ser informado Centro de Custo e Sub Centro de Custo.
Obs: Para que haja qualquer interação com o sistema de Webservice é necessário informar o cabeçalho de autenticação. Vide “Cabeçalho de Autenticação”.
Descrição dos campos de requisição budget
Tag | Descrição | Parent | Formato | Required |
regionalRef | Referência da regional a qual será lançado o Budget | budget | regionalRef | True |
centroDeCustoRef | Referência da Centro de Custo a qual será lançado o Budget | budget | centroDeCustoRef | True |
subCentroDeCustoRef | Referência da Sub Centro de Custo a qual será lançado o Budget | budget | subCentroDeCustoRef | True |
tipoOperacaoBudget | Tipo de operação: CREDITO ou DEBITO | budget | Enum | True |
valor | Valor a ser lançado no Budget | budget | Double (#.##) | True |
modalidadeLancamentoBudget | Tipo de Transação: MENSAL (Aporte fixo mensal), ANUAL (Aporte fixo anual), EXTRA, ACERTO, RESIDUAL ou ATUALIZACAO | budget | Enum | True |
Descrição do campo regionalRef
Tag | Descrição | Parent | Formato | Required |
codigo | Código identificador da regional no sistema | regionalRef | String | True |
Descrição do campo CentroDeCustoRef
Tag | Descrição | Parent | Formato | Required |
codigo | Código identificador do centro de custo no sistema | centroDeCustoRef | String | True |
regionalRef | Código identificador da regional na qual esse centro de custo pertence | centroDeCustoRef | RegionalRef | True |
Descrição do campo SubCentroDeCustoRef
Tag | Descrição | Parent | Formato | Required |
codigo | Código identificador do sub centro de custo no sistema | subCentroDeCustoRef | String | True |
centroDeCustoRef | Código identificador do centro de custo no qual o sub centro de custo pertence | subCentroDeCustoRef | CentroDeCustoRef | True |
34.2 - Exemplo
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://lemontech.com.br/selfbooking/wsselfbooking/services"> <soapenv:Header> <ser:userPassword>userPassword</ser:userPassword> <ser:userName>userName</ser:userName> <ser:keyClient>keyClient</ser:keyClient> </soapenv:Header> <soapenv:Body> <ser:atualizarBudget> <budget> <regionalRef> <codigo>01</codigo> </regionalRef> <modalidadeLancamentoBudget>MENSAL</modalidadeLancamentoBudget> <tipoOperacaoBudget>CREDITO</tipoOperacaoBudget> <valor>120.00</valor> </budget> </ser:atualizarBudget> </soapenv:Body> </soapenv:Envelope>
34.3 - Exemplo
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://lemontech.com.br/selfbooking/wsselfbooking/services"> <soapenv:Header> <ser:userPassword>userPassword</ser:userPassword> <ser:userName>userName</ser:userName> <ser:keyClient>keyClient</ser:keyClient> </soapenv:Header> <soapenv:Body> <ser:atualizarBudget> <budget> <centroDeCustoRef> <codigo>10000</codigo> <regionalRef> <codigo>01</codigo> </regionalRef> </centroDeCustoRef> <modalidadeLancamentoBudget>MENSAL</modalidadeLancamentoBudget> <tipoOperacaoBudget>CREDITO</tipoOperacaoBudget> <valor>120.00</valor> </budget> </ser:atualizarBudget> </soapenv:Body> </soapenv:Envelope>
34.4 - Exemplo
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://lemontech.com.br/selfbooking/wsselfbooking/services"> <soapenv:Header> <ser:userPassword>userPassword</ser:userPassword> <ser:userName>userName</ser:userName> <ser:keyClient>keyClient</ser:keyClient> </soapenv:Header> <soapenv:Body> <ser:atualizarBudget> <budget> <subCentroDeCustoRef> <codigo>10001</codigo> <centroDeCustoRef> <codigo>10000</codigo> <regionalRef> <codigo>01</codigo> </regionalRef> </centroDeCustoRef> </subCentroDeCustoRef> <modalidadeLancamentoBudget>MENSAL</modalidadeLancamentoBudget> <tipoOperacaoBudget>CREDITO</tipoOperacaoBudget> <valor>120.00</valor> </budget> </ser:atualizarBudget> </soapenv:Body> </soapenv:Envelope>
34.5 - Resposta
A resposta do serviço é enviada com a tag atualizarBudgetResponse informando “Sucesso”, caso o cadastro efetuado corretamente, “Erro”, caso ocorra algum problema ou “Alerta”, caso ocorra algum problema não-crítico no cadastro ou alteração.
Descrição dos campos de Atualizar Budget Response
Tag | Descrição | Parent | Formato |
resultadoOperacao | Resultado da operação solicitada | atualizarBudgetResponse | ResultadoOperacao |
Descrição do campo resultadoOperacao
Tag | Descrição | Parent | Formato |
status | Se SUCESSO a pesquisa foi efetuada com sucesso Se ERRO ocorreu algum problema durante a pesquisa Se ALERTA ocorreu algum problema não-crítico durante a pesquisa | resultadoOperacao | String |
mensagem | Mensagem com a descrição do status retornado | resultadoOperacao | String |
34.6 - Exemplo
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <S:Body> <ns2:atualizarBudgetResponse xmlns:ns2="http://lemontech.com.br/selfbooking/wsselfbooking/services"> <resultadoOperacao> <status>SUCESSO</status> </resultadoOperacao> </ns2:atualizarBudgetResponse> </S:Body> </S:Envelope>
34.7 - Exemplo
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <S:Body> <ns2:atualizarBudgetResponse xmlns:ns2="http://lemontech.com.br/selfbooking/wsselfbooking/services"> <resultadoOperacao> <status>ERRO</status> <mensagem>Regional 01 já possui valores alocados impossibilitando a operação. Disponivel: 5137.00 Valor transação: -10000.0</mensagem> </resultadoOperacao> </ns2:atualizarBudgetResponse> </S:Body> </S:Envelope>