Web service Com.senior.g5.co.int.varejo.condicaopagamento
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_int_varejo_condicaopagamento?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_condicaopagamento?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_condicaopagamento?wsdl
Porta
Integrações - Varejo - Cadastros - Exportar Condições de Pagamento
Necessita autenticação: Sim
Situação de 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> <consulta> <codCpg>String</codCpg> </consulta> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <tipoIntegracao>String</tipoIntegracao> <quantidadeRegistros>Integer</quantidadeRegistros> <sigInt>String</sigInt> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
consulta | Set | Utilizar apenas quando o tipo de integração for específico ("E") |
consulta.codCpg | String | (Obrigatório) - String(006) - Código da condição de pagamento |
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. |
sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
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> <condicaoDePagamento> <codCpg>String</codCpg> <desCpg>String</desCpg> <diaMe1>Integer</diaMe1> <qtdPar>Integer</qtdPar> <ipiPar>String</ipiPar> <outPar>String</outPar> <sitCpg>String</sitCpg> <tipPar>Integer</tipPar> <perEnc>Double</perEnc> <codFpg>Integer</codFpg> <indNeg>Integer</indNeg> <acrFin>Double</acrFin> <perDsc>Double</perDsc> <seqInt>Integer</seqInt> <item> <seqIcp>Integer</seqIcp> <qtdPar>Integer</qtdPar> <diaPar>Integer</diaPar> <perRat>Double</perRat> <diaFix>String</diaFix> </item> </condicaoDePagamento> <resultado> <observacao>String</observacao> <codCpg>String</codCpg> </resultado> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <numLot>Integer</numLot> <finalizaramRegistros>String</finalizaramRegistros> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
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" |
condicaoDePagamento | Set | |
condicaoDePagamento.codCpg | String | String(006) - Código da condição de pagamento |
condicaoDePagamento.desCpg | String | String(050) - Descrição da condição de pagamento |
condicaoDePagamento.diaMe1 | Integer | Number(002) - Primeiro dia especial do mês para vencimento das parcelas |
condicaoDePagamento.qtdPar | Integer | Number(003) - Quantidade total de parcelas da condição de pagamento |
condicaoDePagamento.ipiPar | String | String(001) - Indicativo se o valor total do IPI deve estar na primeira parcela - Lista: S = Sim, N = Não |
condicaoDePagamento.outPar | String | String(001) - Indicativo se o valor total das outras despesas deve estar na primeira parcela - Lista: S = Sim, N = Não |
condicaoDePagamento.sitCpg | String | String(001) - Situação da condição de pagamento - Lista: A = Ativo, I = Inativo |
condicaoDePagamento.tipPar | Integer | Number(001) - Tipo de parcelas - Lista: 1 = Iguais - Dif. Primeira Parcela, 2 = Iguais - Dif. Última Parcela, 3 = Parcelas Diferentes |
condicaoDePagamento.perEnc | Double | Number(005) - Percentual de encargos |
condicaoDePagamento.codFpg | Integer | Number(002) - Código da forma de pagamento |
condicaoDePagamento.indNeg | Integer | Number(001) - Indicativo de permissão para negociação no sistema de varejo - Lista: 0 = Nenhuma, 1 = Juros, 2 = Vencimentos, 3 = Valores/Vencimentos, 4 = Valores/Vencimentos e Juros |
condicaoDePagamento.acrFin | Double | Number(005) - Percentual de acréscimo financeiro para produtos com tabela de preço no módulo de vendas |
condicaoDePagamento.perDsc | Double | Number(005) - Percentual a acrescentar ou diminuir aos descontos concedidos |
condicaoDePagamento.seqInt | Integer | (Obrigatório) - Number(007) - Sequência do registro |
condicaoDePagamento.item | Set | |
condicaoDePagamento.item.seqIcp | Integer | (Obrigatório) - Number(002) - Sequência do item |
condicaoDePagamento.item.qtdPar | Integer | Number(003) - Quantidade de parcelas |
condicaoDePagamento.item.diaPar | Integer | Number(003) - Quantidade de dias de intervalo entre as parcelas |
condicaoDePagamento.item.perRat | Double | Number(005) - Percentual do total a ser considerado para a condição de pagamento |
condicaoDePagamento.item.diaFix | String | (Obrigatório) - String(001) - Dia Fixo - Lista: S = Sim, N = Não |
resultado | Set | (Opcional) - Neste grupo somente serão retornados resultados onde foi solicitado um Tipo de Integração = E ( Registro Específico) e a requisição não foi atendida. |
resultado.observacao | String | String(100) - Motivo do registro não ter sido exportado |
resultado.codCpg | String | String(006) - Código da condição de pagamento |
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 |
numLot | Integer | (Obrigatório) - Number(7) - Número do lote |
finalizaramRegistros | String | String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |