English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.int.varejo.verbacompra
Web service Com.senior.g5.co.int.varejo.verbacompra
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_int_varejo_verbacompra?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_verbacompra?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_verbacompra?wsdl
Portas
Exportar
Integrações - Varejo - Verbas de Compra - Exportar Definições
Necessita autenticação: Sim
Situação de 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>
<consulta>
<codNtg>Integer</codNtg>
<vcfCpr>String</vcfCpr>
</consulta>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<tipoIntegracao>String</tipoIntegracao>
<quantidadeRegistros>Integer</quantidadeRegistros>
<identificacaoSistema>String</identificacaoSistema>
</parameters>
</ser:Exportar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| consulta | Set | (Obrigatório) - Utilizar para informar quais registros devem ser retornados. Utilizar apenas quando o tipo de integração for específico ("E") |
| consulta.codNtg | Integer | Integer - Código da Natureza de Gasto: (Obrigatório se tipo de consulta = "E" e VcfCpr não informado) |
| consulta.vcfCpr | String | Date (MM/YYYY) - Mês e ano da competência para controle de verba de compra da filial. (Obrigatório se tipo de consulta = "E" e codNtg não informado) |
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
| 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. |
| identificacaoSistema | String | (Obrigatório) - String(15) - - Identificação do sistema integrado |
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>
<verbaCompra>
<seqInt>Integer</seqInt>
<vcfCpr>String</vcfCpr>
<codNtg>Integer</codNtg>
<desNtg>String</desNtg>
<vlrVcf>Double</vlrVcf>
<sitVer>String</sitVer>
</verbaCompra>
<gridErros>
<msgErr>String</msgErr>
</gridErros>
<finalizaramRegistros>String</finalizaramRegistros>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<numeroLote>Integer</numeroLote>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descriçã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" |
| verbaCompra | Set | |
| verbaCompra.seqInt | Integer | (Obrigatório) - SeqInt - Number(009) - Sequencial do Registro Integrado |
| verbaCompra.vcfCpr | String | (Obrigatório) - VcfCpr - Date (MM/YYYY) - Mês e ano da competência para controle de verba de compra da filial |
| verbaCompra.codNtg | Integer | (Obrigatório) - CodNtg - Number(004) - Natureza de Gasto do custo ou despesa |
| verbaCompra.desNtg | String | (Obrigatório) - DesNtg - String(040) - Descrição da natureza de gasto |
| verbaCompra.vlrVcf | Double | (Obrigatório) - VlrVcf - Number(15, 2) - Verba de compra estabelecida para a competência na filial |
| verbaCompra.sitVer | String | (Obrigatório) - SitVer - String(001) - Situação da verba de compra. Lista: S - Sim, N - Não |
| gridErros | Set | (Opcional) - Lista dos erros |
| gridErros.msgErr | String | Erros |
| finalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| numeroLote | Integer | (Obrigatório) - Inteiro - Identificação do Lote de Exportação |
Importar
Integrações - Varejo - Verbas de Compra - Importar Movimentos
Necessita autenticação: Sim
Situação de 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:Importar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<verbaCompra>
<ideExt>Integer</ideExt>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<vcfCpr>String</vcfCpr>
<codNtg>Integer</codNtg>
<vlrMcf>Double</vlrMcf>
<usuGer>Double</usuGer>
<datGer>String</datGer>
<horGer>String</horGer>
</verbaCompra>
<sistemaIntegracao>String</sistemaIntegracao>
</parameters>
</ser:Importar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| verbaCompra | Set | Dados referentes à movimentos de utilização das verbas pelas filiais |
| verbaCompra.ideExt | Integer | (Obrigatório) - IdeExt - Number(015) - Identificador Externo |
| verbaCompra.codEmp | Integer | (Obrigatório) - CodEmp - Number(004) - Código da empresa |
| verbaCompra.codFil | Integer | (Obrigatório) - CodFil - Number(005) - Código da filial |
| verbaCompra.vcfCpr | String | (Obrigatório) - VcfCpr - String(MM/YYYY) - Mês e ano da competência para controle de verba de compra da filial |
| verbaCompra.codNtg | Integer | (Obrigatório) - CodNtg - Number(004) - Natureza de gasto para controle de verba de compra da filial |
| verbaCompra.vlrMcf | Double | (Opcional) - VlrMcf - Number(014,2) - Valor do movimento de compra na filial |
| verbaCompra.usuGer | Double | (Opcional) - UsuGer - Number(010,0) - Usuário responsável pela geração do registro |
| verbaCompra.datGer | DateTime | (Opcional) - DatGer - Date(DD/MM/YYYY) - Data da geração do registro |
| verbaCompra.horGer | String | (Opcional) - HorGer - Time(HH:MM) - Hora da geração do registro |
| sistemaIntegracao | String | (Obrigatório) - String(15) - Identificação do sistema integrado |
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:ImportarResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<retorno>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<ideExt>Integer</ideExt>
<tipRet>Integer</tipRet>
<codNtg>Integer</codNtg>
<msgRet>String</msgRet>
</retorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ImportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descriçã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" |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| retorno | Set | (Opcional) - Lista dos erros |
| retorno.codEmp | Integer | (Obrigatório) - CodEmp - Number(004) - Código da empresa |
| retorno.codFil | Integer | (Obrigatório) - CodFil - Number(005) - Código da filial |
| retorno.ideExt | Integer | (Obrigatório) - IdeExt - Number(015) - Identificador Externo |
| retorno.tipRet | Integer | (Obrigatório) - TipRet - Number(001) - Tipo de retorno. Valores: 1 - Processado com sucess; 2 - Ocorreram Erros. |
| retorno.codNtg | Integer | (Obrigatório) - CodNtg - Number(004) - Natureza de gasto para controle de verba de compra da filial |
| retorno.msgRet | String | (Opcional) - MsgErr - String(250) - Mensagem de Erro |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
English
Español
