Este detalhamento tem como objetivo registrar os endpoints da interface da integração da tela desenvolvida utilizando PO-UI.
| Deck of Cards |
|---|
| | 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/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. | Expandir |
|---|
| {
"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. | Expandir |
|---|
| {
"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 |
|---|
| {
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
| | Card |
|---|
| | Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | filtros |
|---|
| | Deck of Cards |
|---|
| | Card |
|---|
| Objetivo: Listagem de Filiais Tipo de requisição: GET Endpoint: /api/rh/v1/ahgora/branches Query Params: Campo | Descrição | Tipo | Obrigatório | Exemplo | page | Número da página | number | SIM | 1 | pageSize | Tamanho da página | numer | SIM | 50 | filter | Campo automático do lookup. Pode filtrar o código ou nome da filial | string | Não | “Filial X” |
Estrutura de Retorno: Para conseguirmos abranger todas as áreas, utilizamos a nomenclatura abaixo. Campo | Tipo | branchCode | string | branchName | string |
Exemplo de Requisição: GET: api/rh/v1/ahgora/branches?filter=&page=1&pageSize=50 | Expandir |
|---|
| {
"items": [
{
"branchCode": "01",
"branchName": "Matriz"
},
{
"branchCode": "02",
"branchName": "Suporte-Suporte"
},
{
"branchCode": "03",
"branchName": "Santos"
},
{
"branchCode": "04",
"branchName": "São Vicente"
}
],
"hasNext": false
} |
É possível também digitar no campo sem entrar no lookup para buscar uma filial. Get: api/rh/v1/ahgora/branches/01 | Expandir |
|---|
| {
"items": [
{
"branchCode": "01",
"branchName": "Matriz"
}
]
} |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
| Expandir |
|---|
| {
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
| Card |
|---|
| id | matricula |
|---|
| label | Matrícula |
|---|
| Objetivo: Listagem das Matrículas Tipo de requisição: GET Endpoint: /api/rh/v1/ahgora/matricula Query Params: Campo | Descrição | Tipo | Obrigatório | Exemplo | page | Número da página | number | SIM | 1 | pageSize | Tamanho da página | numer | SIM | 50 | filter | Campo automático do lookup. Pode filtrar a matrícula | string | Não | “Matrícula X” | branchCode | Código da filial que está no filtro | string | Não | 04 |
Obs* O filtro da filial é obrigatório, ele vai estar no filtro da matrícula caso queira retornar apenas as matrículas das filiais selecionadas. Estrutura de Retorno: Para conseguirmos abranger todas as áreas, utilizamos a nomenclatura abaixo. Campo | Tipo | branchCode | string | branchName | string |
Exemplo de Requisição: GET: api/rh/v1/ahgora/matricula?filter=&page=1&pageSize=50&branchCode=04 | Expandir |
|---|
| Como passei a filial 04 que está no filtro, optei por carregar apenas matrículas dessa filial {
"items": [
{
"filMat": "04",
"matCode": "000001",
"matName": "John Doe"
},
{
"filMat": "04",
"matCode": "152062",
"matName": "Jane Doe"
}
],
"hasNext": false
} |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
| Expandir |
|---|
| {
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
| Card |
|---|
| Objetivo: Listagem dos Turnos Tipo de requisição: GET Endpoint: /api/rh/v1/ahgora/turno Query Params: Campo | Descrição | Tipo | Obrigatório | Exemplo | page | Número da página | number | SIM | 1 | pageSize | Tamanho da página | numer | SIM | 50 | filter | Campo automático do lookup. Pode filtrar o turno | string | Não | “Turno X” | branchCode | Código da filial que está no filtro | string | Não | 02 |
Obs* O filtro da filial é obrigatório, ele vai estar no filtro do turno caso queira retornar apenas os turnos das filiais selecionadas. Estrutura de Retorno: Campo | Tipo | filTurno | string | turnoCode | string | turnoDesc | string |
Exemplo de Requisição: GET: api/rh/v1/ahgora/turno?filter=&page=1&pageSize=50&branchCode=02 | Expandir |
|---|
| Como passei a filial 02 que está no filtro, optei por carregar apenas os turnos dessa filial {
"items": [
{
"filTurno": "02",
"turnoCode": "001",
"turnoDesc": "001"
}
],
"hasNext": false
} |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
| Expandir |
|---|
| {
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
| Card |
|---|
| id | ccusto |
|---|
| label | Centro de Custo |
|---|
| Objetivo: Listagem dos Centros de Custo Tipo de requisição: GET Endpoint: /api/rh/v1/ahgora/ccusto Query Params: Campo | Descrição | Tipo | Obrigatório | Exemplo | page | Número da página | number | SIM | 1 | pageSize | Tamanho da página | numer | SIM | 50 | filter | Campo automático do lookup. Pode filtrar o C.Custo | string | Não | “CCusto X” | branchCode | Código da filial que está no filtro | string | Não | 02 |
Obs* O filtro da filial é obrigatório, ele vai estar no filtro do centro de custo caso queira retornar apenas os centros de custo das filiais selecionadas. Estrutura de Retorno: Campo | Tipo | filCC | string | codCC | string | ccDesc | string |
Exemplo de Requisição: GET: api/rh/v1/ahgora/ccusto?filter=&page=1&pageSize=10&branchCode=02 | Expandir |
|---|
| Como a tabela de Centro de Custo é compartilhada, mesmo com a filial, eu retorno todos {
"items": [
{
"filCC": " ",
"codCC": "000000003",
"ccDesc": "03"
},
{
"filCC": " ",
"codCC": "000000010",
"ccDesc": "010"
},
{
"filCC": " ",
"codCC": "000000022",
"ccDesc": "22"
},
{
"filCC": " ",
"codCC": "00001 ",
"ccDesc": "TESTE TITULO"
},
{
"filCC": " ",
"codCC": "012 ",
"ccDesc": "CONC 012"
}
],
"hasNext": true
} |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
| Expandir |
|---|
| {
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
| Card |
|---|
| Objetivo: Listagem das Funções Tipo de requisição: GET Endpoint: /api/rh/v1/ahgora/funcao Query Params: Campo | Descrição | Tipo | Obrigatório | Exemplo | page | Número da página | number | SIM | 1 | pageSize | Tamanho da página | numer | SIM | 50 | filter | Campo automático do lookup. Pode filtrar o C.Custo | string | Não | “Funcao X” | branchCode | Código da filial que está no filtro | string | Não | 02 |
Obs* O filtro da filial é obrigatório, ele vai estar no filtro da função caso queira retornar apenas as funções das filiais selecionadas. Estrutura de Retorno: Campo | Tipo | filFuncao | string | codFuncao | string | funcaoDesc | string |
Exemplo de Requisição: GET: api/rh/v1/ahgora/funcao?filter=&page=1&pageSize=10&branchCode=02 | Expandir |
|---|
| Como passei a filial 02 que está no filtro, optei por carregar apenas as funções dessa filial {
"items": [
{
"filFuncao": "02",
"codFuncao": "00001",
"funcaoDesc": "CP038"
},
{
"filFuncao": "02",
"codFuncao": "00002",
"funcaoDesc": "65456"
}
],
"hasNext": false
} |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
| Expandir |
|---|
| {
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
| Card |
|---|
| Objetivo: Listagem dos Departamentos Tipo de requisição: GET Endpoint: /api/rh/v1/ahgora/departamento Query Params: Campo | Descrição | Tipo | Obrigatório | Exemplo | page | Número da página | number | SIM | 1 | pageSize | Tamanho da página | numer | SIM | 50 | filter | Campo automático do lookup. Pode filtrar o C.Custo | string | Não | “Departamento X” | branchCode | Código da filial que está no filtro | string | Não | 02 |
Obs* O filtro da filial é obrigatório, ele vai estar no filtro da função caso queira retornar apenas os departamentos das filiais selecionadas. Estrutura de Retorno: Campo | Tipo | filDepto | string | codDepto | string | deptoDesc | string |
Exemplo de Requisição: GET: api/rh/v1/ahgora/departamento?filter=&page=1&pageSize=10&branchCode=02 | Expandir |
|---|
| Como passei a filial 02 que está no filtro, optei por carregar apenas os departamentos dessa filial {
"items": [
{
"filDepto": "02",
"codDepto": "000000060",
"deptoDesc": "DEP MAT 002042"
},
{
"filDepto": "02",
"codDepto": "000000061",
"deptoDesc": "DEP DELETADO"
},
{
"filDepto": "02",
"codDepto": "0002 ",
"deptoDesc": "Depto Vendas"
}
],
"hasNext": false
} |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
| Expandir |
|---|
| {
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
| Card |
|---|
| id | sitcateg |
|---|
| label | Situação/Categoria |
|---|
| Objetivo: Listagem da situação do funcionário e categoria Tipo de requisição: GET Endpoint: /api/rh/v1/ahgora/opcoes Obs* Sempre será retornado os dois conjuntos de dados na requisição, após a primeira requisição, os dois conjuntos ficaram em memória para consulta; Estrutura de Retorno: Para o retorno, utilizamos a forma abaixo. Campo | Tipo | label | string | value | string |
Exemplo de Requisição: GET: /api/rh/v1/ahgora/opcoes O retorno precisa ser uma lista com a propriedade 'items', com os dois arrays 'SitOptions' para a situação e 'catOptions' para as categorias. | Expandir |
|---|
| {
"items": {
"sitOptions": [
{
"value": "N",
"label": "SITUACAO NORMAL"
},
{
"value": "A",
"label": "AFASTADO TEMP."
},
{
"value": "D",
"label": "DEMITIDO"
},
{
"value": "F",
"label": "FERIAS"
}
],
"catOptions": [
{
"value": "A",
"label": "AUTONOMO"
},
{
"value": "C",
"label": "COMISSIONADO"
},
{
"value": "D",
"label": "DIARISTA"
},
{
"value": "E",
"label": "ESTAGIARIO MENSALISTA"
},
{
"value": "M",
"label": "MENSALISTA"
}
]
}
} |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
| Expandir |
|---|
| {
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
|
|
