Vacation Pay Settings

Update a vacation pay setting

Changed on
put/vacation_pay_settings/{vacation_pay_setting}

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Path parameters

vacation_pay_settingstring required

Request body

effective_fromstring date

Editing is prevented when is_editable is false

effective_tostring date
percentagenumber

Editing is prevented when is_editable is false

Up to 2 decimal places.

vacation_pay_method'manual' | 'per_period'

Editing is prevented when is_editable is false

business_preset_idstring

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.

notestring nullable

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status