Create a pay rate

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

Must belong to a work assignment associated with an entity of type Employee.

rate

number<decimal>

required

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).

Required range: 0 <= x <= 9999999

expected_hours_per_week

number<decimal>

required

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.

Required range: 0 <= x <= 168

effective_from

string<date>

required

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

title

string | null

Maximum string length: 255

title_translations

object

Optional translations for the title property.

Hide child attributes

title_translations.en

string

Maximum string length: 255

title_translations.fr

string

Maximum string length: 255

has_business_preset

boolean

business_preset_id

string

type

enum<string>

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

Must be present when business_preset_id is either empty or not set.

Available options:

hourly,

salary

effective_to

string<date>

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.

expense_accounting_code_id

string

liability_accounting_code_id

string

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

201 - application/json

Created

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Pay Rate · object

Hide child attributes

data.work_assignment

object

Hide child attributes

data.work_assignment.id

string

read-only

The unique identifier of the object in Nmbr.

data.work_assignment.object

string

read-only

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

data.title

string

Maximum string length: 255

data.title_translations

object

Optional translations for the title property.

Hide child attributes

data.title_translations.en

string

Maximum string length: 255

data.title_translations.fr

string

Maximum string length: 255

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.type

enum<string>

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

Available options:

hourly,

salary

data.rate

number<decimal>

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

data.expected_hours_per_week

number<decimal>

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.

data.is_editable

boolean

Whether the pay rate's type, rate, and effective_from can be modified. Once the pay rate has been used on a non-draft Payroll, these fields are locked.

data.is_deletable

boolean

Whether the pay rate can be deleted. A pay rate may not be deleted once it has been used on a non-draft Payroll.

data.effective_from

string<date>

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

data.earliest_valid_effective_to

string<date>

The earliest date that effective_to may be set to, based on the most recent non-draft Payroll period in which this pay rate was active.

data.effective_to

string<date> | null

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.

data.business_preset

any

data.expense_accounting_code

any

data.liability_accounting_code

any

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.