English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.mct.imp.reinf.detalhamentoretencoes
Web service Com.senior.g5.co.mct.imp.reinf.detalhamentoretencoes
Este web service permite inserir e alterar os lançamentos.
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://servidor:1234/g5-senior-services/sapiens_Synccom_senior_g5_co_mct_imp_reinf_detalhamentoretencoes?wsdl`
- Assíncrono: `http://servidor:1234/g5-senior-services/sapiens_Asynccom_senior_g5_co_mct_imp_reinf_detalhamentoretencoes?wsdl`
- Agendado: `http://servidor:1234/g5-senior-services/sapiens_Schedulecom_senior_g5_co_mct_imp_reinf_detalhamentoretencoes?wsdl`
Porta
Importar
ImportarRequisição:Parâmetros da requisição:
Resposta:Atributos da resposta:
Necessita autenticação: Sim.
Situação da 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:Importar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<ContribuicaoPrevidenciariaReceitaBruta>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<datCpt>DateTime</datCpt>
<codPgt>Integer</codPgt>
<codFor>Integer</codFor>
<nifBen>String</nifBen>
<relPag>Integer</relPag>
<indNif>Integer</indNif>
<datLau>DateTime</datLau>
<pagamentoPessoaJuridica>
<codDfs>Integer</codDfs>
<codSus>Double</codSus>
<datPag>DateTime</datPag>
<indOri>Integer</indOri>
<vlrTri>Double</vlrTri>
<vlrRet>Double</vlrRet>
<cnpOri>String</cnpOri>
<vlrCuj>Double</vlrCuj>
<advogadosPJU>
<codFor>Integer</codFor>
<vlrDes>Double</vlrDes>
</advogadosPJU>
</pagamentoPessoaJuridica>
<pagamentoPessoaFisica>
<datPag>DateTime</datPag>
<indSus>String</indSus>
<indDec>String</indDec>
<vlrRtr>Double</vlrRtr>
<vlIRRF>Double</vlIRRF>
<vlrDep>Double</vlrDep>
<vlrAno>Double</vlrAno>
<vlrAnt>Double</vlrAnt>
<rendimentosRecebidosAcumuladamente>
<codDfs>Integer</codDfs>
<codSus>Double</codSus>
<natRra>String</natRra>
<qtdMes>Integer</qtdMes>
<vlrCus>Double</vlrCus>
<advogadosRRA>
<codFor>Integer</codFor>
<vlrDes>Double</vlrDes>
</advogadosRRA>
</rendimentosRecebidosAcumuladamente>
<demaisRendimentosDecisaoJudicial>
<codDfs>Integer</codDfs>
<codSus>Double</codSus>
<indOri>Integer</indOri>
<cnpOri>String</cnpOri>
<vlrCus>Double</vlrCus>
<advogadosIPR>
<codFor>Integer</codFor>
<vlrDes>Double</vlrDes>
</advogadosIPR>
</demaisRendimentosDecisaoJudicial>
<rendimentosIsentosNaoTributaveis>
<tipIse>Integer</tipIse>
<vlrIse>Double</vlrIse>
<desRen>String</desRen>
</rendimentosIsentosNaoTributaveis>
<detalhamentoDeducoes>
<tipDed>Integer</tipDed>
<vlrDed>Double</vlrDed>
</detalhamentoDeducoes>
<detalhamentoCompetencias>
<indPer>Integer</indPer>
<vlrTri>Double</vlrTri>
<perRef>DateTime</perRef>
</detalhamentoCompetencias>
</pagamentoPessoaFisica>
<pagamentoResidenteExterior>
<datPag>DateTime</datPag>
<tipRen>Integer</tipRen>
<forTri>Integer</forTri>
<vlrDed>Double</vlrDed>
<vliRrf>Double</vliRrf>
</pagamentoResidenteExterior>
</ContribuicaoPrevidenciariaReceitaBruta>
</parameters>
</ser:Importar>
</soapenv:Body>
</soapenv:Envelope> Parâmetros da requisição:| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| contribuicaoPrevidenciariaReceitaBruta | Set | Opcional | Contribuição Previdenciária sobre a Receita Bruta |
| contribuicaoPrevidenciariaReceitaBruta.codEmp | Integer | Opcional | Number(004) - Código da empresa |
| contribuicaoPrevidenciariaReceitaBruta.codFil | Integer | Opcional | Number(005) - Código da filial |
| contribuicaoPrevidenciariaReceitaBruta.datCpt | DateTime | Opcional | Date(MM/YYYY) - Data de Competência |
| contribuicaoPrevidenciariaReceitaBruta.codPgt | Integer | Opcional | Number(004) - Código do Pagamento |
| contribuicaoPrevidenciariaReceitaBruta.codFor | Integer | Opcional | Number(009) - Código do Fornecedor |
| contribuicaoPrevidenciariaReceitaBruta.nifBen | String | Opcional | String(020) - Número de Identificação Fiscal - NIF |
| contribuicaoPrevidenciariaReceitaBruta.relPag | Integer | Opcional | Number(003) - Relação fonte pagadora pessoa jurídica e beneficiário pessoa jurídica - [ 500=A fonte pagadora é matriz da beneficiária no exterior;510=A fonte pagadora é filial, sucursal ou agência de beneficiária no exterior;520=A fonte pagadora é controlada ou coligada da beneficiária no exterior, na forma dos §§ 1º e 2º do art. 243 da Lei nº 6.404, de 15 de dezembro de 1976;530=A fonte pagadora é controladora ou coligada da beneficiária no exterior, na forma dos §§ 1º e 2º do art. 243 da Lei nº 6.404, de 1976;540=A fonte pagadora e a beneficiária no exterior estão sob controle societário ou administrativo comum ou quando pelo menos 10% do capital de cada uma, pertencer a uma mesma pessoa física ou jurídica;550=A fonte pagadora e a beneficiária no exterior têm participação societária no capital de uma terceira pessoa jurídica, cuja soma as caracterize como controladoras ou coligadas na forma dos §§ 1º e 2º do art. 243 da Lei nº 6.404, de 1976;560=A fonte pagadora ou a beneficiária no exterior mantenha contrato de exclusividade como agente, como distribuidor ou como concessionário nas operações com bens, serviços e direitos;570=A fonte pagadora e a beneficiária mantêm acordo de atuação conjunta;900=Não há relação entre a fonte pagadora e a beneficiária no exterior ] |
| contribuicaoPrevidenciariaReceitaBruta.indNif | Integer | Opcional | Number(001) - Indicativo do Número de Identificação Fiscal - [ 1=Beneficiário com NIF;2=Beneficiário dispensado do NIF;3=País não exige NIF ] |
| contribuicaoPrevidenciariaReceitaBruta.datLau | DateTime | Opcional | Date(DD/MM/YYYY) - Data atribuída pelo laudo da moléstia grave |
| pagamentoPessoaJuridica | Set | Opcional | Pagamentos Pessoas Jurídicas |
| pagamentoPessoaJuridica.codDfs | Integer | Opcional | Number(006) - Código do dispositivo fiscal |
| pagamentoPessoaJuridica.codSus | Double | Opcional | Number(014) - Codigo da Suspensão |
| pagamentoPessoaJuridica.datPag | DateTime | Opcional | Date(DD/MM/YYYY) - Data do Pagamento |
| pagamentoPessoaJuridica.indOri | Integer | Opcional | Number(001) - Indicativo da origem dos recursos - [ 1=Recursos do próprio declarante;2=Recursos de terceiros (Instituição Financeira respon. pelo repasse dos valores) ] |
| pagamentoPessoaJuridica.vlrTri | Double | Opcional | Number(015,2) - Valor do Rendimento tributável |
| pagamentoPessoaJuridica.vlrRet | Double | Opcional | Number(015,2) - Valor da retenção na Fonte |
| pagamentoPessoaJuridica.cnpOri | String | Opcional | String(014) - CNPJ da empresa de origem dos recursos |
| pagamentoPessoaJuridica.vlrCuj | Double | Opcional | Number(015,2) - Valor da despesa com custas judiciais |
| advogadosPJU | Set | Opcional | Advogados Pagamentos Pessoas Jurídicas |
| advogadosPJU.codFor | Integer | Opcional | Number(009) - Código do Fornecedor |
| advogadosPJU.vlrDes | Double | Opcional | Number(015,2) - Valor da despesa com Advogado |
| pagamentoPessoaFisica | Set | Opcional | Pagamentos Pessoas Físicas |
| pagamentoPessoaFisica.datPag | DateTime | Opcional | Date(DD/MM/YYYY) - Data do Pagamento |
| pagamentoPessoaFisica.indSus | String | Opcional | String(001) - Indicativo de Exigibilidade Suspensa - [ S=Sim;N=Não ] |
| pagamentoPessoaFisica.indDec | String | Opcional | String(001) - Indicativo 13º Salário - [ S=Sim;N=Não ] |
| pagamentoPessoaFisica.vlrRtr | Double | Opcional | Number(015,2) - Valor do Rendimento Tributável |
| pagamentoPessoaFisica.vlIRRF | Double | Opcional | Number(015,2) - Vlr. Imposto Retido na Fonte |
| pagamentoPessoaFisica.vlrDep | Double | Opcional | Number(015,2) - Vlr. Depósito Judicial |
| pagamentoPessoaFisica.vlrAno | Double | Opcional | Number(015,2) - Compensação Judicial do ano calendário |
| pagamentoPessoaFisica.vlrAnt | Double | Opcional | Number(015,2) - Compensação Judicial dos anos anteriores. |
| rendimentosRecebidosAcumuladamente | Set | Opcional | Rendimentos Recebidos Acumuladamente |
| rendimentosRecebidosAcumuladamente.codDfs | Integer | Opcional | Number(006) - Código do dispositivo fiscal |
| rendimentosRecebidosAcumuladamente.codSus | Double | Opcional | Number(014) - Codigo da Suspensão |
| rendimentosRecebidosAcumuladamente.natRra | String | Opcional | String(050) - Natureza do Rendimento |
| rendimentosRecebidosAcumuladamente.qtdMes | Integer | Opcional | Number(005) - Quantidade de meses |
| rendimentosRecebidosAcumuladamente.vlrCus | Double | Opcional | Number(015,2) - Valor da despesa com custas judiciais |
| advogadosRRA | Set | Opcional | Advogados Rendimentos Recebidos Acumuladamente |
| advogadosRRA.codFor | Integer | Opcional | Number(009) - Código do Fornecedor |
| advogadosRRA.vlrDes | Double | Opcional | Number(015,2) - Valor da despesa com Advogado |
| demaisRendimentosDecisaoJudicial | Set | Opcional | Demais Rendimentos Decorrentes de Decisão Judicial |
| demaisRendimentosDecisaoJudicial.codDfs | Integer | Opcional | Number(006) - Código do dispositivo fiscal |
| demaisRendimentosDecisaoJudicial.codSus | Double | Opcional | Number(014) - Codigo da Suspensão |
| demaisRendimentosDecisaoJudicial.indOri | Integer | Opcional | Number(001) - Indicativo da origem dos recursos - [ 1=Recursos do próprio declarante;2=Recursos de terceiros (Instituição Financeira respon. pelo repasse dos valores) ] |
| demaisRendimentosDecisaoJudicial.cnpOri | String | Opcional | String(014) - CNPJ da empresa de origem dos recursos |
| demaisRendimentosDecisaoJudicial.vlrCus | Double | Opcional | Number(015,2) - Valor da despesa com custas judiciais |
| advogadosIPR | Set | Opcional | Advogados Demais Rendimentos Decorrentes de Decisão Judicial |
| advogadosIPR.codFor | Integer | Opcional | Number(009) - Código do Fornecedor |
| advogadosIPR.vlrDes | Double | Opcional | Number(015,2) - Valor da despesa com Advogado |
| rendimentosIsentosNaoTributaveis | Set | Opcional | Rendimentos Isentos Não Tributáveis |
| rendimentosIsentosNaoTributaveis.tipIse | Integer | Opcional | Number(002) - Tipo de Isenção - [ 01=Parcela Isenta 65 anos;02=Diária e Ajuda de Custo;03=Indenização e rescisão de contrato, inclusive a título de PDV;04=Abono pecuniário;05=Outros (especificar);06=Lucros e dividendos pagos a partir de 1996;07=Valores pagos à titular ou sócio de microempresa ou empresa de pequeno porte, exceto pró-labore e alugueis;08=Pensão, aposentadoria ou reforma por moléstia grave ou acidente em serviço;09=Benefícios indiretos e/ou reembolso de despesas recebidas por voluntário da copa do mundo ou da copa das confederações;10=Bolsa de estudo recebida por médico-residente;11=Complementação de aposentadoria, correspondente às contribuições efetuadas no período de 01/01/1989 a 31/12/1995 ] |
| rendimentosIsentosNaoTributaveis.vlrIse | Double | Opcional | Number(015,2) - Valor da Parcela Isenta |
| rendimentosIsentosNaoTributaveis.desRen | String | Opcional | String(100) - Descrição do rendimento isento/Não tributável |
| detalhamentoDeducoes | Set | Opcional | Detalhamento Deduções |
| detalhamentoDeducoes.tipDed | Integer | Opcional | Number(001) - Tipo de Dedução - [ 1=Previdência Oficial;2=Previdência Privada;3=Fapi;4=Funpresp;5=Pensão Alimentícia;6=Dependentes ] |
| detalhamentoDeducoes.vlrDed | Double | Opcional | Number(015,2) - Valor da Dedução da Base de Cálculo |
| detalhamentoCompetencias | Set | Opcional | Detalhamentos das Competências |
| detalhamentoCompetencias.indPer | Integer | Opcional | Number(001) - Indicativo de período de referência - [ 1=Folha de pagamento mensal;2=Folha do décimo terceiro salário ] |
| detalhamentoCompetencias.vlrTri | Double | Opcional | Number(015,2) - Valor do Rendimento tributável |
| detalhamentoCompetencias.perRef | DateTime | Opcional | Date(DD/MM/YYYY) - Período de Pagamento |
| pagamentoResidenteExterior | Set | Opcional | Pagamentos a Residente ou Domiciliando no Exterior |
| pagamentoResidenteExterior.datPag | DateTime | Opcional | Date(DD/MM/YYYY) - Data de Pagamento |
| pagamentoResidenteExterior.tipRen | Integer | Opcional | Number(003) - Tipo de Rendimento - [ 100=Rendas de propriedade imobiliária;110=Rendas do transporte internacional;120=Lucros e dividendos distribuídos;130=Juros;140=Royalties;150=Ganhos de Capital;160=Rendas do trabalho sem vínculo empregatício;170=Renda do trabalho com vínculo empregatício;180=Remuneração de administradores;190=Rendas de artistas e de esportistas;200=Pensões;210=Pagamentos governamentais;220=Rendas de professores e pesquisadores;230=Rendas de estudantes e aprendizes;240=Rendimentos de empregados ou contratados - COPA;250=Prêmios de árbitros, jogadores de futebol e outros membros das delegações - COPA;300=Outras rendas ] |
| pagamentoResidenteExterior.forTri | Integer | Opcional | Number(002) - Forma de Tributação - [ 10=Retenção do IRRF - alíquota padrão;11=Retenção do IRRF - alíquota da tabela progressiva;12=Retenção do IRRF - alíquota diferenciada (países tributação favorecida);13=Retenção do IRRF - alíquota limitada conforme cláusula em convênio;30=Retenção do IRRF - outras hipóteses;40=Não retenção do IRRF - isenção estabelecida em convênio;41=Não retenção do IRRF - isenção prevista em lei interna;42=Não retenção do IRRF - alíquota Zero prevista em lei interna;43=Não retenção do IRRF - pagamento antecipado do imposto;44=Não retenção do IRRF - medida Judicial;50=Não retenção do IRRF - outras hipóteses ] |
| pagamentoResidenteExterior.vlrDed | Double | Opcional | Number(015,2) - Valor Pago. |
| pagamentoResidenteExterior.vliRrf | Double | Opcional | Number(015,2) - Valor do Imposto Retido na Fonte |
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:ImportarResponse>
<result>
<Retorno>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<datCpt>DateTime</datCpt>
<codFor>Integer</codFor>
<tipRet>Integer</tipRet>
<msgRet>String</msgRet>
</Retorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ImportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:| Nome | Tipo | Descrição |
|---|---|---|
| retorno | Set | Retorno |
| retorno.codEmp | Integer | Number(004) - Código da empresa |
| retorno.codFil | Integer | Number(005) - Código da filial |
| retorno.datCpt | DateTime | Date(DD/MM/YYYY) - Data de Competência |
| retorno.codFor | Integer | Number(009) - Código do Fornecedor |
| retorno.tipRet | Integer | Number(004) - Tipo de Retorno de Processamento: 1 = Processado com sucesso, 2 = Ocorreram erros |
| retorno.msgRet | String | String(1000) - Mensagem de Retorno de Processamento |
| 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" |
English
Español
