Objetivo: Busca dos dados para listagem dos funcionários e envio dos funcionários selecionados para o back-end.
Tipo de requisição: GET/POST 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. {
"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
} |
Post: /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. {
"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”) |
{
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
|