Skip to main content
PUT
/
vacation_pay_settings
/
{vacation_pay_setting}
Update a vacation pay setting
curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/vacation_pay_settings/{vacation_pay_setting} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "effective_to": "2026-12-31"
}
'
{
  "id": "<id>",
  "object": "vacation_pay_setting",
  "data": {
    "percentage": 4,
    "vacation_pay_method": "manual",
    "effective_from": "2026-01-01",
    "effective_to": "2026-12-31",
    "earliest_valid_effective_to": "2026-01-01",
    "is_editable": true,
    "is_deletable": true,
    "work_assignment": {
      "id": "<id>",
      "object": "work_assignment",
      "links": {
        "self": "/work_assignments/<id>"
      }
    },
    "note": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/vacation_pay_settings/<id>"
  }
}

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

​
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