Web service Com.senior.g5.co.int.varejo.clientes
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_clientes?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_clientes?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_clientes?wsdl
Portas
- ExportarClientes
- ConsultarCliente
- ConsultarCredito
- ConsultarHistoricoFinanceiro_2
- ImportarConsultaSPC
Integrações - Varejo - Cadastros - Exportar Clientes
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:ExportarClientes>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<codEmp>Integer</codEmp>
<consultaCliente>
<codCli>String</codCli>
</consultaCliente>
<codFil>Integer</codFil>
<quantidadeRegistros>Integer</quantidadeRegistros>
<tipmer>String</tipmer>
<tipoIntegracao>String</tipoIntegracao>
<sigInt>String</sigInt>
</parameters>
</ser:ExportarClientes>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| consultaCliente | Set | Este grupo é utilizado na requisição de um registro específico (Tipo de Integração = E " Registro Específico"). |
| consultaCliente.codCli | String | (Obrigatório) - Number(009) - Código do Cliente. |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação - Observação: Quando solicitado um tipo de integração E (Específico), a quantidade de registros será ignorada, mesmo se informada. |
| tipmer | String | (Opcional) - String(001) - Tipo do Mercado - Lista: I = Interno, E = Externo. |
| tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
| 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:ExportarClientesResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<cliente>
<codCli>String</codCli>
<nomCli>String</nomCli>
<apeCli>String</apeCli>
<cgcCpf>String</cgcCpf>
<tipCli>String</tipCli>
<tipMer>String</tipMer>
<insEst>String</insEst>
<insMun>String</insMun>
<fonCli>String</fonCli>
<fonCl2>String</fonCl2>
<faxCli>String</faxCli>
<intNet>String</intNet>
<endCli>String</endCli>
<nenCli>String</nenCli>
<nomPai>String</nomPai>
<cplEnd>String</cplEnd>
<baiCli>String</baiCli>
<cepCli>String</cepCli>
<cidCli>String</cidCli>
<sigUfs>String</sigUfs>
<cliPrx>String</cliPrx>
<ideCli>String</ideCli>
<sitCli>String</sitCli>
<seqInt>Integer</seqInt>
<cEP>
<cepIni>String</cepIni>
<cepFim>String</cepFim>
<cepCli>String</cepCli>
<endCid>String</endCid>
<baiCid>String</baiCid>
<nomCid>String</nomCid>
<sigUfs>String</sigUfs>
<nomUfs>String</nomUfs>
<codRai>String</codRai>
<codPai>String</codPai>
<nomPai>String</nomPai>
</cEP>
<pessoaFisica>
<codSex>String</codSex>
<datNas>String</datNas>
<estCiv>String</estCiv>
<endDer>String</endDer>
<numRge>String</numRge>
<orgRge>String</orgRge>
<datRge>String</datRge>
<nomPai>String</nomPai>
<nomMae>String</nomMae>
</pessoaFisica>
<definicao>
<vlrLim>String</vlrLim>
<codRep>String</codRep>
<codCpg>String</codCpg>
</definicao>
<convenios>
<codCnv>String</codCnv>
<numCcn>String</numCcn>
<limCre>String</limCre>
<sitCnv>String</sitCnv>
<dependentes>
<depCnv>String</depCnv>
<depNom>String</depNom>
<cgcCpf>String</cgcCpf>
<depCcn>String</depCcn>
<depCpl>String</depCpl>
<sitDep>String</sitDep>
<senCnv>String</senCnv>
</dependentes>
<senCnv>String</senCnv>
</convenios>
<tipEmc>Integer</tipEmc>
</cliente>
<mensagemRetorno>String</mensagemRetorno>
<resultado>
<codCli>String</codCli>
<observacao>String</observacao>
</resultado>
<finalizaramRegistros>String</finalizaramRegistros>
<numLot>Integer</numLot>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarClientesResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Ajuda |
|---|---|---|
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| cliente | Set | |
| cliente.codCli | String | (Obrigatório) - Number(009) - Código do Cliente. |
| cliente.nomCli | String | (Obrigatório) - Nome do cliente. |
| cliente.apeCli | String | (Opcional) - String(50) - Nome fantasia do cliente. |
| cliente.cgcCpf | String | (Obrigatório) - Number(014) - Número do CNPJ ou CPF do cliente. |
| cliente.tipCli | String | (Obrigatório) - String(001) - Tipo do cliente. - Lista: J = Pessoa Jurídica, F = Pessoa Física |
| cliente.tipMer | String | (Opcional) - String(001) - Tipo de mercado do cliente. - Lista: I = Interno (Nacional), E = Externo (Exterior), P = Prospect. |
| cliente.insEst | String | (Opcional) - String(025) - Inscrição estadual do cliente. |
| cliente.insMun | String | (Opcional) - String(016) - Inscrição municipal do cliente. |
| cliente.fonCli | String | (Opcional) - String(020) - Número do telefone - 1. |
| cliente.fonCl2 | String | (Opcional) - String(020) - Número do telefone - 2. |
| cliente.faxCli | String | (Opcional) - String(020) - Número do FAX do cliente. |
| cliente.intNet | String | (Opcional) - String(100) - Endereço eletrônico (e-mail). |
| cliente.endCli | String | (Opcional) - String(100) - Endereço do cliente. |
| cliente.nenCli | String | (Opcional) - String(060) - Número do Endereço do Cliente. |
| cliente.nomPai | String | (Opcional) - String(150) - Nome do País. |
| cliente.cplEnd | String | (Opcional) - String(060) - Complemento do endereço do cliente (sala, andar, etc.). |
| cliente.baiCli | String | (Opcional) - String(075) - Bairro do cliente. |
| cliente.cepCli | String | (Opcional) - Number(008) - CEP do cliente. |
| cliente.cidCli | String | (Opcional) - String(060) - Cidade do cliente. |
| cliente.sigUfs | String | (Opcional) - String(002) - Sigla do estado do cliente. |
| cliente.cliPrx | String | (Opcional) - String(120) - Ponto de referência ou proximidade do cliente. |
| cliente.ideCli | String | (Opcional) - String(020) - Código para identificação do cliente. |
| cliente.sitCli | String | (Opcional) - String(001) - Situação do cliente. - Lista: A = Ativo, I = Inativo |
| cliente.seqInt | Integer | (Opcional) - Numero(007) - Sequência do registro |
| cliente.tipEmc | Integer | (Opcional) Tipo do direito de propriedade da empresa |
| cEP | Set | (Opcional) - Será enviado se o cliente tiver um CEP cadastrado. |
| cEP.cepIni | String | (Obrigatório) - Number(008) - Faixa inicial do CEP da cidade. |
| cEP.cepFim | String | (Obrigatório) - Number(008) - Faixa final do CEP da cidade. |
| cEP.cepCli | String | (Obrigatório) - Number(008) - CEP do cliente. |
| cEP.endCid | String | (Obrigatório) - String(100) - Endereço referente ao CEP (quando faixa de apenas um CEP). |
| cEP.baiCid | String | (Opcional) - String(075) - Bairro referente ao CEP Informado (quando faixa de apenas um CEP). |
| cEP.nomCid | String | (Opcional) - String(060) - Nome da cidade. |
| cEP.sigUfs | String | (Obrigatório) - String(002) - Sigla do estado da cidade. |
| cEP.nomUfs | String | (Obrigatório) - String(020) - Nome do estado. |
| cEP.codRai | String | (Obrigatório) - Number(007) - Código da cidade para a RAIS. |
| cEP.codPai | String | (Obrigatório) - String(004) - Código do País. |
| cEP.nomPai | String | (Obrigatório) - String(150) - Nome do País. |
| pessoaFisica | Set | (Opcional) - Será enviado se tiver o cadastro de pessoa física do cliente. |
| pessoaFisica.codSex | String | (Opcional) - String(003) - Código do sexo. - Lista: M = Masculino, F = Feminino - Observação: No Gestão Empresarial | ERP é possível cadastrar outros Sexos. |
| pessoaFisica.datNas | String | (Opcional) - Date - Data do nascimento do cliente. |
| pessoaFisica.estCiv | String | (Opcional) - Number(001) - Estado civil do cliente. - Lista: 1 = Solteiro, 2 = Casado, 3 = Desquitado, 4 = Divorciado, 5 = Viúvo, 6 = Concubinado,7 = Separado Judicialmente, 9 = Outros |
| pessoaFisica.endDer | String | |
| pessoaFisica.numRge | String | (Opcional) - String(013) - Número do RG (Identidade). |
| pessoaFisica.orgRge | String | (Opcional) - String(005) - Órgão emissor do RG. |
| pessoaFisica.datRge | String | (Opcional) - Date - Data de emissão do RG. |
| pessoaFisica.nomPai | String | (Opcional) - String(030) - Nome do pai do cliente. |
| pessoaFisica.nomMae | String | (Opcional) - String(030) - Nome da mãe do cliente. |
| definicao | Set | (Obrigatório) - Cadastro do cliente para a filial. |
| definicao.vlrLim | String | (Opcional) - Number(015,2) - Valor do limite de crédito do cliente. |
| definicao.codRep | String | (Obrigatório) - Number(009) - Código do representante padrão para o cliente. |
| definicao.codCpg | String | (Obrigatório) - String(006) - Código da condição de pagamento padrão para o cliente. |
| convenios | Set | (Opcional) - Este grupo somente será enviado se tiver convenios para o cliente. |
| convenios.codCnv | String | (Obrigatório) - Number(004) - Código do convênio. |
| convenios.numCcn | String | (Opcional) - String(020) - Número do cartão do convênio. |
| convenios.limCre | String | (Opcional) - Number(015,2) - Limite de crédito do convênio do cliente. |
| convenios.sitCnv | String | (Obrigatório) - String(001) - Situação do convênio - Lista: A = Ativo, I = Inativo |
| dependentes | Set | (Opcional) - Será enviado se o convenio do cliente tiver dependentes. |
| dependentes.depCnv | String | (Obrigatório) - Number(004) - Código do Dependente. |
| dependentes.depNom | String | (Obrigatório) - String(100) - Nome do Dependente. |
| dependentes.cgcCpf | String | (Opcional) - Number(014) - Número do CNPJ ou CPF do dependente. |
| dependentes.depCcn | String | (Opcional) - String(020) - Número do cartão do convênio. |
| dependentes.depCpl | String | (Opcional) - String(030) - Informação complementar ao cadastro de dependentes. |
| dependentes.sitDep | String | (Obrigatório) - String(001) - Situação do Dependente. Lista: A = Ativo, I = Inativo |
| dependentes.senCnv | String | Senha do conveniado no convênio |
| convenios.senCnv | String | Senha do conveniado no convênio |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| resultado | Set | 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.codCli | String | (Obrigatório) - Number(009) - Código do Cliente. |
| resultado.observacao | String | (Obrigatório) - String(100) - Motivo do registro não ter sido exportado, ou OK para os registros que retonaram com sucesso. |
| finalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| numLot | Integer | (Obrigatório) - Number(7) - Número do lote |
| 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" |
Observação
Quando for a exportação de um cadastro de cliente, onde o parâmetro cliente.tipMer for "E = Externo (Exterior)", os parâmetros cliente.cEP.endCid, cliente.cEP.baiCid, cliente.cEP.nomCid e cliente.cEP.nomPai virão preenchidos respectivamente com os parâmetros: cliente.endCli, cliente.baiCli, cliente.cidCli e cliente.nomPai. O parâmetro cliente.cEP.codPai virá preenchido com o código do país do cadastro do cliente.
Integrações - Varejo - Cadastros - Consultar Cliente
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:ConsultarCliente>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codCli>Integer</codCli>
</parameters>
</ser:ConsultarCliente>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| codCli | Integer | (Obrigatório) - Number(009) - Código do Cliente |
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:ConsultarClienteResponse>
<result>
<salDup>String</salDup>
<salOut>String</salOut>
<salCre>String</salCre>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<datLim>String</datLim>
<vlrLim>String</vlrLim>
<creDis>String</creDis>
<limApr>String</limApr>
<creBlo>String</creBlo>
<motBlo>String</motBlo>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarClienteResponse>
</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" |
| salDup | String | (Obrigatório) - Number(15,2) - Saldo devedor de duplicatas do cliente |
| salOut | String | (Obrigatório) - Number(15,2) - Saldo devedor de outros títulos do cliente |
| salCre | String | (Obrigatório) - Number(15,2) - Saldo de créditos do cliente |
| 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 |
| datLim | String | (Obrigatório) - Date (DD/MM/AAAA) - Data da última atualização do limite de crédito |
| vlrLim | String | (Obrigatório) - Number(15,2) - Valor do limite de crédito do cliente |
| creDis | String | (Obrigatório) - Number(15,2) - Valor do crédito disponível para o cliente no momento da consulta |
| limApr | String | (Opcional) - String(001) - Indica se o limite de crédito está aprovado - Lista: S = Sim, N = Não |
| creBlo | String | (Obrigatório) - String(001) - Indica se o crédito disponível para o cliente está bloqueado - Lista: S=Sim, N=Não |
| motBlo | String | (Obrigatório) - String(250) - Descreve por extenso se o crédito do cliente está liberado ou se está bloqueado e expõe o motivo |
Integrações - Varejo - Cadastros - Consultar Crédito Cliente
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:ConsultarCredito>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codCli>Integer</codCli>
<indRet>Integer</indRet>
<finalizadora>
<codFpg>Integer</codFpg>
<vlrFpg>Double</vlrFpg>
</finalizadora>
</parameters>
</ser:ConsultarCredito>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - CodEmp - Number(004) - Código da Empresa |
| codFil | Integer | (Obrigatório) - CodFil - Number(005) - Código da Filial |
| codCli | Integer | (Obrigatório) - CodCli - Number(009) - Código do Cliente. |
| indRet | Integer | (Obrigatório) - IndRet - Number(001) - Indicação de retorno do Web Service. 1 = Compra Aprovada, 2 = Limite Credito ou 3 = Ambos. |
| finalizadora | Set | |
| finalizadora.codFpg | Integer | (Obrigatório) - CodFpg - Number(002) - Código da forma de pagamento. |
| finalizadora.vlrFpg | Double | (Obrigatório) - VlrFpg - Number(015,2) - Valor da forma de pagamento. |
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:ConsultarCreditoResponse>
<result>
<creditoCliente>
<vlrLim>Double</vlrLim>
<venApr>String</venApr>
</creditoCliente>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarCreditoResponse>
</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" |
| creditoCliente | Set | |
| creditoCliente.vlrLim | Double | (Obrigatório) - VlrLim - Number(015,2) - Valor de limite de crédito do cliente. |
| creditoCliente.venApr | String | (Obrigatório) - VenApr - String(001) - Indicativo de compra aprovada. (S/N). |
| 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 |
Consulta do histórico financeiro do cliente. Dados retornados:
- Dados do histórico (financeiro e comercial) do cliente
- Notas/cupons do cliente, descrevendo os itens da venda (mostrar como mestre detalhe).
- Vinculado a cada nota/cupom, os títulos a receber com valores em aberto do cliente correspondente a nota/cupom.
- Todos os títulos a pagar com valores em aberto do cliente (será procurado o cliente como fornecedor).
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 2
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:ConsultarHistoricoFinanceiro>
<user><String</user>
<password><String</password>
<encryption><Integer</encryption>
<parameters>
<CodEmp>Integer</CodEmp>
<CodFil>Integer</CodFil>
<IdentificadorSistema><String</IdentificadorSistema>
<CodCli><Integer</CodCli>
<RecategorizarCliente><String</RecategorizarCliente>
</parameters>
</ser:ConsultarHistoricoFinanceiro>
<soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| CodFil | Integer | (Opcional) - Number(005) - Código da Filial. (Obrigatório) se o sistema estiver configurado para categorizar o cliente na filial (parâmetro 'AnaCreFil' = 'S')| |
| IdentificadorSistema | String | (Obrigatório) - String(015) - Identificação do sistema integrado |
| CodCli | Integer | (Obrigatório) - Number(009) - Código do Cliente |
| RecategorizarCliente | String | (Opcional) - String(001) - Indica se o sistema deve atualizar a categoria do cliente antes de realizar a consulta. Lista: S- Sim; N- Nã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:ConsultarHistoricoFinanceiroResponse>
<result>
<Notas>
<CodEmp>Integer</CodEmp>
<CodFil>Integer</CodFil>
<CodSnf>String</CodSnf>
<NumNfv>Integer</NumNfv>
<TitulosReceber>
<CodCli>Integer</CodCli>
<NumNfv>Integer</NumNfv>
<CodEmp>Integer</CodEmp>
<CodFil>Integer</CodFil>
<CodTpt>String</CodTpt>
<NumTit>String</NumTit>
<VctOri>DateTime</VctOri>
<VlrAbe>Double</VlrAbe>
<VlrAtu>Double</VlrAtu>
<VlrDes>Double</VlrDes>
<VlrEnc>Double</VlrEnc>
<VlrJrs>Double</VlrJrs>
<VlrMul>Double</VlrMul>
<VlrOri>Double</VlrOri>
<DatEmi>DateTime</DatEmi>
<DatEnt>DateTime</DatEnt>
<VlrPgo>Double</VlrPgo>
</TitulosReceber>
<ItensNota>
<SeqIpv>Integer</SeqIpv>
<CodPro>String</CodPro>
<CodDer>String</CodDer>
<CodDep>String</CodDep>
<QtdFat>Double</QtdFat>
<QtdDev>Double</QtdDev>
<UniMed>String</UniMed>
<VlrEnc>Double</VlrEnc>
<VlrBru>Double</VlrBru>
<VlrDsc>Double</VlrDsc>
<PreUni>Double</PreUni>
<VlrLiq>String</VlrLiq>
<VlrFin>Double</VlrFin>
<CodRep>Integer</CodRep>
<IteFis>String</IteFis>
<DesFis>String</DesFis>
<ForEnt>String</ForEnt>
</ItensNota>
</Notas>
<TitulosPagar>
<CodFor>Integer</CodFor>
<CodEmp>Integer</CodEmp>
<CodFil>Integer</CodFil>
<CodTpt>String</CodTpt>
<NumTit>String</NumTit>
<VctOri>DateTime</VctOri>
<VlrAbe>Double</VlrAbe>
<VlrAtu>Double</VlrAtu>
<VlrDes>Double</VlrDes>
<VlrEnc>Double</VlrEnc>
<VlrJrs>Double</VlrJrs>
<VlrMul>Double</VlrMul>
<VlrOri>Double</VlrOri>
<DatEmi>DateTime</DatEmi>
<DatEnt>DateTime</DatEnt>
</TitulosPagar>
<TitulosReceberQuitado>
<CodCli>Integer</CodCli>
<CodFil>Integer</CodFil>
<CodTpt>String</CodTpt>
<NumTit>String</NumTit>
<VctOri>DateTime</VctOri>
<VlrAbe>Double</VlrAbe>
<VlrDsc>Double</VlrDsc>
<VlrJrs>Double</VlrJrs>
<VlrMul>Double</VlrMul>
<VlrMov>Double</VlrMov>
<DatEmi>DateTime</DatEmi>
<DatMov>DateTime</DatMov>
<DatPgt>DateTime</DatPgt>
<VlrOri>Double</VlrOri>
<VlrLiq>Double</VlrLiq>
<VlrEnc>Double</VlrEnc>
<VlrOac>Double</VlrOac>
<SeqMov>Integer</SeqMov>
<DiaAtr>Integer</DiaAtr>
<SitTit>String</SitTit>
</TitulosReceberQuitado>
<Erro>
<MsgErr>String</MsgErr>
</Erro>
<HistoricoCliente>
<CodEmp>Integer</CodEmp>
<CodCca>String</CodCca>
<DatUpg>DateTime</DatUpg>
<VlrUpg>Double</VlrUpg>
<DatUpc>DateTime</DatUpc>
<VlrUpc>Double</VlrUpc>
<DatAtr>DateTime</DatAtr>
<VlrAtr>Double</VlrAtr>
<MedAtr>Integer</MedAtr>
<QtdChs>Integer</QtdChs>
<QtdPrt>Integer</QtdPrt>
<VlrPrt>Double</VlrPrt>
<DatLim>DateTime</DatLim>
<VlrLim>Double</VlrLim>
<LimApr>String</LimApr>
<PedAbe>Double</PedAbe>
<PreAbe>Double</PreAbe>
<VlrUfa>Double</VlrUfa>
<PriCpr>DateTime</PriCpr>
<UltCpr>DateTime</UltCpr>
<NroCpr>Integer</NroCpr>
<MaiCpr>Double</MaiCpr>
<MaiPpg>Double</MaiPpg>
<CapMen>Double</CapMen>
<NroMed>Integer</NroMed>
</HistoricoCliente>
<TipoRetorno>Integer</TipoRetorno>
<MensagemRetorno>String</MensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarHistoricoFinanceiroResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Ajuda |
|---|---|---|
| Notas | Set | (Opcional) - Lista de notas fiscais relacionadas ao cliente. |
| Notas.CodEmp | Integer | (Obrigatório) - Number(004) - Código da empresa. |
| Notas.CodFil | Integer | (Obrigatório) - Number(005) - Código da filial. |
| Notas.CodSnf | String | (Obrigatório) - String(003) - Código da série da nota fiscal. |
| Notas.NumNfv | Integer | (Obrigatório) - Number(009) - Número da nota fiscal. |
| TitulosReceber | Set | (Opcional) - Lista de títulos a receber relacionados a nota fiscal. |
| TitulosReceber.CodCli | Integer | (Obrigatório) - Number(009) - Código do Cliente. |
| TitulosReceber.NumNfv | Integer | (Obrigatório) - Number(009) - Numero da nota fiscal. |
| TitulosReceber.CodEmp | Integer | (Obrigatório) - Number(004) - Código da empresa do título. |
| TitulosReceber.CodFil | Integer | (Obrigatório) - Number(005) - Código da filial do título. |
| TitulosReceber.CodTpt | String | (Obrigatório) - String(003) - Código de tipo de título. |
| TitulosReceber.NumTit | String | (Obrigatório) - String(015) - Número do título. |
| TitulosReceber.VctOri | DateTime | (Obrigatório) - Date(DD/MM/YYYY) - Data do vencimento original do título. |
| TitulosReceber.VlrAbe | Double | (Obrigatório) - Number(013,2) - Valor em aberto do título. |
| TitulosReceber.VlrAtu | Double | (Obrigatório) - Number(013,2) - Valor atual líquido do título. |
| TitulosReceber.VlrDes | Double | (Opcional) - Number(013,2) - Valor de descontos do título. |
| TitulosReceber.VlrEnc | Double | (Opcional) - Number(013,2) - Valor de encargos do título. |
| TitulosReceber.VlrJrs | Double | (Opcional) - Number(013,2) - Valor de juros do título. |
| TitulosReceber.VlrMul | Double | (Opcional) - Number(013,2) - Valor de multa do título. |
| TitulosReceber.VlrOri | Double | (Obrigatório) - Number(013,2) - Valor original do título. |
| TitulosReceber.DatEmi | DateTime | (Obrigatório) - Date(DD/MM/YYYY) - Data de emissão do título. |
| TitulosReceber.DatEnt | DateTime | (Obrigatório) - Date(DD/MM/YYYY) - Data de entrada do título. |
| TitulosReceber.VlrPgo | Double | (Opcional) - Number(013,2) - Valor total pago para o título pelo cliente. |
| ItensNota | Set | (Obrigatório) - Lista de itens da nota fiscal. |
| ItensNota.SeqIpv | Integer | (Obrigatório) - Number(003) - Sequência do item da nota fiscal. |
| ItensNota.CodPro | String | (Opcional) - String(014) - Código da produto. |
| ItensNota.CodDer | String | (Opcional) - String(007) - Código da derivação. |
| ItensNota.CodDep | String | (Opcional) - String(010) - Código do depósito. |
| ItensNota.QtdFat | Double | (Obrigatório) - Number(009,5) - Quantidade faturada. |
| ItensNota.QtdDev | Double | (Opcional) - Number(009,5) - Quantidade devolvida. |
| ItensNota.UniMed | String | (Obrigatório) - String(003) - Unidade de medida. |
| ItensNota.VlrEnc | Double | (Opcional) - Number(013,2) - Valor encargos financeiros. |
| ItensNota.VlrBru | Double | (Opcional) - Number(013,2) - Valor bruto do item. |
| ItensNota.VlrDsc | Double | (Opcional) - Number(013,2) - Valor de desconto do item. |
| ItensNota.PreUni | Double | (Obrigatório) - Number(009,2) - Preço unitário do produto |
| ItensNota.VlrLiq | String | (Obrigatório) - Number(013,2) - Valor líquido do item. |
| ItensNota.VlrFin | Double | (Obrigatório) - Number(013,2) - Valor do item válido para o financeiro. |
| ItensNota.CodRep | Integer | (Opcional) - Number(009) - Código do representante. |
| ItensNota.IteFis | String | (Opcional) - String(060) - Código fiscal do item. |
| ItensNota.DesFis | String | (Opcional) - String(255) - Descrição fiscal do item. |
| ItensNota.ForEnt | String | (Opcional) - Forma de entrega da nota, valores possíveis: (I - Imediata, L - Entrega futura loja, C - Entrega futura CD) |
| TitulosPagar | Set | (Opcional) - Lista de títulos a pagar ao cliente. |
| TitulosPagar.CodFor | Integer | (Obrigatório) - Number(009) - Código do fornecedor do título. |
| TitulosPagar.CodEmp | Integer | (Obrigatório) - Number(004) - Código da empresa do título. |
| TitulosPagar.CodFil | Integer | (Obrigatório) - Number(005) - Código da filial do título. |
| TitulosPagar.CodTpt | String | (Obrigatório) - String(003) - Código de tipo de título. |
| TitulosPagar.NumTit | String | (Obrigatório) - String(015) - Número do título. |
| TitulosPagar.VctOri | DateTime | (Obrigatório) - Date(DD/MM/YYYY) - Data do vencimento original do título. |
| TitulosPagar.VlrAbe | Double | (Obrigatório) - Number(013,2) - Valor em aberto do título. |
| TitulosPagar.VlrAtu | Double | (Obrigatório) - Number(013,2) - Valor atual líquido do título. |
| TitulosPagar.VlrDes | Double | (Opcional) - Number(013,2) - Valor de descontos do título. |
| TitulosPagar.VlrEnc | Double | (Opcional) - Number(013,2) - Valor de encargos do título. |
| TitulosPagar.VlrJrs | Double | (Opcional) - Number(013,2) - Valor de juros do título. |
| TitulosPagar.VlrMul | Double | (Opcional) - Number(013,2) - Valor de multa do título. |
| TitulosPagar.VlrOri | Double | (Obrigatório) - Number(013,2) - Valor original do título. |
| TitulosPagar.DatEmi | DateTime | (Obrigatório) - Date(DD/MM/YYYY) - Data de emissão do título. |
| TitulosPagar.DatEnt | DateTime | (Obrigatório) - Date(DD/MM/YYYY) - Data de entrada do título. |
| TitulosReceberQuitado | Set | Mostra os títulos a receber já quitados |
| TitulosReceberQuitado.CodCli | Integer | Código do cliente |
| TitulosReceberQuitado.CodFil | Integer | Código da filial |
| TitulosReceberQuitado.CodTpt | String | Código do tipo do título |
| TitulosReceberQuitado.NumTit | String | Número do título |
| TitulosReceberQuitado.VctOri | DateTime | Vencimento original do título |
| TitulosReceberQuitado.VlrAbe | Double | Valor em aberto do título |
| TitulosReceberQuitado.VlrDsc | Double | Valor do desconto do título |
| TitulosReceberQuitado.VlrJrs | Double | Valor dos juros do título |
| TitulosReceberQuitado.VlrMul | Double | Valor da multa do título |
| TitulosReceberQuitado.VlrMov | Double | Valor do movimento do título |
| TitulosReceberQuitado.DatEmi | DateTime | Data de emissão |
| TitulosReceberQuitado.DatMov | DateTime | Data da movimentação |
| TitulosReceberQuitado.DatPgt | DateTime | Data pagamento |
| TitulosReceberQuitado.VlrOri | Double | Valor original do título |
| TitulosReceberQuitado.VlrLiq | Double | Valor líquido do título |
| TitulosReceberQuitado.VlrEnc | Double | Valor dos encargos do título |
| TitulosReceberQuitado.VlrOac | Double | Valor de outros acréscimos do título |
| TitulosReceberQuitado.SeqMov | Integer | Sequência de movimento do título |
| TitulosReceberQuitado.DiaAtr | Integer | Dias de atraso no pagamento do título |
| TitulosReceberQuitado.SitTit | String | Situação do título |
| Erro | Set | (Opcional) - Lista de erros encontrados ao processar a consulta. |
| Erro.MsgErr | String | (Obrigatório) - String - Mensagem de erros encontrados no processamento. |
| HistoricoCliente | Set | (Obrigatório) - Dados de histórico do cliente. |
| HistoricoCliente.CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| HistoricoCliente.CodCca | String | (Obrigatório) - String(003) - Código da categora do cliente para análise de crédito. |
| HistoricoCliente.DatUpg | DateTime | (Opcional) - Date(DD/MM/YYYY) - Data do último pagamento do cliente. |
| HistoricoCliente.VlrUpg | Double | (Opcional) - Number(013,2) - Valor do último pagamento do cliente. |
| HistoricoCliente.DatUpc | DateTime | (Opcional) - Date(DD/MM/YYYY) - Data do último pagamento em cartório do cliente. |
| HistoricoCliente.VlrUpc | Double | (Opcional) - Number(013,2) - Valor do último pagamento em cartório do cliente. |
| HistoricoCliente.DatAtr | DateTime | (Opcional) - Date(DD/MM/YYYY) - Data de ocorrrência do maior atraso do cliente. |
| HistoricoCliente.VlrAtr | Double | (Opcional) - Number(013,2) - Valor de pagamento do maior atraso do cliente. |
| HistoricoCliente.MedAtr | Integer | (Opcional) - Number(004) - Quantidade média de dias de atraso do cliente. |
| HistoricoCliente.QtdChs | Integer | (Opcional) - Number(004) - Quantidade de cheques sem fundo do cliente. |
| HistoricoCliente.QtdPrt | Integer | (Opcional) - Number(004) - Quantidade de protestos do cliente. |
| HistoricoCliente.VlrPrt | Double | (Opcional) - Number(013,2) - Valor total de protestos do cliente. |
| HistoricoCliente.DatLim | DateTime | (Opcional) - Date(DD/MM/YYYY) - Data da última atualização de limite de crédito do cliente. |
| HistoricoCliente.VlrLim | Double | (Opcional) - Number(013,2) - Valor do limite de crédito do cliente. |
| HistoricoCliente.LimApr | String | (Opcional) - String(001) - Indicativo se o limite de crédito do cliente está aprovado. Lista: S - Sim; N- Não. |
| HistoricoCliente.PedAbe | Double | Valor total dos pedidos em aberto do cliente |
| HistoricoCliente.PreAbe | Double | Valor total das pré-faturas em aberto do cliente |
| HistoricoCliente.VlrUfa | Double | Valor do último faturamento do cliente |
| HistoricoCliente.PriCpr | DateTime | Primeira compra do cliente |
| HistoricoCliente.UltCpr | DateTime | Última compra do cliente |
| HistoricoCliente.NroCpr | Integer | Número de compras do cliente |
| HistoricoCliente.MaiCpr | Double | Maior compra do cliente |
| HistoricoCliente.MaiPpg | Double | Maior pagamento feito pelo cliente |
| HistoricoCliente.CapMen | Double | Maior capacidade de pagamento do cliente |
| HistoricoCliente.NroMed | Integer | Número médio de parcelas |
| TipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado; 2 = Erro na Solicitação. |
| MensagemRetorno | String | (Obrigatório) - String - Mensagem de Retorno de Processamento. |
| erroExecucao | String | Mensagem de erro genérico de execução. |
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:ImportarConsultaSPC>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<identificacaoSistema>String</identificacaoSistema>
<ConsultaSPC>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<seqCon>Integer</seqCon>
<codCli>Integer</codCli>
<datCon>DateTime</datCon>
<ideCae>Integer</ideCae>
<infSpc>Integer</infSpc>
<usuCon>Integer</usuCon>
<reqCon>String</reqCon>
<retCon>String</retCon>
<ideExt>Integer</ideExt>
</ConsultaSPC>
</parameters>
</ser:ImportarConsultaSPC>
</soapenv:Body>
</soapenv:Envelope>
|
Nome |
Preenchimento |
Tipo |
Descrição |
|---|---|---|---|
| identificacaoSistema | Opcional | String | |
| consultaSPC | Opcional | Set | Dados gerais da Consulta SPC |
| consultaSPC.codEmp | Opcional | Integer | (Obrigatório) - Código da empresa responsável pela requisição |
| consultaSPC.codFil | Opcional | Integer | (Obrigatório) - Código da filial responsável pela requisição |
| consultaSPC.seqCon | Opcional | Integer | |
| consultaSPC.codCli | Opcional | Integer | (Obrigatório) - Código do cliente da consulta SPC |
| consultaSPC.datCon | Opcional | DateTime | (Obrigatório) - Data da consulta SPC |
| consultaSPC.ideCae | Opcional | Integer | (Obrigatório) - Identificador unico do autenticador da consulta |
| consultaSPC.infSpc | Opcional | Integer | (Obrigatório) - Situação junto ao SPC |
| consultaSPC.usuCon | Opcional | Integer | (Obrigatório) - Usuário responsável pela consulta SPC |
| consultaSPC.reqCon | Opcional | String | (Obrigatório) - Requisição da consulta SPC |
| consultaSPC.retCon | Opcional | String | (Obrigatório) - Retorno da consulta SPC |
| consultaSPC.ideExt | Opcional | Integer |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:ImportarConsultaSPCResponse>
<result>
<Retorno>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codCli>Integer</codCli>
<ideCae>Integer</ideCae>
<datCon>DateTime</datCon>
<usuCon>Integer</usuCon>
<tipRet>Integer</tipRet>
<msgRet>String</msgRet>
<ideExt>Integer</ideExt>
</Retorno>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ImportarConsultaSPCResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Preenchimento | Tipo | Descrição |
|---|---|---|---|
| retorno | Opcional | Set | Lista de Retorno |
| retorno.codEmp | Opcional | Integer | (Obrigatório) - Código da empresa responsável pela requisição |
| retorno.codFil | Opcional | Integer | (Obrigatório) - Código da filial responsável pela requisição |
| retorno.codCli | Opcional | Integer | (Obrigatório) - Código do cliente da consulta SPC |
| retorno.ideCae | Opcional | Integer | (Obrigatório) - Identificador único do autenticador da consulta |
| retorno.datCon | Opcional | DateTime | (Obrigatório) - Data da consulta SPC |
| retorno.usuCon | Opcional | Integer | (Obrigatório) - Usuário responsável pela consulta SPC |
| retorno.tipRet | Opcional | Integer | (Obrigatório) - Tipo de Retorno (1 = Sucesso, 2 = Erros) |
| retorno.msgRet | Opcional | String | (Obrigatório) - Mensagem do Retorno |
| retorno.ideExt | Opcional | Integer | |
| tipoRetorno | Opcional | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | Opcional | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| erroExecucao | Opcional | 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 sucesso; - A mensagem do erro ocorrido no servidor |
English
Español
English
Español


