Skip to main content
GET
/
payment-sheet
/
parameter
Busca parâmetros de folha de pagamento
curl --request GET \
  --url https://api.example.com/payment-sheet/parameter
{
  "pagina": 0,
  "total": 5,
  "unidades": [
    {
      "id": "123-abc",
      "code": 1,
      "name": "Keevo NG Folha",
      "source": "Keevo",
      "isActive": true,
      "createdAt": "2023-07-23T00:00:00.000Z",
      "updatedAt": "2023-07-23T00:00:00.000Z",
      "businessUnit": {
        "id": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "name": "Tron",
        "documentNumber": "15621118054",
        "logo": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg"
      },
      "fields": [
        {
          "systemEvent": "OT_STANDARD_50_PERCENT",
          "eventId": "123-abc",
          "eventCode": "250087",
          "description": "Keevo NG Folha",
          "isActive": true,
          "advancedPercentage": 0.5
        }
      ],
      "automation": [
        {
          "name": "Departamento X",
          "type": "DEPARTMENT",
          "departmentId": "123-abc",
          "businessUnitId": "123-abc",
          "punchRuleId": "123-abc"
        }
      ]
    }
  ],
  "limite": 10
}

Query Parameters

searchText
string

Texto pesquisado para filtrar consulta

pagina
number

Página que deseja retornar os resultados

Example:

0

limite
number

Quantidade de itens que retorna na consulta. Min 1 - Max 100

Example:

100

source
string

Nome da fonte do parâmetro de folha de pagamento (busca exata)

Example:

"Keevo"

businessUnitId
string

ID da unidade de negócio

Example:

"123-456abc"

Response

Parâmetros de folha de pagamento

pagina
number
required

Pagina retornada dos dados

Example:

0

total
number
required

Quantidade total de unidades para consultar

Example:

5

unidades
object[]
required

Resultado da consulta

limite
number

Quantidade de itens retornados na consulta

Example:

10