Histórico da Página

...

Totvs custom tabs box

tabs	1.Visão Geral,2.Menu,3.Integração,4.Atualização/Dicionário,5.Informações Técnicas - APIs,6.Documentos Relacionados,7.Vídeos
ids	visao,menu,naveg,dicionario,tech,doc,vídeos

Totvs custom tabs box items

default	yes
referencia	visao

Desenvolvimento da interface no POUI e das APIs, convergente nas 3 linhas para realizar o controle e gestão dos períodos onde foram retificados em Janeiro do ano (infoIRComplem/perAnt) .

Importante

Requisito para a rotina funcionar:

Aplicação da Atualização RH - Pacote Console de 13/10/2025 - 12.1.2507.5, 12.1.2503.11 e 12.1.2411.16;

Totvs custom tabs box items

default	no
referencia	menu

Totvs custom tabs box items

default	no
referencia	naveg

Ao acessar o novo menu criado, abre-se uma nova tela.

Nessa nova tela, serão exibidos os funcionários que tiveram evento S-1210 transmitidos ao governo no ano anterior ao ano informado no parâmetro Ano Retificação que deve ser informado.

No parâmetro Ano Retificação, deve ser informado o ano que que será gerado o evento S-1210 com retificação de períodos anteriores, por exemplo ao informar Ano Retificação 2026, serão listados funcionários que tiveram evento S-1210 transmitidos ao governo no ano de 2025 que possuam informações complementares (dedução dependente, pensão alimentícia, previdência privada ou despesas médicas/reembolsos) e que seja necessário fazer a retificação em Janeiro de 2026 no bloco <perAnt> conforme prevê o leiaute S-1.3.

O parâmetro CPF é opcional.

O botão aplicar filtros só ficará habilitado após informar o parâmetro Ano Retificação que deve ser no formado de 4 dígitos e maior ou igual a 2026 conforme o exemplo abaixo:

Na lista são apresentadas as colunas CPF, Nome, Tipo, Meses retificados/a Retificar em XXXX e o botão Editar que será detalhado mais abaixo neste documento.

Em relação ao campo Tipo, possui as descrições:

Funcionário - Somente funcionário ;

Funcionário/Prestador - Funcionário e prestador com registro no programa FP2160;

Prestador - Prestador com registro no programa FP2160;

Prestador - Outros Sistemas - Prestador integrado de outros sistemas ou módulos, por exemplo BackOffice.

Para esses casos, só será possível consultar os meses a serem retificados tendo em vista que dessa definição deve ser feita no programa CD2014.

Exemplo informando os parâmetros Ano Retificação e CPF:

No botão Filtros Avançados é possível informar o Estabelecimento além do Ano Retificação e CPF, porém o Ano Retificação é obrigatório.

Para cada registro da lista de funcionários está disponível o botão Editar, com ícone de um lápis, onde será possível informar quais meses serão retificados.

Ao clicar no botão Editar, a tela abaixo é apresentada

Estarão habilitados somente os meses em que o funcionário possui evento S-1210 transmitido ao governo.

Totvs custom tabs box items

default	no
referencia	dicionario

Totvs custom tabs box items

default	no
referencia	tech

Informações Técnicas da API

Este detalhamento tem como objetivo registrar os endpoints da interface da integração da tela desenvolvida utilizando PO-UI.

Deck of Cards

id	IntegracaoAhgora

Card

id	IntegAhgoraLista
label	Integração Funcionário

Objetivo: Busca dos dados para listagem dos funcionários e envio dos funcionários selecionados para o back-end.

Tipo de requisição: GET/PUT

Endpoint: /api/rh/v1/RefificaPerAnt

Get:

Query Params:

Nome	Descrição	Tipo	Obrigatório	Exemplo
page	Número da página	number	Sim	1
pageSize	Tamanho da página	number	Sim	20
yearRectif	Ano retificação	number	Sim	Maior ou igual a 2026
registrationNumber	CPF	number	Não	59303411099
branchCode	Filial (Multi Valores separados por vírgula)	string	Não	“D MG 01,D MG 02”

Estrutura de Retorno:

Campo	Tipo	Exemplo
id (obrigatório)	string	"2026-59303411099"
yearRectif(obrigatório)	number	2026
companyCode	string	"1"
branchCode(obrigatório)	string	“02”
type	string	"Funcionário" ou "Prestador" ou "Funcionário/Prestador"
registrationNumber	string	"59303411099"
name	string	"Nome do funcionário"
enableMonths	array	[1,5,6,7,9,12]
Months	array	[5,9,12]

Exemplo de Requisição:

GET: api/rh/v1/RefificaPerAnt?page=1&pageSize=20&yearRectif=2026

Se atentar com a paginação.

Expandir

title	Exemplo de retorno

{
"items": [
{
"id": "2026-59303411099",
"yearRectif": 2026,

"companyCode": "1",
"branchCode": "1",
"type": "Funcionário",
"registrationNumber": "59303411099",
"name": "Admitido Antes da Retificação e Ativo",
"enableMonths": [
1,
2,
3,
6,
7,
8,
10,
11
],
"months": [
3,
6,
7,
8,
10,
11
]
},
{
"id": "2026-59429296027",
"yearRectif": 2026,

"companyCode": "1",
"branchCode": "1",
"type": "Funcionário",
"registrationNumber": "59429296027",
"name": "teste paginacao 8",
"enableMonths": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"months": [
3,
5
]
}
],
"hasNext": false,
"total": 2
}

PUT: /api/rh/v1/RefificaPerAnt

Nome	Descrição	Tipo	Obrigatório	Exemplo
id (obrigatório)	Código interno do funcionário	string	Sim	"2026-59303411099"
companyCode	Empresa ou Coligada	string	Sim	"10"
branchCode	Estabelecimento ou Filial	string	Sim	"1"
months	Meses retificados	array	Sim	[1,3,5,9,12]

A partir do filtro realizado, ao clicar editar e confirmar, os dados serão enviados para o back-end.

Expandir

title	Exemplo do post

{
"items":
[
{
"id":"2026-59303411099",
"companyCode":"10",

"branchCode":"11",
"months":[1,2,6,8,12]

}
]
}

Para o retorno de erro, seguir a estrutura abaixo.

Campo	Tipo
code	number
message	string
detailedMessage	string
type	string (“error”, “warning”, “success”)

Expandir

title	Exemplo de retorno

{
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
}

Totvs custom tabs box items

default	no
referencia	doc

Totvs custom tabs box items

default	no
referencia	vídeos

Cloak

id	How To \| MP - SIGAGPE integração com a Ahgora

Cloak

id	How To \| PW - Ponto Web Ahgora integração com Protheus SIGAGPE

...

Árvore de páginas

Versões comparadas

Versão antiga 16

Nova versão 17

Chave

Informações Técnicas da API