...
| Informações |
|---|
|
Autenticação Basic: Enviar usuário e senha do Protheus 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 filial - 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 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 | cpp |
|---|
| theme | Confluence |
|---|
| title | Operação realizada com sucesso! |
|---|
| {
"response": [
{
"erros": [
{
"mensagem": "CNPJ não encontrado na base de dados",
"cnpj": "1A.23B.45C/678D-90"
},
{
"mensagem": "CNPJ não encontrado na base de dados",
"cnpj": "1F.CFB.57C/9FG4-89"
},
{
"mensagem": "Não foi possível abrir a empresa: 02 - Verifique se o usuário possuí acesso a filial vinculada ao CNPJ: 49342767000198",
"cnpj": "49.342.767/0001-98"
},
{
"mensagem": "Não existe cadastro de verbas para o CNPJ",
"cnpj": "53.113.791/0012-85"
}
],
"items": [
{
"cod": "002",
"desc": "PERICULOSIDADE",
"cnpj": "14.689.130/0001-98",
"categoria": "Provento - Hora"
},
{
"cod": "080",
"desc": "PERIC. FERIAS AVISO",
"cnpj": "14.689.130/0001-98",
"categoria": "Provento - Hora"
},
{
"cod": "419",
"desc": "Faltas",
"cnpj": "82.714.573/0001-41",
"categoria": "Desconto - Dia"
},
{
"cod": "759",
"desc": "H.E. DIA DSR",
"cnpj": "82.714.573/0001-41",
"categoria": "Base de Cálculo - 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": [],
"items": [
{
"cod": "002",
"desc": "PERICULOSIDADE",
"cnpj": "82.714.573/0001-41",
"categoria": "Provento - Hora"
},
{
"cod": "080",
"desc": "PERIC. FERIAS AVISO",
"cnpj": "82.714.573/0001-41",
"categoria": "Provento - Hora"
},
....
{
"cod": "460",
"desc": "HS. NAO COMPENSADAS",
"cnpj": "82.714.573/0001-41",
"categoria": "Desconto - Hora"
},
{
"cod": "759",
"desc": "H.E. DIA DSR",
"cnpj": "82.714.573/0001-41",
"categoria": "Base de Cálculo - Hora"
}
],
"hasNext": true
}
]
} |
|
| 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 | cpp |
|---|
| theme | Confluence |
|---|
| {
"code": 400,
"message": "Necessário enviar o page, pageSize e cnpjList na requisição""
} |
|
|
Colocar mais detalhes semelhante ao TDN do Protheus : DT Integração Ahgora - API Verbas e Sindicatos
...
