Web service Com.senior.g5.co.cad.formapagamento
O serviço de Forma de pagamento é 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.
- 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_cad_formapagamento?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_cad_formapagamento?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_cad_formapagamento?wsdl
Portas
Após executar o web service será retornado um número de lote, esse número deve ser usado com o código da integração "3" para retornar ao ERP a confirmação de recebimento dos registros, executando o web service com.senior.g5.co.int.geral.exportacao, porta Confirmar.
Quando a sigla do sistema integrado for WMW os registros serão exportados apenas quando o parâmetro Integra WMW do cadastro estiver definido como Sim.
Necessita autenticação: Sim.
Situação da 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> <CodEmp>Integer</CodEmp> <CodFpg>String</CodFpg> <CodFil>Integer</CodFil> <IdentificadorSistema>String</IdentificadorSistema> <QuantidadeRegistros>Integer</QuantidadeRegistros> <TipoIntegracao>String</TipoIntegracao> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
CodFpg | String | (Opcional) - Number(002) - Código da forma de pagamento |
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 |
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> <FormaPagamento> <SeqInt>Integer</SeqInt> <CodEmp>Integer</CodEmp> <CodFpg>Integer</CodFpg> <DesFpg>String</DesFpg> <AbrFpg>String</AbrFpg> <VenMfp>Double</VenMfp> <VenFpl>String</VenFpl> <TipFpg>Integer</TipFpg> <FveFpg>String</FveFpg> <FveDec>String</FveDec> <IndExp>Integer</IndExp> <DatPal>DateTime</DatPal> <HorPal>Integer</HorPal> <CodEcf>String</CodEcf> <CodOpe>Integer</CodOpe> <TipCar>String</TipCar> <ExiAcr>String</ExiAcr> <DatAtu>DateTime</DatAtu> <HorAtu>Integer</HorAtu> <UsuAtu>Double</UsuAtu> <DatGer>DateTime</DatGer> <HorGer>Integer</HorGer> <UsuGer>Double</UsuGer> <SitFpg>String</SitFpg> <AcrFin>Double</AcrFin> <VenDsc>Double</VenDsc> <CprDsc>Double</CprDsc> <PerDsc>Double</PerDsc> <PerCom>Double</PerCom> <RedCom>Double</RedCom> <GerCtr>String</GerCtr> <CodCli>Integer</CodCli> <CodBan>String</CodBan> <BndDeb>String</BndDeb> <BndCre>String</BndCre> <CodTpt>String</CodTpt> <TptTef>String</TptTef> <TptSub>String</TptSub> <CodFin>Integer</CodFin> <TptCpr>String</TptCpr> <ConInf>String</ConInf> <CamposUsuario> <Campo>String</Campo> <Valor>String</Valor> </CamposUsuario> </FormaPagamento> <MensagemRetorno>String</MensagemRetorno> <FinalizaramRegistros>String</FinalizaramRegistros> <NumeroLote>Integer</NumeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
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 |
FormaPagamento | Set | Lista de formas de pagamento |
FormaPagamento.SeqInt | Integer | (Opcional) Number(008) - Número sequencial do registro de exportação |
FormaPagamento.CodEmp | Integer | Number(004) - Código da Empresa |
FormaPagamento.CodFpg | Integer | Number(002) - Código da forma de pagamento |
FormaPagamento.DesFpg | String | String(030) - Descrição da forma de pagamento |
FormaPagamento.AbrFpg | String | String(010) - Abreviatura da forma de pagamento |
FormaPagamento.VenMfp | Double | Number(015,2) - Valor mínimo de pedido de venda para a forma de pagamento |
FormaPagamento.VenFpl | String | String(001) - Indicativo se a forma de pagamento está liberada para qualquer cliente - [ S=Sim;N=Não ] |
FormaPagamento.TipFpg | Integer | Number(002) - Tipo de Pagamento para controle do Acerto - [ 1=Dinheiro;2=Cheque;3=Duplicata;4=Ticket;5=Promissória;6=Cartão de Crédito;7=Cartão de Débito;8=Cartão Manual;9=Outros;10=À Prazo;11=Vale;12=Cartão Presente;13=Troca de mercadorias;14=Convênio;15=Financiamento Próprio;16=Financiamento Externo;17=Cartão automático;18=Cartão crédito administradora automática;19=Cartão débito administradora automática;20=Cartão;21=Vendor ] |
FormaPagamento.FveFpg | String | String(010) - Hierarquia da Forma de Venda |
FormaPagamento.FveDec | String | String(001) - Indicativo se pode liberar formas de venda inferiores - [ S=Sim;N=Não ] |
FormaPagamento.IndExp | Integer | Number(001) - Indicativo se o registro foi alterado para exportar para o palm - [ 0=Para Exportar;1=Em Exportação;2=Exportado;3=Aprovado;4=Em Digitação;5=Aguardando Liberação para Envio;9=Erro ] |
FormaPagamento.DatPal | DateTime | Date(DD/MM/YYYY) - Data da última alteração para o Palmtop |
FormaPagamento.HorPal | Integer | Number(005) - Hora/minuto da última alteração para o Palm |
FormaPagamento.CodEcf | String | String(003) - Código da finalizadora para ECF |
FormaPagamento.CodOpe | Integer | Number(004) - Código da operadora |
FormaPagamento.TipCar | String | String(001) - Tipo do cartão utilizado pela operadora - [ D=Débito;C=Crédito ] |
FormaPagamento.ExiAcr | String | String(001) - Indicativo se a forma de pagamento exige análise de crédito do cliente - [ S=Sim;N=Não ] |
FormaPagamento.DatAtu | DateTime | Date(DD/MM/YYYY) - Data da última atualização |
FormaPagamento.HorAtu | Integer | Number(005) - Hora/minuto da última atualização |
FormaPagamento.UsuAtu | Double | Number(010) - Usuário responsável pela última atualização |
FormaPagamento.DatGer | DateTime | Date(DD/MM/YYYY) - Data da geração do registro |
FormaPagamento.HorGer | Integer | Number(005) - Hora da geração do registro |
FormaPagamento.UsuGer | Double | Number(010) - Usuário responsável pela geração do registro |
FormaPagamento.SitFpg | String | String(001) - Situação da forma de pagamento - [ A=Ativo;I=Inativo ] |
FormaPagamento.AcrFin | Double | Number(005,2) - Percentual de acréscimo financeiro para produtos com tabela de preço no módulo de vendas |
FormaPagamento.VenDsc | Double | Number(005,2) - Percentual a acrescentar ou diminuir para formação do preço de venda |
FormaPagamento.CprDsc | Double | Number(005,2) - Percentual a acrescentar ou diminuir para formação do preço de compra |
FormaPagamento.PerDsc | Double | Number(005,2) - Percentual a acrescentar ou diminuir aos descontos concedidos |
FormaPagamento.PerCom | Double | Number(005,2) - Percentual a acrescentar ou diminuir à comissão do representante |
FormaPagamento.RedCom | Double | Number(005,2) - Percentual redutor do valor base comissão |
FormaPagamento.GerCtr | String | String(001) - Indicativo se a forma de pagamento deverá gerar contrato automaticamente - [ S=Sim;N=Não ] |
FormaPagamento.CodCli | Integer | Number(009) - Código do cliente para a geração do contrato financeiro e controle de comissão |
FormaPagamento.CodBan | String | String(003) - Código do banco na Febraban |
FormaPagamento.BndDeb | String | String(199) - Bandeiras aceitas para cartão de débito no PDV |
FormaPagamento.BndCre | String | String(199) - Bandeiras aceitas para cartão de crédito no PDV |
FormaPagamento.CodTpt | String | String(003) - Código do tipo de título a receber para vendas |
FormaPagamento.TptTef | String | String(003) - Código do tipo de título a receber para operações com TEF |
FormaPagamento.TptSub | String | String(003) - Tipo de título substituto no contas a receber pelo varejo |
FormaPagamento.CodFin | Integer | Number(004) - Código da financeira |
FormaPagamento.TptCpr | String | String(003) - Código do tipo de título a pagar |
FormaPagamento.ConInf | String | String(001) - Indica se informações para forma de pagamento serão validadas no pedido ou análise de crédito - [ A=Análise de Crédito;P=Pedido ] |
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" |
Nessa porta é possível obter uma coleção de dados através dos filtros disponíveis.
Quando a sigla do sistema integrado for WMW os registros serão exportados apenas quando o parâmetro Integra WMW do cadastro estiver definido como Sim.
Necessita autenticação: Sim.
Situação da 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:ConsultarGeral> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <CodEmp>Integer</CodEmp> <CodFpg> <CodFpg>Integer</CodFpg> </CodFpg> <CodFil>Integer</CodFil> <SitFpg>String</SitFpg> <IdentificadorSistema>String</IdentificadorSistema> <TipFpg> <TipFpg>Integer</TipFpg> </TipFpg> <IndicePagina>Integer</IndicePagina> <LimitePagina>Integer</LimitePagina> </parameters> </ser:ConsultarGeral> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
CodFpg | Set | (Opcional) - Lista de abrangência |
CodFpg.CodFpg | Integer | (Opcional) - Number(002) - Código da forma de pagamento |
CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
SitFpg | String | (Opcional) - String(001) - Situação do depósito |
IdentificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
TipFpg | Set | (Opcional) - Lista de abrangência |
TipFpg.TipFpg | Integer | (Opcional) - Number(002) - Tipo de Pagamento para controle do Acerto |
IndicePagina | Integer | (Opcional) - 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 | (Opcional) - 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. |
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> <FormaDePagamento> <CodEmp>Integer</CodEmp> <CodFpg>Integer</CodFpg> <DesFpg>String</DesFpg> <AbrFpg>String</AbrFpg> <VenMfp>Double</VenMfp> <VenFpl>String</VenFpl> <TipFpg>Integer</TipFpg> <FveFpg>String</FveFpg> <FveDec>String</FveDec> <IndExp>Integer</IndExp> <DatPal>DateTime</DatPal> <HorPal>Integer</HorPal> <CodEcf>String</CodEcf> <CodOpe>Integer</CodOpe> <TipCar>String</TipCar> <ExiAcr>String</ExiAcr> <DatAtu>DateTime</DatAtu> <HorAtu>Integer</HorAtu> <UsuAtu>Double</UsuAtu> <DatGer>DateTime</DatGer> <HorGer>Integer</HorGer> <UsuGer>Double</UsuGer> <SitFpg>String</SitFpg> <AcrFin>Double</AcrFin> <VenDsc>Double</VenDsc> <CprDsc>Double</CprDsc> <PerDsc>Double</PerDsc> <PerCom>Double</PerCom> <RedCom>Double</RedCom> <GerCtr>String</GerCtr> <CodCli>Integer</CodCli> <CodBan>String</CodBan> <BndDeb>String</BndDeb> <BndCre>String</BndCre> <CodTpt>String</CodTpt> <TptTef>String</TptTef> <TptSub>String</TptSub> <CodFin>Integer</CodFin> <TptCpr>String</TptCpr> <ConInf>String</ConInf> <CamposUsuario> <Campo>String</Campo> <Valor>String</Valor> </CamposUsuario> </FormaDePagamento> <TipoRetorno>Integer</TipoRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarGeralResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Ajuda |
---|---|---|
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 |
FormaDePagamento | Set | Lista de forma de pagamento |
FormaDePagamento.CodEmp | Integer | Number(004) - Código da Empresa |
FormaDePagamento.CodFpg | Integer | Number(002) - Código da forma de pagamento |
FormaDePagamento.DesFpg | String | String(030) - Descrição da forma de pagamento |
FormaDePagamento.AbrFpg | String | String(010) - Abreviatura da forma de pagamento |
FormaDePagamento.VenMfp | Double | Number(015,2) - Valor mínimo de pedido de venda para a forma de pagamento |
FormaDePagamento.VenFpl | String | String(001) - Indicativo se a forma de pagamento está liberada para qualquer cliente - [ S=Sim;N=Não ] |
FormaDePagamento.TipFpg | Integer | Number(002) - Tipo de Pagamento para controle do Acerto - [ 1=Dinheiro;2=Cheque;3=Duplicata;4=Ticket;5=Promissória;6=Cartão de Crédito;7=Cartão de Débito;8=Cartão Manual;9=Outros;10=À Prazo;11=Vale;12=Cartão Presente;13=Troca de mercadorias;14=Convênio;15=Financiamento Próprio;16=Financiamento Externo;17=Cartão automático;18=Cartão crédito administradora automática;19=Cartão débito administradora automática;20=Cartão;21=Vendor ] |
FormaDePagamento.FveFpg | String | String(010) - Hierarquia da Forma de Venda |
FormaDePagamento.FveDec | String | String(001) - Indicativo se pode liberar formas de venda inferiores - [ S=Sim;N=Não ] |
FormaDePagamento.IndExp | Integer | Number(001) - Indicativo se o registro foi alterado para exportar para o palm - [ 0=Para Exportar;1=Em Exportação;2=Exportado;3=Aprovado;4=Em Digitação;5=Aguardando Liberação para Envio;9=Erro ] |
FormaDePagamento.DatPal | DateTime | Date(DD/MM/YYYY) - Data da última alteração para o Palmtop |
FormaDePagamento.HorPal | Integer | Number(005) - Hora/minuto da última alteração para o Palm |
FormaDePagamento.CodEcf | String | String(003) - Código da finalizadora para ECF |
FormaDePagamento.CodOpe | Integer | Number(004) - Código da operadora |
FormaDePagamento.TipCar | String | String(001) - Tipo do cartão utilizado pela operadora - [ D=Débito;C=Crédito ] |
FormaDePagamento.ExiAcr | String | String(001) - Indicativo se a forma de pagamento exige análise de crédito do cliente - [ S=Sim;N=Não ] |
FormaDePagamento.DatAtu | DateTime | Date(DD/MM/YYYY) - Data da última atualização |
FormaDePagamento.HorAtu | Integer | Number(005) - Hora/minuto da última atualização |
FormaDePagamento.UsuAtu | Double | Number(010) - Usuário responsável pela última atualização |
FormaDePagamento.DatGer | DateTime | Date(DD/MM/YYYY) - Data da geração do registro |
FormaDePagamento.HorGer | Integer | Number(005) - Hora da geração do registro |
FormaDePagamento.UsuGer | Double | Number(010) - Usuário responsável pela geração do registro |
FormaDePagamento.SitFpg | String | String(001) - Situação da forma de pagamento - [ A=Ativo;I=Inativo ] |
FormaDePagamento.AcrFin | Double | Number(005,2) - Percentual de acréscimo financeiro para produtos com tabela de preço no módulo de vendas |
FormaDePagamento.VenDsc | Double | Number(005,2) - Percentual a acrescentar ou diminuir para formação do preço de venda |
FormaDePagamento.CprDsc | Double | Number(005,2) - Percentual a acrescentar ou diminuir para formação do preço de compra |
FormaDePagamento.PerDsc | Double | Number(005,2) - Percentual a acrescentar ou diminuir aos descontos concedidos |
FormaDePagamento.PerCom | Double | Number(005,2) - Percentual a acrescentar ou diminuir à comissão do representante |
FormaDePagamento.RedCom | Double | Number(005,2) - Percentual redutor do valor base comissão |
FormaDePagamento.GerCtr | String | String(001) - Indicativo se a forma de pagamento deverá gerar contrato automaticamente - [ S=Sim;N=Não ] |
FormaDePagamento.CodCli | Integer | Number(009) - Código do cliente para a geração do contrato financeiro e controle de comissão |
FormaDePagamento.CodBan | String | String(003) - Código do banco na Febraban |
FormaDePagamento.BndDeb | String | String(199) - Bandeiras aceitas para cartão de débito no PDV |
FormaDePagamento.BndCre | String | String(199) - Bandeiras aceitas para cartão de crédito no PDV |
FormaDePagamento.CodTpt | String | String(003) - Código do tipo de título a receber para vendas |
FormaDePagamento.TptTef | String | String(003) - Código do tipo de título a receber para operações com TEF |
FormaDePagamento.TptSub | String | String(003) - Tipo de título substituto no contas a receber pelo varejo |
FormaDePagamento.CodFin | Integer | Number(004) - Código da financeira |
FormaDePagamento.TptCpr | String | String(003) - Código do tipo de título a pagar |
FormaDePagamento.ConInf | String | String(001) - Indica se informações para forma de pagamento serão validadas no pedido ou análise de crédito - [ A=Análise de Crédito;P=Pedido ] |
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" |