Visão Geral do Programa
O Painel de Conferência de IRRF é uma das novidades no middleware.
Esta funcionalidade tem como objetivo não ser apenas um relatório, mas uma ferramenta simples e intuitiva para a consulta dos valores de retenção de IRRF presentes na Folha (S-1200) e no evento Totalizador ( S-5002 ) enviado pelo governo. É composto pelas informações dos eventos ( S-1200, S-2299, S-2399 e S-1210) enviados para o eSocial.
A seguir iremos listar e explicar o que cada valor representado dentro do painel, bem como utilizar suas funcionalidades.
Procedimento para Uso
Menu
Miscelânea → eSocial → Monitor
Passo a Passo
Navegação
Ao acessar esta opção será exibido o menu das funcionalidades presentes no Painel eSocial, conforme imagem abaixo:
Filtros
Ao clicarmos em "Relatório de Conferência de IRRF" será exibida a seguinte tela:
Lista de campos apresentados na tela para utilização como filtro das informações a serem processadas:
Campo | Obrigatoriedade | Descrição |
|---|---|---|
| Período | Obrigatório | Ano/Mês no formato AAAA/MM, ou apenas Ano no formato AAAA, para ser considerado no processamento das informações do painel. |
| CPF | Opcional | CPF do colaborador o qual se deseja buscar os valores de IRRF. |
| Somente Divergências | Opcional | Parâmetro que permite listar somente os casos que apresentaram alguma divergência de valores entre as colunas Valor de Retenção RH x Valor de Retenção Governo, ou listar todos os colaboradores que possuam valor de IRRF em sua remuneração, independente de divergência ou não. Opções:
|
| Somente Avisos | Opcional | Parâmetro que permite listar somente os casos que apresentaram algum aviso devido diferença de valores entre os tipos de IR possíveis, seja retenção, base ou dedução Opções:
|
Importante
O painel conta com filtro adicional que pode ser encontrado clicando no botão "Busca Avançada". Neste filtro é possível adicionar a condição de categoria e quantos funcionários devem ser retornados por página.
Lista de campos apresentados na tela de Busca Avançada:
Campo | Obrigatoriedade | Descrição |
|---|---|---|
| Período | Obrigatório | Ano/Mês no formato AAAA/MM, ou apenas Ano no formato AAAA, para ser considerado no processamento das informações do painel. |
| Somente Divergências | Opcional | Parâmetro que permite listar somente os casos que apresentaram alguma divergência de valores entre as colunas FOLHA x Governo, ou listar todos os colaboradores que possuam valor de IRRF em sua remuneração, independente de divergência ou não. Opções:
|
| Categoria | Opcional | Categoria do colaborador o qual se deseja buscar os valores de IRRF. |
| CPF | Opcional | CPF do colaborador o qual se deseja buscar os valores de IRRF. |
| Funcionários por Página | Opcional | Por Default são retornados 30 funcionários por página, mas pode-se definir uma quantidade maior ou menor. |
Processamento
Ao aplicarmos os filtros será apresentada a seguinte tela:
Apresentação das Informações
Cards Totalizadores da Consulta
Estes cards totalizam os valores de retenção de IR encontrados nas duas fontes de informação ( RH e Governo ) e demonstra de forma sintética os resultados, desta forma, já é possível identificar se existem divergências nos valores.
Lista de Funcionários
Abaixo do quadro de totalizadores temos a lista de funcionário, sendo possível consultar o valor total de IR Retido de cada um deles, com os valores presentes na folha e no Governo.
Ao expandir cada funcionário será possível consultar os valores de retenção de IR de cada recibo de pagamento
Detalhamento do demonstrativo
Ao clicar sobre o demonstrativo será apresenta demais dados sobre os tipos de IR existente em no demonstrativo selecionado. Informações apresentadas:
- No cabeçalho é possível visualizar a qual demonstrativo se referem os dados apresentados;
- Na lista de consolidação são apresentados os tipos de IR existentes no demonstrativo, podendo expandir cada um deles para visualização;
- A descrição de cada tipo de IR está relacionada a incidência IR indicada nas rubricas existente em cada recibo, consulta esta relação em "observações".
Abaixo o resultado da expansão do item "Rendimentos tributáveis"
- Neste exemplo a descrição Remuneração Mensal ocorre devido a existência de rubricas com incidência IR 11 neste demonstrativo;
- A descrição apresentada tem origem na tabela S138, é a mesma ao selecionar este código no cadastro de verbas.
Detalhamento do Funcionário
Ao clicar sobre o funcionário será apresenta demais dados sobre os tipos de IR existente totalizados. Informações apresentadas:
- No cabeçalho é possível visualizar a quais demonstrativos se referems os dados apresentados;
- Na lista de consolidação são apresentados os tipos de IR existentes, podendo expandir cada um deles para visualização;
- A descrição de cada tipo de IR está relacionada a incidência IR indicada nas rubricas existente em cada recibo, consulta esta relação em "observações".
Observações
Abaixo algumas considerações importantes para o correto funcionamento do Painel de Conferência de IRRF.
Importante
O Pacote da expedição contínua a partir de 25/08/2023 deve estar aplicada.
- Os valores Folha são capturados dos eventos S-1200, S-2299 e S-2399 gravados na tabela RJO atualizados a partir da expedição contínua citada, portanto os meses anteriores podem não ser apresentados.
- Os valores Governo são capturados do evento S-5002, esse evento é recepcionado ao transmitir o evento S-1210 e seus valores também são gravados na tabela RJO, portanto somente os meses que possuem dados para este evento na tabela citada são apresentados no relatório.
IMPORTANTE:
A Visualização do detalhamento de cada demonstrativo de pagamento, assim como a exportação analítica e o filtro por aviso estão disponíveis na expedição contínua a partir de 12/01/2024.
Tipos de IR vs Incidência IR:
- A descrição da tabela abaixo representando o grupo dos códigos relacionados;
- A descrição de cada código da tabela abaixo está na tabela S138, caso seja um código não existente nesta tabela, o texto apresentado será o mesmo descrito na documentação técnica do evento S-5002
- Alguns códigos são aglutinados em outro. Exemplos.:
- 11 - Remuneração e 13 - Férias. No evento S-5002 e no relatório são aglutinados no código 11,
- 31 - Remuneração e 33 - Férias. No evento S-5002 e no relatório são aglutinados no código 31,
- Documentação técnica do governo
| Descrição do tipo de IR | Códigos Relacionados |
|---|---|
| Rendimentos Tributáveis | 11, 12, 14 |
| Retenções do IRRF | 31, 32, 34 |
| Rendimento não tributável ou isento do IRRF | 70, 71, 72, 73, 74, 75, 76, 77, 700, 701, 79, 7900 |
| Deduções da base de cálculo do IRRF | 41, 42, 46, 47, 51, 52, 54, 61, 62, 63, 64, 67 |
| Exigibilidade suspensa - Rendimento tributável | 9011, 9012, 9014 |
| Exigibilidade suspensa - Retenção do IRR | 9031, 9032, 9034, 9832, 9832, 9834 |
| Exigibilidade suspensa - Dedução da base de cálculo do IRRF | 9041, 9042, 9046, 9047, 9052, 9054, 9061, 9062, 9063, 9064, 9067 |
| Compensação judicial | 9082, 9083 |
Detalhamento do grupo de colunas da Lista de Funcionários
Campos | Descrição | Atributo | Campo | Detalhamento |
|---|---|---|---|
| Nome | Nome do trabalhador | name | RJO_NOME |
| CPF | CPF do Trabalhador | cpfNumber | RJO_CPF |
| Valor Retenção RH | Valor de retenção de IRRF Total do Trabalhador | erpValue | RJO_VALOR | Soma-se todos os valores do CPF (chave) com o campo RJO_INCIRF igual a 31, 32, 33 e 34 com o RJO_TPRUBR igual a 2 (Desconto) ou 4 (Base Desconto) e deduz todos os valores do CPF (chave) com o campo RJO_INCIRF igual a 31, 32, 33 e 34 com o RJO_TPRUBR igual a 1 (Provento) ou 3 (Base Provento). O campo RJO_EVENTO deve ser S-1200, S-2299 ou S-2399. |
| Valor Retenção Governo | Valor de retenção de IRRF Total do Trabalhador | retValue | RJO_VALOR | Soma-se todos os valores do CPF (chave) com o campo RJO_TPIRRF igual a 31, 32, 33 e 34. O campo RJO_EVENTO deve ser S-5002. |
Detalhamento ao expandir o grupo Lista de Funcionários
Campos | Descrição | Atributo | Campo | Detalhamento |
|---|---|---|---|
| Demonstrativo | Código do demonstrativo (recibo) do Trabalhador | demonstrativeId | RJO_IDEDMD |
| Categoria | CPF do Trabalhador | cpfNumber | RJO_CPF |
| Período de Referência | Período de Referência | referencePeriod | RJO_PERAPU | Como os valores tem origem nos eventos S-1200, S-2299 ou S-2399, independente se a data de pagamento é posterior ao período, o período de referência sempre se refere ao período de apuração destes eventos. |
| Valor Retenção RH | Valor de retenção de IRRF Total do Trabalhador | erpValue | RJO_VALOR | Soma-se todos os valores do CPF (chave) e mesmo recibo (RJO_IDEDMD) com o campo RJO_INCIRF igual a 31, 32, 33 e 34 com o RJO_TPRUBR igual a 2 (Desconto) ou 4 (Base Desconto) e deduz todos os valores do CPF (chave) com o campo RJO_INCIRF igual a 31, 32, 33 e 34 com o RJO_TPRUBR igual a 1 (Provento) ou 3 (Base Provento). O campo RJO_EVENTO deve ser S-1200, S-2299 ou S-2399. |
| Valor Retenção Governo | Valor de retenção de IRRF Total do Trabalhador | retValue | RJO_VALOR | Soma-se todos os valores do CPF (chave) mesmo recibo (RJO_IDEDMD) com o campo RJO_TPIRRF igual a 31, 32, 33 e 34. O campo RJO_EVENTO deve ser S-5002. |
| Data de Pagamento | Data de Pagamento do demonstrativo | payday | RJO_DTPGTO | Data de pagamento da chave RJO_CPF + RJO_IDEDMD |
| Origem (Tipo de Pagamento) | Evento de Origem do demosntrativo | origin | RJO_EVENTO | Evento da chave RJO_CPF + RJO_IDEDMD |
Informações Técnicas da API IRRFRetValues
A IRRFRetValues é um método GET da API GPEreportEsocialBaseConfer.
Em resumo, o método POST da API GPEreportEsocialBaseConfer retorna o Id da requisição e o processamento do relatório é executado de forma assíncrona, o método GET IRRFRetValues obtém a resposta deste processamento. Exemplos de execução abaixo:
A API IRRFRetValues retorna os dados utilizados no relatório de conferência IRRF.
Abaixo dados dos parâmetros usados pela API
Parâmetros GET:
Identificador da empresa |
(1-1) |
companyId |
string |
Código da Empresa |
Id. da requisição |
(1-1) |
requestId |
string |
Id da Requisição |
Nível das Informações |
(0-1) |
level |
string (default: 0) |
0 - Total por Empresa 1 - Total por Funcionário, 2 - Total do Funcionário por demonstrativo, 9 - Todos os níveis |
Somente divergências |
(0-1) |
differencesOnly |
boolean (default: false) |
Indica se os funcionários com diferenças devem ser retornados ou não (exceto para o nível 0) |
Cpf |
(0-1) |
cpfNumber |
string |
Cpf do funcionário a ser retornado (exceto para o nível 0) |
Página para controle de paginação |
(0-1) |
page |
number (default: 1) |
Número da página a ser retornada |
Tamanho da página |
(0-1) |
pageSize |
number (default: 30) |
Número de itens que devem ser retornados na página |
Abaixo o exemplo de uso e retorno para cada nível de informações
- Exemplo endPoint: http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?companyId=T7|AARS 001&level=0&page=1&pageSize=15&requestId=41412f0c-2627-cf86-c445-b683454c1d54
- Query Params preenchidos corretamente:
- Retorno
{
"code": 400,
"message": "Ambiente desatualizado.",
"detailedMessage": "Aplique a última atualização da expedição contínua do RH. Para correta execução do relatório as tabelas RU4 e RU5 devem existir no ambiente."
}
- Exemplo endPoint: http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?level=0&page=1&pageSize=15&requestId=41412f0c-2627-cf86-c445-b683454c1d54
- Query Params sem o companyId :
- Retorno
{
"code": 400,
"message": "Empresa|Filial não informado no parâmetro 'companyId'.",
"detailedMessage": ""
}
- Exemplo endPoint: http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?companyId=T7AARS 001&level=0&page=1&pageSize=15&requestId=41412f0c-2627-cf86-c445-b683454c1d54
- Query Params com o companyId preenchido incorretamente, sem a quebra de grupo e filial com pipe ("|"):
- Retorno
{
"code": 400,
"message": "Empresa|Filial não informado no parâmetro 'companyId'.",
"detailedMessage": ""
}
- Exemplo endPoint: http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?companyId=T9|AARS 001&level=0&page=1&pageSize=15&requestId=41412f0c-2627-cf86-c445-b683454c1d54
- Query Params com o companyId preenchido com dados que não existem no cadastro da empresa.
- Retorno
{
"code": 400,
"message": "Falha na preparação do ambiente para a Empresa 'T9' e Filial 'AARS 001'.",
"detailedMessage": ""
}
- Exemplo endPoint: http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?companyId=T7|AARS 001&level=0&page=1&pageSize=15&requestId=teste
- Query Params com o requestId inválido.
- Retorno
{
"code": 400,
"message": "A Identificação da Requisição 'teste' informado no parâmetro 'requestId' não existe.",
"detailedMessage": ""
}
- Exemplo endPoint: http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?companyId=T7|AARS 001&level=0&page=1&pageSize=15&requestId=teste
- Query Params com o requestId inválido.
- Retorno
{
"code": 400,
"message": "Identificação da Requisição não informada no parâmetro 'requestId'.",
"detailedMessage": ""
}
- Exemplo de EndPoint:
http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?companyId=T7|AARS 001&level=0&page=1&pageSize=15&requestId=41412f0c-2627-cf86-c445-b683454c1d54
- Exemplo de retorno da execução
{
"items": [
{
"totalIRRFCompany": {
"erpValue": 2875.76,
"retValue": 2875.76
}
}
],
"hasNext": false
}
- Exemplo de EndPoint:
http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?companyId=T7|AARS 001&level=1&page=1&pageSize=15&requestId=41412f0c-2627-cf86-c445-b683454c1d54
- Exemplo de retorno da execução
{
"items": [
{
"employees": [
{
"cpfNumber": "30307422020",
"name": "DRHROTPRT-11682 DOIS ",
"period": "2023-06",
"totalIrrfRetention": {
"erpValue": 46.87,
"retValue": 46.87
},
"divergent": false
},
{
"cpfNumber": "35541406358",
"name": "DRHROTPRT-11682 UM ",
"period": "2023-06",
"totalIrrfRetention": {
"erpValue": 413.85,
"retValue": 413.85
},
"divergent": false
},
{
"cpfNumber": "43611791075",
"name": "DRHROTPRT-11682 TSV DOIS ",
"period": "2023-06",
"totalIrrfRetention": {
"erpValue": 0,
"retValue": 0
},
"divergent": false
},
{
"cpfNumber": "53247550283",
"name": "DRHROTPRT-11682 TRES ",
"period": "2023-06",
"totalIrrfRetention": {
"erpValue": 0,
"retValue": 0
},
"divergent": false
},
{
"cpfNumber": "81125476702",
"name": "DRHROTPRT-11682 TSV ",
"period": "2023-06",
"totalIrrfRetention": {
"erpValue": 2415.04,
"retValue": 2415.04
},
"divergent": false
}
]
}
],
"hasNext": false
}
- Exemplo de EndPoint:
http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?companyId=T7|AARS 001&level=2&page=1&pageSize=1&requestId=41412f0c-2627-cf86-c445-b683454c1d54&cpfNumber=53247550283
- Exemplo de retorno da execução
{
"items": [
{
"employees": [
{
"cpfNumber": "53247550283",
"name": "DRHROTPRT-11682 TRES ",
"period": "2023-06",
"demonstrative": [
{
"demonstrativeId": "AARS 00120230620202306PLR ",
"category": "101",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-20",
"irrfRetention": {
"erpValue": 0,
"retValue": 0
}
},
{
"demonstrativeId": "AARS 00120230630202306FOL ",
"category": "101",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-30",
"irrfRetention": {
"erpValue": 0,
"retValue": 0
}
}
],
"divergent": false
}
]
}
],
"hasNext": true
}
- Exemplo de EndPoint:
http://localhost:8104/rest/api/rh/esocial/v1/GPEreportEsocialBaseConfer/IRRFRetValues?companyId=T7|AARS 001&level=9&page=1&pageSize=15&requestId=41412f0c-2627-cf86-c445-b683454c1d54
- Exemplo de retorno da execução
{
"items": [
{
"totalIRRFCompany": {
"erpValue": 2875.76,
"retValue": 2875.76
}
},
{
"employees": [
{
"cpfNumber": "30307422020",
"name": "DRHROTPRT-11682 DOIS ",
"period": "2023-06",
"demonstrative": [
{
"demonstrativeId": "RT7AARS 001000083 ",
"category": "101",
"referencePeriod": "2023-06",
"origin": "S-2299",
"payday": "2023-06-27",
"irrfRetention": {
"erpValue": 46.87,
"retValue": 46.87
}
}
],
"totalIrrfRetention": {
"erpValue": 46.87,
"retValue": 46.87
},
"divergent": false
},
{
"cpfNumber": "35541406358",
"name": "DRHROTPRT-11682 UM ",
"period": "2023-06",
"demonstrative": [
{
"demonstrativeId": "AARS 00120230608202306FER ",
"category": "101",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-08",
"irrfRetention": {
"erpValue": 157.72,
"retValue": 157.72
}
},
{
"demonstrativeId": "AARS 00120230615202306ADI ",
"category": "101",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-15",
"irrfRetention": {
"erpValue": 154.96,
"retValue": 154.96
}
},
{
"demonstrativeId": "AARS 00120230620202306PLR ",
"category": "101",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-20",
"irrfRetention": {
"erpValue": 101.17,
"retValue": 101.17
}
},
{
"demonstrativeId": "AARS 00120230630202306FOL ",
"category": "101",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-30",
"irrfRetention": {
"erpValue": 0,
"retValue": 0
}
}
],
"totalIrrfRetention": {
"erpValue": 413.85,
"retValue": 413.85
},
"divergent": false
},
{
"cpfNumber": "43611791075",
"name": "DRHROTPRT-11682 TSV DOIS ",
"period": "2023-06",
"demonstrative": [
{
"demonstrativeId": "AARS 00120230630202306AUT ",
"category": "701",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-30",
"irrfRetention": {
"erpValue": 0,
"retValue": 0
}
}
],
"totalIrrfRetention": {
"erpValue": 0,
"retValue": 0
},
"divergent": false
},
{
"cpfNumber": "53247550283",
"name": "DRHROTPRT-11682 TRES ",
"period": "2023-06",
"demonstrative": [
{
"demonstrativeId": "AARS 00120230620202306PLR ",
"category": "101",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-20",
"irrfRetention": {
"erpValue": 0,
"retValue": 0
}
},
{
"demonstrativeId": "AARS 00120230630202306FOL ",
"category": "101",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-30",
"irrfRetention": {
"erpValue": 0,
"retValue": 0
}
}
],
"totalIrrfRetention": {
"erpValue": 0,
"retValue": 0
},
"divergent": false
},
{
"cpfNumber": "81125476702",
"name": "DRHROTPRT-11682 TSV ",
"period": "2023-06",
"demonstrative": [
{
"demonstrativeId": "AARS 00120230630202306AUT ",
"category": "701",
"referencePeriod": "2023-06",
"origin": "S-1200",
"payday": "2023-06-30",
"irrfRetention": {
"erpValue": 2415.04,
"retValue": 2415.04
}
}
],
"totalIrrfRetention": {
"erpValue": 2415.04,
"retValue": 2415.04
},
"divergent": false
}
]
}
],
"hasNext": false
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas