Este método é responsável por enviar uma lista de verbas da tabela SRV do Protheus. - Endpoint: api/rh/v1/ahgora/verbas?page=1&pageSize=500
- Método: GET
- Autenticação: Basic
Parâmetros de Consulta| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
page | Numérico | Sim | Número da página a ser consultada (inicia em 1). | pageSize | Numérico | Sim | Quantidade de registros por página. |
O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca das verbas, seu REST no protheus deve permitir esse acesso externo. Configurações de porta no firewall, IP público, DNS e redirecionamento de portas devem ser verificadas junto com o seu time de TI/Redes. |
| Autenticação Basic: Enviar usuário e senha do Protheus no header da requisição. |
Enviar os CNPJs no body da requisição conforme estrutura abaixo: {
"items": [
"1A.23B.45C/678D-90",
"14.689.130/0001-98",
"82.714.573/0001-41",
"73.612.881/0001-75"
]
} |
|
Retorno | Propriedades API | Descrição |
|---|
| cod | Código da Verba - RV_COD | | desc | Descrição da Verba - RV_DESC | | cnpj | CNPJ da filial - MO_CGC | | categoria | Provento, Desconto ou Base de Cálculo - RV_TIPOCOD |
Será retornado uma lista com as verbas referente ao CNPJ da filial que foi enviado na requisição {
"response": [
{
"items": [
{
"cod": "002",
"desc": "PERICULOSIDADE",
"cnpj": "14.689.130/0001-98",
"categoria": "Provento"
},
{
"cod": "080",
"desc": "PERIC. FERIAS AVISO",
"cnpj": "14.689.130/0001-98",
"categoria": "Provento"
},
{
"cod": "460",
"desc": "HS. NAO COMPENSADAS",
"cnpj": "82.714.573/0001-41",
"categoria": "Desconto"
},
{
"cod": "759",
"desc": "H.E. DIA DSR",
"cnpj": "82.714.573/0001-41",
"categoria": "Base de Cálculo"
}
],
"hasNext": false
}
]
} |
Caso ultrapasse a paginação que é 500 items por página, será enviado o hasNext com true, para prosseguir com a requisição {
"response": [
{
"items": [
{
"cod": "002",
"desc": "PERICULOSIDADE",
"cnpj": "82.714.573/0001-41",
"categoria": "Provento"
},
{
"cod": "080",
"desc": "PERIC. FERIAS AVISO",
"cnpj": "82.714.573/0001-41",
"categoria": "Provento"
},
....
{
"cod": "460",
"desc": "HS. NAO COMPENSADAS",
"cnpj": "82.714.573/0001-41",
"categoria": "Desconto"
},
{
"cod": "759",
"desc": "H.E. DIA DSR",
"cnpj": "82.714.573/0001-41",
"categoria": "Base de Cálculo"
}
],
"hasNext": true
}
]
} |
|
Necessário enviar o body com os CNPJ na requisição {
"code": 400,
"message": "Não foi enviado nenhum CNPJ na requisição para busca das verbas"
} |
Verificar se os CNPJS enviados são os mesmo que constam cadastrados nas filiais dentro do SIGAMAT no Protheus {
"code": 400,
"message": "Nenhum CNPJ foi encontrado na base de dados"
} |
Verificar se o usuário da requisição possuí acesso a empresa e filial vinculada ao CNPJ que foi passado {
"code": 400,
"message": "Não foi possível abrir a empresa: 02 - Verifique se o usuário possuí acesso a empresa vinculada ao CNPJ: 73612881000175"
} |
|
|
|
Este método é responsável por enviar uma lista de sindicatos da tabela RCE do Protheus. - Endpoint: api/rh/v1/ahgora/sindicatos?page=1&pageSize=500
- Método: GET
- Autenticação: Basic
Parâmetros de Consulta| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
page | Numérico | Sim | Número da página a ser consultada (inicia em 1). | pageSize | Numérico | Sim | Quantidade de registros por página. |
O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca dos sindicatos, seu REST no protheus deve permitir esse acesso externo. Configurações de porta no firewall, IP público, DNS e redirecionamento de portas devem ser verificadas junto com o seu time de TI/Redes. |
| Autenticação Basic: Enviar usuário e senha do Protheus no header da requisição. |
Enviar os CNPJs no body da requisição conforme estrutura abaixo: {
"items": [
"1A.23B.45C/678D-90",
"14.689.130/0001-98",
"82.714.573/0001-41",
"73.612.881/0001-75"
]
} |
|
Retorno | Propriedades API | Descrição |
|---|
| cod | Código do Sindicato - RCE_CODIGO | | desc | Descrição do Sindicato - RCE_DESCRI | | cnpj | CNPJ da filial - MO_CGC |
Será retornado uma lista com os sindicatos referente ao CNPJ da filial que foi enviado na requisição {
"response": [
{
"items": [
{
"cod": "00",
"desc": "SIND MEDIAS",
"cnpj": "53.113.791/0001-22"
},
{
"cod": "01",
"desc": "SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",
"cnpj": "14.689.130/0001-98",
},
{
"cod": "51",
"desc": "SIND INTER EMP INST BEN RELIG FIL EST SP",
"cnpj": "14.689.130/0001-98",
},
{
"cod": "52",
"desc": "SIND EMP TURE HOSP PIRACICABA E REGIAO",
"cnpj": "82.714.573/0001-41",
},
{
"cod": "53",
"desc": "SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
"cnpj": "82.714.573/0001-41",
},
{
"cod": "01",
"desc": "S001",
"cnpj": "82.714.573/0001-41",
}
],
"hasNext": false
}
]
} |
Caso ultrapasse a paginação que é 500 items por página, será enviado o hasNext com true, para prosseguir com a requisição {
"response": [
{
"items": [
{
"cod": "00",
"desc": "SIND MEDIAS",
"cnpj": "53.113.791/0001-22"
},
{
"cod": "01",
"desc": "SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",
"cnpj": "14.689.130/0001-98",
},
{
"cod": "51",
"desc": "SIND INTER EMP INST BEN RELIG FIL EST SP",
"cnpj": "14.689.130/0001-98",
},
....
{
"cod": "52",
"desc": "SIND EMP TURE HOSP PIRACICABA E REGIAO",
"cnpj": "82.714.573/0001-41",
},
{
"cod": "53",
"desc": "SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
"cnpj": "82.714.573/0001-41",
},
{
"cod": "01",
"desc": "S001",
"cnpj": "82.714.573/0001-41",
}
],
"hasNext": true
}
]
} |
|
Necessário enviar o body com os CNPJ na requisição {
"code": 400,
"message": "Não foi enviado nenhum CNPJ na requisição para busca dos sindicatos"
} |
Verificar se os CNPJS enviados são os mesmo que constam cadastrados nas filiais dentro do SIGAMAT no Protheus {
"code": 400,
"message": "Nenhum CNPJ foi encontrado na base de dados"
} |
Verificar se o usuário da requisição possuí acesso a empresa e filial vinculada ao CNPJ que foi passado {
"code": 400,
"message": "Não foi possível abrir a empresa: 02 - Verifique se o usuário possuí acesso a empresa vinculada ao CNPJ: 73612881000175"
} |
|
|
|
|