Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Administração de Pessoal > Com.senior.g5.rh.fp.anuais.dirf

Web service com.senior.g5.rh.fp.anuais.dirf

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 identificado o tipo no parâmetro <encryption>, conforme seus valores possíveis.

WSDL

Portas

Calcular

Web service de Informe de Rendimentos para DIRF.

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:Calcular>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <anoBas>Integer</anoBas>
        <abrIse>String</abrIse>
        <gruEmp>Integer</gruEmp>
        <codCal>Integer</codCal>
        <comIrf>String</comIrf>
        <abrTri>String</abrTri>
        <codLot>Integer</codLot>
        <parLuc>String</parLuc>
        <abrCpl>String</abrCpl>
        <abrEmp>String</abrEmp>
        <dep13S>String</dep13S>
        <abrTcl>String</abrTcl>
        <depLuc>String</depLuc>
        <abrCad>String</abrCad>
        <traFer>String</traFer>
        <abrFil>String</abrFil>
        <recFer>String</recFer>
        <abrLoc>String</abrLoc>
        <insFer>String</insFer>
        <abrCcu>String</abrCcu>
        <danCal>String</danCal>
        <abrVin>String</abrVin>
        <monPro>String</monPro>
        <abrOem>String</abrOem>
        <sobDig>String</sobDig>
        <abrCpf>String</abrCpf>
        <redIrf>Integer</redIrf>
        <tipOut>String</tipOut>
        <traIse>String</traIse>
        <cbCol>String</cbCol>
        <cbFis>String</cbFis>
        <cbJur>String</cbJur>
        <cbDep>String</cbDep>
      </parameters>
    </ser:Calcular>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Obrigatório Integer Código da empresa que será utilizada no processo.

- Máscara: 9999
anoBas Obrigatório Integer Ano base do qual deseja-se emitir o Informe de Rendimentos.

- Máscara: 9999
abrIse Opcional String Totalizador(es) que formarão os valores da linha 07 do campo 04 - Rendimentos Isentos e não Tributáveis.

- Máscara: A[200]
gruEmp Opcional Integer Abrangência: Código de grupo de empresas.

- Máscara: 999
codCal Obrigatório Integer Código de cálculo que será usado no processo.

- Máscara: 9999
comIrf Obrigatório String Contribuintes a calcular

- Máscara: U

Valores:
"I" - Somente com IRRF
"S" - Somente sem IRRF
"T" - Todos
abrTri Opcional String Totalizador(es) que formarão os valores da linha 02 do campo 05 - Rendimentos Sujeitos a Tributação Exclusiva (Rendimento Líquido).

- Máscara: A[100]
codLot Opcional Integer Abrangência: Código de lote de colaboradores.

- Máscara: 9999
parLuc Opcional String Tratar participação de lucros como tributação exclusiva na fonte.

- Máscara: U

Valores:
"S" - Sim
"N" - Não

Este parâmetro só deve ser informado se o parâmetro AnoBas for anterior a 2013.
abrCpl Opcional String Totalizador(es) que formarão os valores da linha 07 do campo 06 - Informações Complementares.

- Máscara: A[200]
abrEmp Opcional String Abrangência: Empresa (+).

- Máscara: A[200]
dep13S Obrigatório String Procedimento referente aos dependentes de 13º Salário.

- Máscara: U

Valores:
"I" - Deduz Quando Teve IR
"S" - Deduz Sempre
"N" - Nunca Deduz
"L" - Limite de Insenção
abrTcl Opcional String Abrangência: Tipo de Colaborador (+).

- Máscara: A[100]
depLuc Opcional String Procedimento referente aos dependentes de participação de lucros.

- Máscara: U

Valores:
"I" - Deduz Quando Teve IR
"S" - Deduz Sempre
"N" - Nunca Deduz
"L" - Limite de Insenção

Este parâmetro só deve ser informado se o parâmetro AnoBas for anterior a 2013.
abrCad Opcional String Abrangência: Colaborador (+).

- Máscara: A[200]
traFer Obrigatório String Tratamento especial para as férias:

- Máscara: U

Valores:
"S" - Sim - As férias que iniciaram em janeiro do ano base e que foram pagas em dezembro do ano base-1, serão consideradas no informe no mês de janeiro do ano base. Não serão consideradas as férias iniciadas em janeiro do ano base+1 e que foram pagas em dezembro do ano base.
"N" - Não - Os valores de férias serão levados para o Informe, conforme a data de pagamento do recibo de férias.
abrFil Opcional String Abrangência: Filial (+).

- Máscara: A[200]
recFer Obrigatório String Tratamento do recibo de férias no Informe.

- Máscara: U

Valores:
"R" - Somente Recibo de Férias - Serão considerados apenas os valores do Recibo de Férias. O sistema não fará nenhuma comparação com os valores de férias integrados na folha mensal.
"F" - Somente Ficha Financeira - Serão considerados apenas os valores encontrados na Ficha Financeira, pela data de pagamento da folha mensal. O sistema não fará nenhuma comparação com os valores de férias calculados no Recibo de Férias.
"P" - Cálculo Padrão - É feito o tratamento normal dos recibos de férias. Os valores sempre serão levados a partir da data de pagamento do recibo, porém, efetuando a proporcionalidade dos eventos e comparando com a ficha financeira. Se os valores forem diferentes, a Administração de Pessoal gerará uma diferença positiva ou negativa.
abrLoc Opcional String Abrangência: Local ("+").

- Máscara: A[200]
insFer Opcional String Como o sistema deve tratar os valores de INSS de férias.

- Máscara: U

Valores:
"N" - Cálculo Normal - O sistema considerará os valores de INSS de férias do recibo de férias. Ou seja o valor irá para o informe integral na data de pagamento do recibo.
"F" - Ficha Financeira - O sistema buscará o evento de INSS s/ férias da ficha financeira. Ou seja, o valor de INSS de férias não será considerado pela data de pagamento do recibo e sim, segundo a data de pagamento da folha mensal.

Este parâmetro só deve ser informado se o parâmetro RecFer for igual a "P".
abrCcu Opcional String Abrangência: Tipo de Contrato (+).

- Máscara: A[100]
danCal Obrigatório String Como o sistema deve tratar os valores de 13o complementar ou complementar a devolver que constam da folha de dezembro com data de pagamento em janeiro do ano seguinte.

- Máscara: U

Valores:
"A" - Janeiro Ano-Base - Considerar somente os valores existentes em janeiro do ano-base.
"B" - Janeiro Ano-Base e Ano-Base + 1 - Considerar os valores existentes em janeiro do ano-base e em janeiro do ano-base + 1.
"D" - Janeiro Ano-Base + 1 - Considerar somente os valores existentes em janeiro do ano-base + 1.
"N" - Não Considera.
abrVin Opcional String Abrangência: Vínculo (+).

- Máscara: A[100]
monPro Obrigatório String Processo do Informe deverá ou não ser monitorado.

- Máscara: U

Valores:
"S" - Sim
"N" - Não

É recomendado informar "N" para esta opção no processo assíncrono, pois senão pode haver perda de performance.
abrOem Opcional String Abrangência: Outra Empresa (+).

- Máscara: A[200]
sobDig Obrigatório String Valores digitados ou alterados nas tabelas do Informe/DIRF (campo OriRen <> de 'G') devem ser recalculados.

- Máscara: U

Valores:
"S" - Sim
"N" - Não
abrCpf Opcional String  
redIrf Opcional Integer Utilizar o redutor de IRRF

- Máscara: 9

Valores:
0 - Sempre Reduz
1 - Somente reduz quando base IR superior ao limite de isenção
2 - Nunca Reduz

Este parâmetro só deve ser informado se o parâmetro AnoBas for igual a 2004.
tipOut Obrigatório String Considerar Eventos Tipo Outros(4,5,6) na soma das bases.

- Máscara: U

Valores:
"S" - Sim
"N" - Não
traIse Obrigatório String Considerar valor Transportador Autônomo(Transportista) como Rendimento Isento.

- Máscara: U

Valores:
"S" - Sim
"N" - Não
cbCol Obrigatório String Gerar o informe Dirf para os colaboradores.

- Máscara: U

Valores
"S" - Sim
"N" - Não
cbFis Obrigatório String Gerar o informe Dirf para os terceiros.

- Máscara: U

Valores
"S" - Sim
"N" - Não
cbJur Obrigatório String Gerar o informe Dirf para outras empresas.

- Máscara: U

Valores
"S" - Sim
"N" - Não
cbDep Obrigatório String Gerar o informe Dirf para os dependentes

- Máscara: U

Valores
"S" - Sim
"N" - Nã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:CalcularResponse>
      <result>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:CalcularResponse>
  </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Preenchimento Tipo Descrição
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.

Escalonar

Web service de Informe de Rendimentos para DIRF Escalonado.

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:Escalonar>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <anoBas>Integer</anoBas>
        <abrIse>String</abrIse>
        <gruEmp>Integer</gruEmp>
        <codCal>Integer</codCal>
        <comIrf>String</comIrf>
        <abrTri>String</abrTri>
        <codLot>Integer</codLot>
        <parLuc>String</parLuc>
        <abrCpl>String</abrCpl>
        <abrEmp>String</abrEmp>
        <dep13S>String</dep13S>
        <abrTcl>String</abrTcl>
        <depLuc>String</depLuc>
        <abrCad>String</abrCad>
        <traFer>String</traFer>
        <abrFil>String</abrFil>
        <recFer>String</recFer>
        <abrLoc>String</abrLoc>
        <insFer>String</insFer>
        <abrCcu>String</abrCcu>
        <danCal>String</danCal>
        <abrVin>String</abrVin>
        <monPro>String</monPro>
        <abrOem>String</abrOem>
        <sobDig>String</sobDig>
        <abrCpf>String</abrCpf>
        <redIrf>Integer</redIrf>
        <tipOut>String</tipOut>
        <traIse>String</traIse>
        <cbCol>String</cbCol>
        <cbFis>String</cbFis>
        <cbJur>String</cbJur>
        <cbDep>String</cbDep>
      </parameters>
    </ser:Escalonar>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Obrigatório Integer Código da empresa que será utilizada no processo.

- Máscara: 9999
anoBas Obrigatório Integer Ano base do qual deseja-se emitir o Informe de Rendimentos.

- Máscara: 9999
abrIse Opcional String Totalizador(es) que formarão os valores da linha 07 do campo 04 - Rendimentos Isentos e não Tributáveis.

- Máscara: A[200]
gruEmp Opcional Integer Abrangência: Código de grupo de empresas.

- Máscara: 999
codCal Obrigatório Integer Código de cálculo que será usado no processo.

- Máscara: 9999
comIrf Obrigatório String Contribuintes a calcular

- Máscara: U

Valores:
"I" - Somente com IRRF
"S" - Somente sem IRRF
"T" - Todos
abrTri Opcional String Totalizador(es) que formarão os valores da linha 02 do campo 05 - Rendimentos Sujeitos a Tributação Exclusiva (Rendimento Líquido).

- Máscara: A[100]
codLot Opcional Integer Abrangência: Código de lote de colaboradores.

- Máscara: 9999
parLuc Opcional String Tratar participação de lucros como tributação exclusiva na fonte.

- Máscara: U

Valores:
"S" - Sim
"N" - Não

Este parâmetro só deve ser informado se o parâmetro AnoBas for anterior a 2013.
abrCpl Opcional String Totalizador(es) que formarão os valores da linha 07 do campo 06 - Informações Complementares.

- Máscara: A[200]
abrEmp Opcional String Abrangência: Empresa (+).

- Máscara: A[200]
dep13S Obrigatório String Procedimento referente aos dependentes de 13º Salário.

- Máscara: U

Valores:
"I" - Deduz Quando Teve IR
"S" - Deduz Sempre
"N" - Nunca Deduz
"L" - Limite de Insenção
abrTcl Opcional String Abrangência: Tipo de Colaborador (+).

- Máscara: A[100]
depLuc Opcional String Procedimento referente aos dependentes de participação de lucros.

- Máscara: U

Valores:
"I" - Deduz Quando Teve IR
"S" - Deduz Sempre
"N" - Nunca Deduz
"L" - Limite de Insenção

Este parâmetro só deve ser informado se o parâmetro AnoBas for anterior a 2013.
abrCad Opcional String Abrangência: Colaborador (+).

- Máscara: A[200]
traFer Obrigatório String Tratamento especial para as férias:

- Máscara: U

Valores:
"S" - Sim - As férias que iniciaram em janeiro do ano base e que foram pagas em dezembro do ano base-1, serão consideradas no informe no mês de janeiro do ano base. Não serão consideradas as férias iniciadas em janeiro do ano base+1 e que foram pagas em dezembro do ano base.
"N" - Não - Os valores de férias serão levados para o Informe, conforme a data de pagamento do recibo de férias.
abrFil Opcional String Abrangência: Filial (+).

- Máscara: A[200]
recFer Obrigatório String Tratamento do recibo de férias no Informe.

- Máscara: U

Valores:
"R" - Somente Recibo de Férias - Serão considerados apenas os valores do Recibo de Férias. O sistema não fará nenhuma comparação com os valores de férias integrados na folha mensal.
"F" - Somente Ficha Financeira - Serão considerados apenas os valores encontrados na Ficha Financeira, pela data de pagamento da folha mensal. O sistema não fará nenhuma comparação com os valores de férias calculados no Recibo de Férias.
"P" - Cálculo Padrão - É feito o tratamento normal dos recibos de férias. Os valores sempre serão levados a partir da data de pagamento do recibo, porém, efetuando a proporcionalidade dos eventos e comparando com a ficha financeira. Se os valores forem diferentes, a Administração de Pessoal gerará uma diferença positiva ou negativa.
abrLoc Opcional String Abrangência: Local ("+").

- Máscara: A[200]
insFer Opcional String Como o sistema deve tratar os valores de INSS de férias.

- Máscara: U

Valores:
"N" - Cálculo Normal - O sistema considerará os valores de INSS de férias do recibo de férias. Ou seja o valor irá para o informe integral na data de pagamento do recibo.
"F" - Ficha Financeira - O sistema buscará o evento de INSS s/ férias da ficha financeira. Ou seja, o valor de INSS de férias não será considerado pela data de pagamento do recibo e sim, segundo a data de pagamento da folha mensal.

Este parâmetro só deve ser informado se o parâmetro RecFer for igual a "P".
abrCcu Opcional String Abrangência: Tipo de Contrato (+).

- Máscara: A[100]
danCal Obrigatório String Como o sistema deve tratar os valores de 13o complementar ou complementar a devolver que constam da folha de dezembro com data de pagamento em janeiro do ano seguinte.

- Máscara: U

Valores:
"A" - Janeiro Ano-Base - Considerar somente os valores existentes em janeiro do ano-base.
"B" - Janeiro Ano-Base e Ano-Base + 1 - Considerar os valores existentes em janeiro do ano-base e em janeiro do ano-base + 1.
"D" - Janeiro Ano-Base + 1 - Considerar somente os valores existentes em janeiro do ano-base + 1.
"N" - Não Considera.
abrVin Opcional String Abrangência: Vínculo (+).

- Máscara: A[100]
monPro Obrigatório String Processo do Informe deverá ou não ser monitorado.

- Máscara: U

Valores:
"S" - Sim
"N" - Não

É recomendado informar "N" para esta opção no processo assíncrono, pois senão pode haver perda de performance.
abrOem Opcional String Abrangência: Outra Empresa (+).

- Máscara: A[200]
sobDig Obrigatório String Valores digitados ou alterados nas tabelas do Informe/DIRF (campo OriRen <> de 'G') devem ser recalculados.

- Máscara: U

Valores:
"S" - Sim
"N" - Não
abrCpf Opcional String  
redIrf Opcional Integer Utilizar o redutor de IRRF

- Máscara: 9

Valores:
0 - Sempre Reduz
1 - Somente reduz quando base IR superior ao limite de isenção
2 - Nunca Reduz

Este parâmetro só deve ser informado se o parâmetro AnoBas for igual a 2004.
tipOut Obrigatório String Considerar Eventos Tipo Outros(4,5,6) na soma das bases.

- Máscara: U

Valores:
"S" - Sim
"N" - Não
traIse Obrigatório String Considerar valor Transportador Autônomo(Transportista) como Rendimento Isento.

- Máscara: U

Valores:
"S" - Sim
"N" - Não
cbCol Obrigatório String Gerar o informe Dirf para os colaboradores.

- Máscara: U

Valores
"S" - Sim
"N" - Não
cbFis Obrigatório String Gerar o informe Dirf para os terceiros.

- Máscara: U

Valores
"S" - Sim
"N" - Não
cbJur Obrigatório String Gerar o informe Dirf para outras empresas.

- Máscara: U

Valores
"S" - Sim
"N" - Não
cbDep Obrigatório String Gerar o informe Dirf para os dependentes

- Máscara: U

Valores
"S" - Sim
"N" - Nã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:EscalonarResponse>
      <result>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:EscalonarResponse>
  </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Preenchimento Tipo Descrição
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.

Este artigo ajudou você?