Skip to main content
PUT
Update a vacation pay setting

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vacation_pay_setting
string
required

Body

application/json
effective_from
string<date>

Editing is prevented when is_editable is false

effective_to
string<date>
percentage
number<decimal>

Editing is prevented when is_editable is false

Required range: 0 <= x <= 100
vacation_pay_method
enum<string>

Editing is prevented when is_editable is false

Available options:
manual,
per_period
overrides
object[]

Editing is prevented when is_editable is false

business_preset_id
string

The Business Preset to create the vacation payout line item from. Must be an earning preset under the work assignment's business entity, carrying either no subtype or the vacation_pay subtype. Omit it, or send null, to create the payout without a preset. A preset named here cannot be deleted while the setting still refers to it.

note
string | null

Response

200 - application/json

OK

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

The type of the object in Nmbr ("vacation_pay_setting").

data
Vacation Pay Setting · object