Histórico da Página
01. DADOS GERAIS
Produto: |
| |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Linha de Produto: |
| |||||||||||||
Segmento: |
| |||||||||||||
Módulo: |
| |||||||||||||
Função: | API REST de Relatórios de Conferência (reportEsocialBaseConfer.p; apiReportEsocialBaseConfer.p; apiReportEsocialBaseConferV1.i; fpefd553.p) | |||||||||||||
País: | Brasil | |||||||||||||
Ticket: | DRHROTDTS-10046 | |||||||||||||
Requisito/Story/Issue (informe o requisito relacionado) : |
|
02. SITUAÇÃO/REQUISITO
A issue DRHROTDTS-10046 trata o trata o retorno de dados de nível zero do backend do , do Relatório de Conferência de Imposto de Renda Retido na Fonte (IRRF). Tendo em vista que os Relatórios de Conferência de INSS e FGTS já já foram implementados e estão disponíveis no produto, é necessário implementar este novo recurso na estrutura e arquitetura existentes. Desta forma, os relatórios de conferência serão centralizados no mesmo serviço.
...
O documento de requisitos dos relatórios define todos os recursos relacionados; para execução, consulta de status e retorno de valores de INSS, FGTS e INSS. A rota para o Relatório de Conferência de IRRF é /IRRFRetValues, levando em consideração a estrutura onde deve ser implementado, {{server}}/api/rh/esocial/v1/reportEsocialBaseConfer. Como iremos tratar apenas a obtenção de valores, o método HTTP relacionado à esta issue é GET e os parâmetros são:
- companyId; (1-1); string;
- requestId; (1-1); string;
- level; (0-1); string;
- differencesOnly; (0-1); boolean;
- cpfNumber; (0-1); string;
- page; (0-1); number;
- pageSize; (0-1); number;
O nível zero de de retorno de informaçõesdados, do recurso em questão, contempla as informações de de Totalizadores por Empresa. Identificar : identificar todos os valores retidos, uma vez recuperados do do XML de retorno do governo, para a empresa que estiver realizando a execução do relatório. Os tipos de valores que devem ser somados, para compor o "retValue", serão do tipo mensal, décimo terceiro e PLR, respectivamente de <tpInfoIr>, em nosso sistema sped_relat_irf_func.cdn_tip_pagto, 31, 32 e 34.
Para maiores informações relacionadas à este recurso basta verificar o item 3.4, da documentação informada anteriormente. Gostaríamos de deixar claro que, em nossa execução, não realizaremos o tratamento da informação "tafValue", presente na documentação citada.
03. SOLUÇÃO
Para obter os valores do Relatório de Conferência de Imposto de Renda Retido na Fonte, é necessário primeiro realizar a execução do relatório, na rota /reportEsocialBaseConfer, e recuperar o identificador da requisição, requisito para obter os dados.
O recurso responsável pela execução dos relatórios permite a utilização de filtros mais robustos, em relação às opções de filtros relacionados à camada de obtenção de valores. As respectivas camadas são apresentadas no documento de requisitos citado anteriormente.
Figura 1 - arquitetura utilizada para construção dos relatórios de conferência
...
Realizamos a execução do relatório, na rota /reportEsocialBaseConfer, informando filtros avançados e recuperamos o identificador da requisição, conforme a captura de tela abaixo:
Figura 2 – captura de tela da aplicação “Postman”, utilizada para realizer os testes. A requisição em questão realiza a execução do relatório, etapa necessária para recuperar o identificador da requisição, requisito para obter os valores do relatório posteriormente
...
Após realizar a execução do relatório e recuperar o identificador da requisição, basta obter os valores do relatório desejado, em nosso caso, do Relatório de Conferência de IRRF, disponível na rota /IRRFRetValues, conforme a captura de tela abaixo:
Figura 3 - captura de tela da aplicação “Postman”, utilizada para realizer os testes. A requisição em questão realiza a obtenção dos valores do Relatório de Conferência de IRRF, a partir do identificador da requisição recuperado na execução do relatório
Todos os testes foram realizados no ambiente corporativo de desenvolvimento e testes, Embaú 8680. As requisições realizadas, bem como as rotas, parâmetros e respostas foram apresentados nas capturas de tela acima.