Search overtime rates

curl --request POST \ --url https://sandbox.nmbr.co/services/payroll/overtime_rates/search \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "business_entity_id": "<id>", "work_assignments": { "include": "all" }, "pay_rates": { "include": "all" } } '

{ "object": "list", "data": [ { "id": "<id>", "object": "overtime_rate", "data": { "pay_rate": { "id": "<id>", "object": "pay_rate", "links": { "self": "/pay_rates/<id>" } }, "title": "1.5x", "title_translated": "1.5x", "rate_multiplier": 1.5, "hourly_rate": 22.5, "hourly_rate_override": null, "business_preset": null, "expense_accounting_code": null, "liability_accounting_code": null, "archived_at": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/overtime_rates/<id>" } } ], "links": { "first": "http://localhost/overtime_rates/search?business_entity_id=<id>&work_assignments%5Binclude%5D=all&pay_rates%5Binclude%5D=all&page=1", "last": "http://localhost/overtime_rates/search?business_entity_id=<id>&work_assignments%5Binclude%5D=all&pay_rates%5Binclude%5D=all&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } }

Authorizations

Authorization

string

header

required

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

Body

application/json

business_entity_id

string

required

work_assignments

object

required

Hide child attributes

work_assignments.exclude

object

Hide child attributes

work_assignments.exclude.ids

string[]

work_assignments.exclude.payee_type

enum<string>

Available options:

contractor,

employee

work_assignments.exclude.pay_schedule_id

string

work_assignments.exclude.archived

boolean

work_assignments.exclude.payee_names

string

pay_rates

object

required

Hide child attributes

pay_rates.exclude

object

Hide child attributes

pay_rates.exclude.ids

string[]

pay_rates.exclude.type

enum<string>

Available options:

hourly,

salary

pay_rates.exclude.subtypes

enum<string>[]

Available options:

hourly,

salary

has_business_preset

boolean

business_presets

object

Hide child attributes

business_presets.include

object

Hide child attributes

business_presets.include.ids

(string | null)[]

business_presets.exclude

object

Hide child attributes

business_presets.exclude.ids

(string | null)[]

expense_accounting_codes

object

Hide child attributes

expense_accounting_codes.include

object

Hide child attributes

expense_accounting_codes.include.ids

(string | null)[]

expense_accounting_codes.exclude

object

Hide child attributes

expense_accounting_codes.exclude.ids

(string | null)[]

liability_accounting_codes

object

Hide child attributes

liability_accounting_codes.include

object

Hide child attributes

liability_accounting_codes.include.ids

(string | null)[]

liability_accounting_codes.exclude

object

Hide child attributes

liability_accounting_codes.exclude.ids

(string | null)[]

Response

200 - application/json

object

string

read-only

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

data

object[]

Hide child attributes

data.id

string

read-only

The unique identifier of the object in Nmbr.

data.object

string

read-only

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

data.data

Overtime Rate · object

Hide child attributes

data.data.pay_rate

object

Hide child attributes

data.data.pay_rate.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.pay_rate.object

string

read-only

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

data.data.title

string | null

data.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.data.rate_multiplier

number<decimal> | null

data.data.hourly_rate

number<decimal> | null

data.data.hourly_rate_override

number<decimal> | null

data.data.business_preset

any

data.data.expense_accounting_code

any

data.data.liability_accounting_code

any

data.data.archived_at

string<dateTime> | null

read-only

The date and time the object was archived in Nmbr.

data.data.is_editable

boolean

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

data.data.is_deletable

boolean

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

data.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.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.data.updated_at

string<dateTime>

read-only

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