Retrieve a pay rate

Authorizations

Authorization

string

header

required

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

Path Parameters

pay_rate

string

required

Query Parameters

expand

enum<string>[]

Available options:

business_preset,

expense_accounting_code,

liability_accounting_code,

overtime_rates,

tag_assignment,

work_assignment

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 ("pay_rate").

data

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