Skip to main content
POST
Create a vacation pay setting

Authorizations

Authorization
string
header
required

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

Body

application/json
work_assignment_id
string
required
effective_from
string<date>
required
percentage
number<decimal>
required
Required range: 0 <= x <= 100
effective_to
string<date>
vacation_pay_method
enum<string>
Available options:
manual,
per_period
overrides
object[]
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

201 - application/json

Created

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