Update an overtime rate

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

overtime_rate

string

required

Body

application/json

rate_multiplier

number<decimal>

The multiplier for this overtime, e.g 1.5 or 2.

Editing is prevented when is_editable is false

Required range: 0 <= x <= 100

hourly_rate_override

number<decimal>

If set, this amount is used for the hourly rate, not the calculated amount from the rate_multiplier.

Editing is prevented when is_editable is false

Required range: 0 <= x <= 99999

business_preset_id

string

expense_accounting_code_id

string

liability_accounting_code_id

string

archived_at

string<date>

external_ref

string

Maximum string length: 255

tag_assignment

object

Hide child attributes

tag_assignment.unit

enum<string>

Available options:

percentage

tag_assignment.is_component_locked

boolean

tag_assignment.tag_allocations

object[]

Hide child attributes

tag_assignment.tag_allocations.tags

string[]

tag_assignment.tag_allocations.value

number<decimal>

Required range: x >= 0

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Overtime Rate · object

Hide child attributes

data.pay_rate

object

Hide child attributes

data.pay_rate.id

string

read-only

The unique identifier of the object in Nmbr.

data.pay_rate.object

string

read-only

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

data.title

string | null

data.title_translated

string

read-only

The translation of the title property for the request locale. Computed using the values in title and title_translations and the value of the request's Accept-Language header.

data.rate_multiplier

number<decimal> | null

data.hourly_rate

number<decimal> | null

data.hourly_rate_override

number<decimal> | null

data.business_preset

any

data.expense_accounting_code

any

data.liability_accounting_code

any

data.archived_at

string<dateTime> | null

read-only

The date and time the object was archived in Nmbr.

data.is_editable

boolean

After a PayRate is on a non-draft payroll, its Type and Rate may not be updated.

data.is_deletable

boolean

After a PayRate is on a non-draft payroll, it may not be deleted.

data.external_ref

string | null

A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.

Maximum string length: 255

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.