NMnmbr
Pay Rates

Update a pay rate

put/pay_rates/{pay_rate}

Request

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

Path parameters

pay_ratestring required

Request body

business_preset_idstring
titlestring nullable
type'hourly' | 'salary'

Whether this is a salary or hourly pay rate. Determines how rate is interpreted.

Editing is prevented when is_editable is false

ratenumber

The annual salary when type is salary, or the hourly wage when type is hourly.

For salary pay rates, rate is the annual salary (i.e. amount per year). For wage pay rates, rate is the hourly wage (i.e. amount per hour).

Editing is prevented when is_editable is false

Up to 2 decimal places.

expected_hours_per_weeknumber

The expected number of working hours per week. Must be greater than 0 for salary pay rates. Used to calculate the equivalent hourly rate from salaries for overtime.

For salary pay rates, expected_hours_per_week must be greater than 0.

Editing is prevented when is_editable is false

Up to 2 decimal places.

effective_fromstring date

The date from which this pay rate is applied to Pay Stubs.

Editing is prevented when is_editable is false

effective_tostring

The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. null if the pay rate applies indefinitely.

The date must be after the period_end of the most recent non-draft payroll.

expense_accounting_code_idstring
liability_accounting_code_idstring
external_refstring

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes

No recorded changes to this operation across all 54 revisions of this API.