Skip to main content
GET
/
vacation_pay_settings
/
{vacation_pay_setting}
Retrieve a vacation pay setting
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/vacation_pay_settings/{vacation_pay_setting} \
  --header 'Authorization: Bearer <token>'
{
  "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": 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

Query Parameters

expand
enum<string>[]
Available options:
work_assignment

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
Default · object