v4

OpenAPI 3.0.02026-07-314441026.8 MB
Pay Rates

Create a pay rate

post/pay_rates

Request body

work_assignment_idstring required

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

titlestring nullable

Required unless the business preset referenced by business_preset_id already has a title. Either the pay rate or its preset must have one.

has_business_presetboolean
business_preset_idstring
type'hourly' | 'salary'

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.

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

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

effective_fromstring date required

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

effective_tostring 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_idstring
liability_accounting_code_idstring
external_refstring

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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