Web service Com.senior.g5.co.int.varejo.contafinanceira
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_contafinanceira?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_contafinanceira?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_contafinanceira?wsdl
Porta
Integrações - Varejo - Cadastros - Exportar Conta Financeira
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> <codEmp>Integer</codEmp> <consulta> <contaFinanceira>String</contaFinanceira> </consulta> <codFil>Integer</codFil> <tipoIntegracao>String</tipoIntegracao> <identificacaoSistema>String</identificacaoSistema> <quantidadeRegistros>Integer</quantidadeRegistros> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
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.contaFinanceira | String | (Opcional) - CtaFin - Number(007) - Número reduzido da conta financeira(Obrigatório quando Tipo de Integração for para Registro Específico) |
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 |
identificacaoSistema | String | (Obrigatório) - String(15) - Identificação do sistema integrado |
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. |
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> <contaFinanceira> <ctaFin>Integer</ctaFin> <desCta>String</desCta> <abrCta>String</abrCta> <defGru>String</defGru> <mskFin>String</mskFin> <claFin>String</claFin> <gruFin>Integer</gruFin> <nivFin>Integer</nivFin> <posFin>Integer</posFin> <anaSin>String</anaSin> <natFin>String</natFin> <forRat>Integer</forRat> <tipCfc>String</tipCfc> <seqCfc>Integer</seqCfc> <sitFin>String</sitFin> <seqInt>String</seqInt> </contaFinanceira> <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>
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" |
contaFinanceira | Set | (Obrigatório) - Utilizar para informar quais registros devem ser retornados. |
contaFinanceira.ctaFin | Integer | (Obrigatório) - CtaFin - Number(007) - Número reduzido da conta financeira |
contaFinanceira.desCta | String | (Obrigatório) - DesCta - String(080) - Nomenclatura da conta financeira |
contaFinanceira.abrCta | String | (Obrigatório) - AbrCta - String(020) - Abreviatura da conta financeira |
contaFinanceira.defGru | String | (Obrigatório) - DefGru - String(001) - Definição do grupo da conta financeira - Lista: A = Ativo (Contábil - Devedora), P = Passivo (Contábil - Credora), D = Despesas (Contábil - Devedora), R = Receitas (Contábil - Credora), X = Ambas (Contábil - Desp./Rec.), M = Receitas Financeiras, N = Despesas Financeiras, U = Conta Auxiliar, L = Patrimônio Líquido, V = Custo de Venda, C = Custo de Produção, S = Custo de Ordem Dedutora, E = Custo de Ordem Credora, O = Outros |
contaFinanceira.mskFin | String | (Obrigatório) - MskFin - String(040) - Máscara do grupo que a conta financeira pertence |
contaFinanceira.claFin | String | (Obrigatório) - ClaFin - String(030) - Classificação da conta financeira |
contaFinanceira.gruFin | Integer | (Obrigatório) - GruFin - Number(002) - Grupo que a conta financeira pertence |
contaFinanceira.nivFin | Integer | (Obrigatório) - NivFin - Number(002) - Nível da conta financeira |
contaFinanceira.posFin | Integer | (Obrigatório) - PosFin - Number(001) - Quantidade de posições do nível da conta financeira |
contaFinanceira.anaSin | String | (Obrigatório) - AnaSin - String(001) - Indicativo se a conta financeira é sintética ou analítica - Lista: A = Analítico(a), S = Sintético(a) |
contaFinanceira.natFin | String | (Obrigatório) - NatFin - String(001) - Indicativo se a natureza da conta financeira e credora ou devedora - Lista: D = Devedora, C = Credora |
contaFinanceira.forRat | Integer | (Opcional) - ForRat - Number(001) - Forma de rateio da conta financeira - Lista: 0 = Sem Rateio, 1 = Pré-definido c/ Confirmação, 2 = Pré-definido s/ Confirmação, 3 = Rateio Manual |
contaFinanceira.tipCfc | String | (Opcional) - TipCfc - String(001) - Tipo da conta financeira para efeito de fluxo de caixa - Lista: 1 = Receitas, 2 = Despesas, 3 = Outros |
contaFinanceira.seqCfc | Integer | (Opcional) - SeqCfc - Number(007) - Sequência da conta financeira para efeito de fluxo de caixa |
contaFinanceira.sitFin | String | (Obrigatório) - SitFin - String(001) - Situação da conta financeira - Lista: A = Ativo, I = Inativo |
contaFinanceira.seqInt | String | (Opcional) - SeqInt - (Opicional) - Number(001) - Número seqüencial do registro de exportação |
gridErros | Set | (Opcional) - Lista dos erro |
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 |