Skip to main content
POST
/
vacation_pay_settings
Create a vacation pay setting
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/vacation_pay_settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "work_assignment_id": "<id>",
  "effective_from": "2026-01-01",
  "percentage": 4,
  "vacation_pay_method": "manual",
  "note": "Vacation Pay",
  "overrides": [
    {
      "type": "earning",
      "subtype": "commission",
      "percentage": 3,
      "method": "per_period"
    }
  ]
}
'
{
  "id": "<id>",
  "object": "vacation_pay_setting",
  "data": {
    "percentage": 4,
    "vacation_pay_method": "manual",
    "effective_from": "2026-01-01",
    "effective_to": null,
    "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": "Vacation Pay",
    "overrides": [
      {
        "type": "earning",
        "subtype": "commission",
        "percentage": "3",
        "method": "per_period"
      }
    ],
    "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.

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[]
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