English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.int.varejo.formaspagamento
Web service Com.senior.g5.co.int.varejo.formaspagamento
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_formaspagamento?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_formaspagamento?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_formaspagamento?wsdl
Porta
Exportar
Integrações - Varejo - Cadastros - Exportar Formas de Pagamento
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>
<codEmp>Integer</codEmp>
<consulta>
<codFpg>Integer</codFpg>
</consulta>
<codFil>Integer</codFil>
<tipoIntegracao>String</tipoIntegracao>
<quantidadeRegistros>Integer</quantidadeRegistros>
<sigInt>String</sigInt>
</parameters>
</ser:Exportar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| consulta | Set | Utilizar apenas quando o tipo de integração for específico ("E") |
| consulta.codFpg | Integer | (Obrigatório) - Number(002) - Código da forma de pagamento. |
| 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 |
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>
<formaDePagamento>
<codFpg>Integer</codFpg>
<desFpg>String</desFpg>
<tipFpg>Integer</tipFpg>
<sitFpg>String</sitFpg>
<codOpe>Integer</codOpe>
<tipCar>String</tipCar>
<seqInt>Integer</seqInt>
<parametrosPorFilial>
<perAcr>Double</perAcr>
<perDsc>Double</perDsc>
<maxTro>String</maxTro>
<texCpv>String</texCpv>
<bloTit>String</bloTit>
<maxSan>String</maxSan>
<bloDsc>String</bloDsc>
<bloCli>String</bloCli>
<bloRec>String</bloRec>
<nomFav>String</nomFav>
<fpgTro>String</fpgTro>
<codEqu>Integer</codEqu>
<codEcf>String</codEcf>
<desEcf>String</desEcf>
<maxPar>Integer</maxPar>
<vlrLim>String</vlrLim>
<codMoe>String</codMoe>
<bloVen>String</bloVen>
<conLcc>String</conLcc>
</parametrosPorFilial>
<diasACompensar>
<qdtDia>Integer</qdtDia>
<vlrTax>Double</vlrTax>
<desTax>String</desTax>
</diasACompensar>
<codTpt>String</codTpt>
</formaDePagamento>
<resultado>
<observacao>String</observacao>
<codFpg>Integer</codFpg>
</resultado>
<finalizaramRegistros>String</finalizaramRegistros>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<numLot>Integer</numLot>
<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" |
| formaDePagamento | Set | |
| formaDePagamento.codFpg | Integer | Number(002) - Código da Forma de Pagamento |
| formaDePagamento.desFpg | String | String(030) - Descrição da forma de pagamento |
| formaDePagamento.tipFpg | Integer | Number(002) - Tipo de pagamento: 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 22 - Vale Alimentação 23 - Vale Refeição 24 - Vale Combustível 25 - Boleto bancário 27 - Depósito Bancário 28 - Transferência Bancária, Carteira Digital 29 - Programa de Fidelidade, Cashback, Crédito Virtual 30 - PIX Transferência 31 - PIX QR Code |
| formaDePagamento.sitFpg | String | String(001) - Situação da forma de pagamento - Lista: A = Ativo, I = Inativo |
| formaDePagamento.codOpe | Integer | Number(004) - Código da Operadora |
| formaDePagamento.tipCar | String | String(001) - Tipo Cartão - Lista: D = Débito, C = Crédito |
| formaDePagamento.seqInt | Integer | (Obrigatório) - Number(7) - Sequência do registro |
| formaDePagamento.parametrosPorFilial | Set | |
| formaDePagamento.parametrosPorFilial.perAcr | Double | Number(005) - Percentual de Acréscimo da Forma de Pagamento. |
| formaDePagamento.parametrosPorFilial.perDsc | Double | Number(005) - Percentual de desconto da forma de pagamento. |
| formaDePagamento.parametrosPorFilial.maxTro | String | Number(015) - Valor máximo para troco do pagamento. Será retornado sempre zero caso o tipo da forma de pagamento seja diferente de "1" (Dinheiro), "2" (Cheque), "4" (Ticket), "9" (Outros), "11" (Vale) e "13" (Troca de Mercadorias). |
| formaDePagamento.parametrosPorFilial.texCpv | String | String(999) - Texto para impressão de comprovante. |
| formaDePagamento.parametrosPorFilial.bloTit | String | String(001) - Indicativo se está bloqueado para operação de recebimento de títulos - Lista: S = Sim, N = Não |
| formaDePagamento.parametrosPorFilial.maxSan | String | Number(015) - Valor máximo para realização da sangria no caixa. Somente será exportado caso a forma de pagamento possuir o campo Forma Pgto Troco preenchido na tela F066VAR. |
| formaDePagamento.parametrosPorFilial.bloDsc | String | String(001) - Indicativo se a forma de pagamento está bloqueada para cupons com desconto - Lista: S = Sim, N = Não |
| formaDePagamento.parametrosPorFilial.bloCli | String | String(001) - Indicativo se está bloqueada para cupom com cliente não cadastrado - Lista: S = Sim, N = Não |
| formaDePagamento.parametrosPorFilial.bloRec | String | String(001) - Indica se bloqueia a forma de pagamento em recebimentos de Recarga de Celular - Lista: S = Sim, N = Não |
| formaDePagamento.parametrosPorFilial.nomFav | String | String(040) - Nome do favorecido para impressão de cheque. |
| formaDePagamento.parametrosPorFilial.fpgTro | String | Number(002) - Código da forma de pagamento para fornecer troco. Será retornado sempre zero caso o tipo da forma de pagamento seja diferente de "1" (Dinheiro), "2" (Cheque), "4" (Ticket), "9" (Outros), "11" (Vale) e "13" (Troca de Mercadorias). Se o campo de troco for zero será retornado nulo. |
| formaDePagamento.parametrosPorFilial.codEqu | Integer | Number(003) - Código Equipamento fiscal |
| formaDePagamento.parametrosPorFilial.codEcf | String | (Obrigatório) - String(003) - Código da finalização para ECF |
| formaDePagamento.parametrosPorFilial.desEcf | String | String(016) - Descrição da forma de pagamento para ECF. Observação: Essa descrição somente será utilizada caso o equipamento fiscal esteja configurado para encontrar o meio de pagamento pela descrição. Exemplo: Bematech |
| formaDePagamento.parametrosPorFilial.maxPar | Integer | (Opcional) - Number(003) - Quantidade máxima de parcelas. Será r'etornado sempre zero caso o tipo de forma de pagamento seja diferente de "2" (Cheque), "6" (Cartão de crédito), "8" (Cartão manual) e "10" (À Prazo). |
| formaDePagamento.parametrosPorFilial.vlrLim | String | Number(015) - Valor limite aceito para a forma de pagamento. |
| formaDePagamento.parametrosPorFilial.codMoe | String | (Opcional) - String(003) - Código da moeda ou índice a ser utilizado com esta forma de pagamento |
| formaDePagamento.parametrosPorFilial.bloVen | String | (Obrigatório) - String(001) - Indica se bloqueia a forma de pagamento para vendas |
| formaDePagamento.parametrosPorFilial.conLcc | String | (Obrigatório) - String(001) - Indicativo se consiste o limite de crédito disponível do cliente para a forma de pagamento. - Lista: S = Sim, N = Não') |
| formaDePagamento.diasACompensar | Set | |
| formaDePagamento.diasACompensar.qdtDia | Integer | (Obrigatório) - Number(003) - Dias a compensar |
| formaDePagamento.diasACompensar.vlrTax | Double | (Obrigatório) - Number(007) - Taxa |
| formaDePagamento.diasACompensar.desTax | String | (Opcional) - String(030) - Descrição |
| formaDePagamento.codTpt | String | Código do tipo de título a receber para vendas |
| 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.codFpg | Integer | Number(002) - Código da forma de pagamento. |
| finalizaramRegistros | String | 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 |
| numLot | Integer | (Obrigatório) - Number(7) - Número do lote |
English
Español
