Este conteúdo não recebe atualizações, pois é referente a uma versão do sistema que foi descontinuada. Acesse a documentação da versão 6.10.3 aqui
Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Administração de Pessoal > Com.senior.g5.rh.fp.contabilizacao

Web service com.senior.g5.rh.fp.contabilizacao

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

Contabilizar

Web service para realização de processamentos da contabilização.

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:Contabilizar>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <numDoc>String</numDoc>
        <perIni>String</perIni>
        <gruEmp>Integer</gruEmp>
        <qtdIns>Integer</qtdIns>
        <codCal>Integer</codCal>
        <consol>String</consol>
        <perFim>String</perFim>
        <codLot>Integer</codLot>
        <seqIns>Integer</seqIns>
        <tipCal>Integer</tipCal>
        <tipClc>Integer</tipClc>
        <abrTcl>String</abrTcl>
        <perCal>Integer</perCal>
        <abrCad>String</abrCad>
        <oriCtb>Integer</oriCtb>
        <abrFil>String</abrFil>
        <datLan>String</datLan>
        <abrLoc>String</abrLoc>
        <abrCcu>String</abrCcu>
        <abrRat>String</abrRat>
      </parameters>
    </ser:Contabilizar>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada no cálculo.

- Máscara: 9999
numDoc Opcional String Número do documento.

- Máscara: A[100]

Caso este parâmetro não seja informado, o sistema irá utilizar o valor "0".
perIni Opcional DateTime Data inicial do período de seleção dos recibos e pagamentos.

- Máscara: DD/MM/YYYY

Caso este parâmetro não seja informado, o sistema irá utilizar a data inicial do cálculo ativo.
Este parâmetro não será utilizado quando o parâmetro OriCtb for igual a 1.
gruEmp Opcional Integer Abrangência: Código de grupo de empresas.

- Máscara: 999
qtdIns Opcional Integer Parâmetro de uso interno para controle de escalonamento.
codCal Opcional Integer Código de cálculo que será usado no cálculo.

- Máscara: 9999

Este parâmetro será respeitado apenas se os parâmetros TipCal e PerCal não forem informados (ou estiverem com o valor 0).
consol Opcional String Define os valores de diversos processamentos de mesma competência devem ser consolidados, quando utilizados pagamentos semanais ou quinzenais.

- Máscara: U

Valores:
S - Sim
N - Não

Caso este parâmetro não seja informado, o sistema irá utilizar o valor "N".
perFim Opcional DateTime Data final do período de seleção dos recibos e pagamentos.

- Máscara: DD/MM/YYYY

Caso este parâmetro não seja informado, o sistema irá utilizar a data final do cálculo ativo.
Este parâmetro não será utilizado quando o parâmetro OriCtb for igual a 1.
codLot Opcional Integer Abrangência: Código de grupo de empresas.

- Máscara: 999
seqIns Opcional Integer Parâmetro de uso interno para controle de escalonamento.
tipCal Opcional Integer Tipo do cálculo que será utilizado.

- Máscara: 99

Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CodCal possuir valor.

Valores:
11 - Cálculo Mensal
12 - Folha Complementar
13 - Complementar de Dissídio
14 - Pagamento de Dissídio
15 - Complementar de Rescisão
21 - Primeira Semana
22 - Semana Intermediária
23 - Última Semana
31 - Adiantamento 13º Salário
32 - 13º Salário Integral
41 - Primeira Quinzena
42 - Segunda Quinzena
91 - Adiantamento Salarial
92 - Participação nos Lucros
93 - Especiais
94 - Reclamatória Trabalhista
tipClc Opcional Integer Tipo de CLC deverá ser considerado na geração da contabilização.

- Máscara: 9999
abrTcl Opcional String Abrangência: Tipo de Colaborador (+).

- Máscara: A[100]
perCal Opcional Integer Define o cálculo será realizado referente a data da execução.

- Máscara: 9

Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CodCal possuir valor.

Valores:
0 - Utiliza o Código de Cálculo

1 - Válido Na Data Agendada: Selecionará o Código de Calculo compatível com o Tipo de Cálculo informado
e cuja data de execução do processo esteja dentro do período deste cálculo.

2 - Imediatamente Anterior: Selecionará o Código de Calculo imediatamente anterior ao Válido na Data
Agendada e compatível com o Tipo de Cálculo informado.

3 - Imediatamente Posterior: Selecionará o Código de Calculo imediatamente posterior ao Válido na Data
Agendada e compatível com o Tipo de Cálculo informado.
abrCad Opcional String Abrangência: Colaborador (+).

- Máscara: A[200]
oriCtb Obrigatório Integer Define o tipo de valor que será contabilizado.

- Máscara: 9

Valores:
1 - Folha: contabiliza os valores de folha, provisão e compensações do cálculo definido e o que estiver configurado para contabilizar junto com ela.
2 - Férias: contabiliza os recibos de férias do período definido.
3 - Rescisão: contabiliza os valores de rescisão do período definido.
4 - Outras Empresas: contabiliza os pagamentos efetuados para outras empresas no período definido.
5 - Terceiros :contabiliza os pagamentos efetuados para terceiros no período definido.
abrFil Opcional String Abrangência: Filial (+).

- Máscara: A[200]
datLan Obrigatório DateTime Data de lançamento utilizada.

- Máscara: DD/MM/YYYY

Caso este parâmetro não seja informado, o sistema irá utilizar a data final do cálculo ativo.
abrLoc Opcional String Abrangência: Local ("+").

- Máscara: A[200]
abrCcu Opcional String Abrangência: Centro de Custo ("+").

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

- Máscara: A[200]

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:ContabilizarResponse>
      <result>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:ContabilizarResponse>
  </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 para realização de processamentos escalonados da contabilização.

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>
        <numDoc>String</numDoc>
        <perIni>String</perIni>
        <gruEmp>Integer</gruEmp>
        <qtdIns>Integer</qtdIns>
        <codCal>Integer</codCal>
        <consol>String</consol>
        <perFim>String</perFim>
        <codLot>Integer</codLot>
        <seqIns>Integer</seqIns>
        <tipCal>Integer</tipCal>
        <tipClc>Integer</tipClc>
        <abrTcl>String</abrTcl>
        <perCal>Integer</perCal>
        <abrCad>String</abrCad>
        <oriCtb>Integer</oriCtb>
        <abrFil>String</abrFil>
        <datLan>String</datLan>
        <abrLoc>String</abrLoc>
        <abrCcu>String</abrCcu>
        <abrRat>String</abrRat>
      </parameters>
    </ser:Escalonar>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada no cálculo.

- Máscara: 9999
numDoc Opcional String Número do documento.

- Máscara: A[100]

Caso este parâmetro não seja informado, o sistema irá utilizar o valor "0".
perIni Opcional DateTime Data inicial do período de seleção dos recibos e pagamentos.

- Máscara: DD/MM/YYYY

Caso este parâmetro não seja informado, o sistema irá utilizar a data inicial do cálculo ativo.
Este parâmetro não será utilizado quando o parâmetro OriCtb for igual a 1.
gruEmp Opcional Integer Abrangência: Código de grupo de empresas.

- Máscara: 999
qtdIns Opcional Integer Parâmetro de uso interno para controle de escalonamento.
codCal Opcional Integer Código de cálculo que será usado no cálculo.

- Máscara: 9999

Este parâmetro será respeitado apenas se os parâmetros TipCal e PerCal não forem informados (ou estiverem com o valor 0).
consol Opcional String Define os valores de diversos processamentos de mesma competência devem ser consolidados, quando utilizados pagamentos semanais ou quinzenais.

- Máscara: U

Valores:
S - Sim
N - Não

Caso este parâmetro não seja informado, o sistema irá utilizar o valor "N".
perFim Opcional DateTime Data final do período de seleção dos recibos e pagamentos.

- Máscara: DD/MM/YYYY

Caso este parâmetro não seja informado, o sistema irá utilizar a data final do cálculo ativo.
Este parâmetro não será utilizado quando o parâmetro OriCtb for igual a 1.
codLot Opcional Integer Abrangência: Código de grupo de empresas.

- Máscara: 999
seqIns Opcional Integer Parâmetro de uso interno para controle de escalonamento.
tipCal Opcional Integer Tipo do cálculo que será utilizado.

- Máscara: 99

Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CodCal possuir valor.

Valores:
11 - Cálculo Mensal
12 - Folha Complementar
13 - Complementar de Dissídio
14 - Pagamento de Dissídio
15 - Complementar de Rescisão
21 - Primeira Semana
22 - Semana Intermediária
23 - Última Semana
31 - Adiantamento 13º Salário
32 - 13º Salário Integral
41 - Primeira Quinzena
42 - Segunda Quinzena
91 - Adiantamento Salarial
92 - Participação nos Lucros
93 - Especiais
94 - Reclamatória Trabalhista
tipClc Opcional Integer Tipo de CLC deverá ser considerado na geração da contabilização.

- Máscara: 9999
abrTcl Opcional String Abrangência: Tipo de Colaborador (+).

- Máscara: A[100]
perCal Opcional Integer Define o cálculo será realizado referente a data da execução.

- Máscara: 9

Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CodCal possuir valor.

Valores:
0 - Utiliza o Código de Cálculo

1 - Válido Na Data Agendada: Selecionará o Código de Calculo compatível com o Tipo de Cálculo informado
e cuja data de execução do processo esteja dentro do período deste cálculo.

2 - Imediatamente Anterior: Selecionará o Código de Calculo imediatamente anterior ao Válido na Data
Agendada e compatível com o Tipo de Cálculo informado.

3 - Imediatamente Posterior: Selecionará o Código de Calculo imediatamente posterior ao Válido na Data
Agendada e compatível com o Tipo de Cálculo informado.
abrCad Opcional String Abrangência: Colaborador (+).

- Máscara: A[200]
oriCtb Obrigatório Integer Define o tipo de valor que será contabilizado.

- Máscara: 9

Valores:
1 - Folha: contabiliza os valores de folha, provisão e compensações do cálculo definido e o que estiver configurado para contabilizar junto com ela.
2 - Férias: contabiliza os recibos de férias do período definido.
3 - Rescisão: contabiliza os valores de rescisão do período definido.
4 - Outras Empresas: contabiliza os pagamentos efetuados para outras empresas no período definido.
5 - Terceiros :contabiliza os pagamentos efetuados para terceiros no período definido.
abrFil Opcional String Abrangência: Filial (+).

- Máscara: A[200]
datLan Obrigatório DateTime Data de lançamento utilizada.

- Máscara: DD/MM/YYYY

Caso este parâmetro não seja informado, o sistema irá utilizar a data final do cálculo ativo.
abrLoc Opcional String Abrangência: Local ("+").

- Máscara: A[200]
abrCcu Opcional String Abrangência: Centro de Custo ("+").

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

- Máscara: A[200]

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.

ExcluirLoteContabil

Permite excluir lançamentos que possuam lote contábil informado.

  Observações

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:ExcluirLoteContabil>
  <user>String</user>
  <password>String</password>
  <encryption>Integer</encryption>
  <parameters>
    <registro>
     <sequencia>Integer</sequencia>
     <condicao>
     <nome>String</nome>
     <valor>String</valor>
     </condicao>
     <status>String</status>
     <mensagem>String</mensagem>
    </registro>
   </parameters>
  </ser:ExcluirLoteContabil>
 </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Tipo Preenchimento Descrição
registro Set Obrigatório Cada ocorrência deste elemento representa uma exclusão que será realizada no sistema.
registro.sequencia Integer Opcional Identificador para facilitar a recuperação do resultado. Deve ser informado pelo solicitante.
condicao Set Obrigatório Campos da tabela Contabilização (R048CTB) que serão utilizados como filtro para realizar a exclusão. Cada ocorrência deste elemento representa uma condição do filtro, que testa se o campo é IGUAL ao valor informado. Os lançamentos contábeis que atenderem a todas as condições informadas, e que possuam lote serão excluídos.
Todos os campos da R048CTB podem ser utilizados, inclusive campos de usuário.

Os campos abaixo precisam ser adicionados obrigatoriamente:
NomeTipoTamanhoMáscaraDescrição
NUMEMPNúmero4-Código da empresa
CODLOTNúmero9-Código do lote contábil que será excluído.
condicao.nome String Obrigatório Nome do campo.
condicao.valor String Obrigatório Valor do campo.

Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • O formato para datas é DD/MM/YYYY ou MM/YYYY, conforme a máscara do campo.

Resposta: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> 
 <soapenv:Body>
  <ser:ExcluirLoteContabilResponse>
   <result>
    <registro>
     <sequencia>Integer</sequencia>
     <condicao>
     <nome>String</nome>
     <valor>String</valor>
     </condicao>
     <status>String</status>
     <mensagem>String</mensagem>
    </registro>
    <erroExecucao>String</erroExecucao>
   </result>
  </ser:ExcluirLoteContabilResponse>
 </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Tipo Preenchimento Descrição
registro Set Obrigatório Repete as ocorrências enviadas na requisição.
registro.sequencia Integer Opcional Identificador para facilitar a recuperação do resultado. Deve ter sido informado pelo solicitante na requisição.
condicao Set Obrigatório Repete as ocorrências enviadas na requisição.
condicao.nome String Obrigatório Nome do campo.
condicao.valor String Obrigatório Valor do campo.
registro.status String Obrigatório Status de retorno da ocorrência. Retorna a quantidade de registros afetados. Retorna - 1 caso ocorra algum erro no processamento da ocorrência.
registro.mensagem String Obrigatório Mensagem de retorno da ocorrência. Retorna OK se o STATUS for igual ou superior a 0. Retorna a descrição do erro o STATUS for igual a - 1.

InformarLoteContabil

Permite informar lote contábil para os lançamentos da contabilização.

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:InformarLoteContabil>
   <user>String</user>
   <password>String</password>
   <encryption>Integer</encryption>
   <parameters>
    <registro>
     <sequencia>Integer</sequencia>
     <atribuicao>
      <nome>String</nome>
      <valor>String</valor>
     </atribuicao>
     <condicao>
      <nome>String</nome>
      <valor>String</valor>
     </condicao>
     <status>String</status>
     <mensagem>String</mensagem>
    </registro>
   </parameters>
  </ser:InformarLoteContabil>
 </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Tipo Preenchimento Descrição
registro Set Obrigatório Cada ocorrência deste elemento representa um lote contábil que será atualizado no sistema.
registro.sequencia Integer Opcional Identificador para facilitar a recuperação do resultado. Deve ser informado pelo solicitante.
atribuicao Set Obrigatório Campos da tabela de Contabilização (R048CTB) que serão atualizados. Cada ocorrência deste elemento representa uma atribuição para um campo.

Campos permitidos:
NomeTipoTamanhoMáscaraDescrição
CODLOTNúmero9-Código do lote contábil que será atribuído. Este campo é obrigatório.
atribuicao.nome String Obrigatório Nome do campo.
atribuicao.valor String Obrigatório Valor do campo.
Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • O formato para datas é DD/MM/YYYY ou MM/YYYY, conforme a máscara do campo.
condicao Set Obrigatório Campos da tabela de Consulta de Contabilização (R048CTB) que serão utilizados como filtro para realizar a atribuição de valor. Cada ocorrência deste elemento representa uma condição do filtro, que testa se o campo é IGUAL ao valor informado. Os lançamentos contábeis que atenderem a todas as condições informadas, e que ainda não possuam lote serão atualizados.
Todos os campos da R048CTB podem ser utilizados, inclusive campos de usuário.

Os campos abaixo precisam ser adicionados obrigatoriamente:
NomeTipoTamanhoMáscaraDescrição
NUMEMPNúmero4-Código da empresa
DATLANData-DD/MM/YYYYData de lançamento
condicao.nome String Obrigatório Nome do campo.
condicao.valor String Obrigatório Valor do campo.

Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • O formato para datas é DD/MM/YYYY ou MM/YYYY, conforme a máscara do campo.

Resposta: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
 <soapenv:Body>
  <ser:InformarLoteContabilResponse>
   <result>
    <registro>
     <sequencia>Integer</sequencia>
     <atribuicao> 
      <nome>String</nome>
      <valor>String</valor>
     </atribuicao>
     <condicao>
      <nome>String</nome>
      <valor>String</valor>
     </condicao>
     <status>String</status>
     <mensagem>String</mensagem>
    </registro>
    <erroExecucao>String</erroExecucao>
   </result>
  </ser:InformarLoteContabilResponse>
 </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Tipo Preenchimento Descrição
registro Set Obrigatório Repete as ocorrências enviadas na requisição.
registro.sequencia Integer Opcional Identificador para facilitar a recuperação do resultado. Deve ter sido informado pelo solicitante na requisição.
atribuicao Set Obrigatório Repete as ocorrências enviadas na requisição.
atribuicao.nome String Obrigatório Nome do campo.
atribuicao.valor String Obrigatório Valor do campo.
condicao Set Obrigatório Repete as ocorrências enviadas na requisição.
condicao.nome String Obrigatório Nome do campo.
condicao.valor String Obrigatório Valor do campo.
registro.status String Obrigatório Status de retorno da ocorrência. Retorna a quantidade de registros afetados. Retorna -1 caso ocorra algum erro no processamento da ocorrência.
registro.mensagem String Obrigatório Mensagem de retorno da ocorrência. Retorna OK se o STATUS for igual ou superior a 0. Retorna a descrição do erro o STATUS for igual a -1.

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Documentação em outros idiomas:

English

Español

seniorX Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).

Ver site completo