Skip to main content
POST
/
payment-sheet
/
parameter
Cria um parâmetro de folha de pagamento
curl --request POST \
  --url https://api.example.com/payment-sheet/parameter \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Keevo NG Folha",
  "source": "Keevo"
}
'
{
  "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"
    }
  ]
}

Body

application/json

Dados do parâmetro

​
name
string
required

Nome do parâmetro de folha de pagamento

Example:

"Keevo NG Folha"

​
source
enum<string>
default:Keevo
required

Fonte do parâmetro de folha de pagamento

Available options:
Keevo,
OneFlow,
Tron,
Outro
​
sourceName
string

Nome da fonte do parâmetro de folha de pagamento, para o caso de uma fonte desconhecida (Outro)

Example:

"Folha TMNT Dev Team"

​
businessUnitId
string

ID da unidade de negócio, para o caso de uma fonte OneFlow

Example:

"123-456abc"

​
fields
object[]

Campos do parâmetro de folha de pagamento

Response

Parâmetro criado

​
id
string
required

Id do parâmetro de folha de pagamento

Example:

"123-abc"

​
code
number
required

Código numérico do parâmetro de folha de pagamento

Example:

1

​
name
string
required

Nome do parâmetro de folha de pagamento

Example:

"Keevo NG Folha"

​
source
string
required

Fonte do parâmetro de folha de pagamento

Example:

"Keevo"

​
isActive
boolean
required

Indica se o parâmetro de folha de pagamento está ativo

Example:

true

​
createdAt
string<date-time>
required

Data de criação do parâmetro de folha de pagamento

Example:

"2023-07-23T00:00:00.000Z"

​
updatedAt
string<date-time>
required

Data de atualização do parâmetro de folha de pagamento

Example:

"2023-07-23T00:00:00.000Z"

​
businessUnit
object

Unidade de negócio do parâmetro de folha de pagamento

​
fields
object[]

Campos do parâmetro de folha de pagamento

​
automation
object[]

Vínculos de automação do parâmetro de folha de pagamento