...
Lembrando que, será a partir dos patches:
- 12.1.2410.xxx
- 12.1.2502.xxx
- 12.1.2506 e superiores
03. SITUAÇÃO/REQUISITO
...
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. |
| cnpjList | String | Sim | CNPJ(s) da(s) Coligada(s) que serão consultadas na base do RM |
| Nota |
|---|
|
O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca das verbas, seu REST no RM 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. |
| Informações |
|---|
|
Autenticação Basic: Enviar usuário e senha do RM no header da requisição. |
...
| Deck of Cards |
|---|
| startHidden | false |
|---|
| id | retorno |
|---|
|
| Card |
|---|
| default | true |
|---|
| id | 200ok |
|---|
| label | 200 - OK |
|---|
| title | Sucesso |
|---|
| | Propriedades API | Descrição |
|---|
| cod | Código da Verba - PEVENTO.CODIGO | | desc | Descrição da Verba - PEVENTO.DESCRICAO | | cnpj | CNPJ da Coligada- GCOLIGADA.CGC | | categoria | Provento - Hora ou Dia; Desconto - Hora ou Dia; Base de Cálculo - Hora ou Dia; - PEVENTO.PROVDESCBASE e PEVENTO.VALHORDIAREF |
Será retornado uma lista com as verbas referente ao CNPJ da filial coligada que foi enviado na requisição e caso tenha algum erro será enviado no array de erros dentro do response. | Bloco de código |
|---|
| language | cppjs |
|---|
| theme | Confluence |
|---|
| title | Operação realizada com sucesso! |
|---|
| linenumbers | true |
|---|
| {
"response": [
{
"erros": [
{
{
"mensagem": "Coligada não existe.",
"cnpjmensagem": "1A05.23B295.45C401/678D0001-9030",
},
{
"mensagemcnpj": "Necessário ativar a integração.",
"cnpj": "1F.CFB.57C/9FG4-89"
},
],
"items": [
{
"cod": "002",
"descmensagem": "PERICULOSIDADE07.363.764/0001-90",
"cnpj": "14.689.130/0001-98",
"categoriacnpj": "ProventoColigada -não Horaexiste."
},
{}
"cod": "080" ],
"desc": "PERIC. FERIAS AVISO",
"cnpj"items": "14.689.130/0001-98",[
"categoria": "Provento - Hora"
},
{
"cod": "419",
"desccod": "Faltas0001",
"cnpj": "82.714.573/0001-41",
"categoriadesc": "DescontoHORAS -NORMAIS Dia"
},
{2",
"cod": "759",
"desccnpj": "H07.E. DIA DSR577.599/0001-70",
"cnpj": "82.714.573/0001-41",
"categoria": "Base de Cálculo - Provento-Hora"
}
]},
"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 | Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | Operação realizada com sucesso! |
|---|
| {
"response": [
{
"erros": [],
"itemscod": ["0002",
{
"coddesc": "002DIAS TRABALHADOS2",
"desc": "PERICULOSIDADE",
"cnpj": "8207.714577.573599/0001-4170",
"categoria": "Provento - Hora"
},"categoria": "Provento-Dia"
{
},
"cod": "080",
"desc": "PERIC. FERIAS AVISO",{
"cnpj": "82.714.573/0001-41",
"categoriacod": "Provento - Hora0003",
},
....
{
"coddesc": "460INSS2",
"desc": "HS. NAO COMPENSADAS",
"cnpj": "8207.714577.573599/0001-4170",
"categoria": "Desconto - Hora"
},
{
"cod"categoria": "759Desconto-Valor",
"desc": "H.E. DIA DSR", }
"cnpj": "82.714.573/0001-41",
],
"categoriahasNext": "Base de Cálculo - Hora"true
}
],
"hasNext": true
}
]
}
} |
| Informações |
|---|
| Caso o número de itens ultrapasse o limite da página, o campo hasNext será retornado como true, indicando que há mais dados a serem requisitados.
O recomendável é solicitar 500 itens por página. |
|
| Card |
|---|
| id | 400bas |
|---|
| label | 400 - Solicitação inválida |
|---|
| title | Body |
|---|
| Verificar se todos os parâmetros foram passados na requisição | Bloco de código |
|---|
| language | cppjs |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| {
"code": 400"FE016",
"message": "Necessário enviar o page, pageSize e cnpjList na requisição""O campo CnpjList é obrigatório.\r\n",
"detailedMessage": "",
"helpUrl": "",
"details": null
} |
|
|
05. DEMAIS INFORMAÇÕES
