---
title: "Update a pay rate"
method: PUT
path: "/pay_rates/{pay_rate}"
tags: ["Pay Rates"]
---

# Update a pay rate

`PUT /pay_rates/{pay_rate}`

## Path parameters

- `pay_rate` string, required

## Request body

- object
  - `business_preset_id` string
  - `title` string, nullable
  - `title_translations` Translations, nullable
    - `en` string
    - `fr` string
  - `type` 'hourly' | 'salary' — Whether this is a `salary` or `hourly` pay rate. Determines how `rate` is interpreted. Editing is prevented when `is_editable` is false
  - `rate` number — 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). Editing is prevented when `is_editable` is false
  - `expected_hours_per_week` number — 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. Editing is prevented when `is_editable` is false
  - `effective_from` string, date — The date from which this pay rate is applied to Pay Stubs. Editing is prevented when `is_editable` is false
  - `effective_to` string — 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. The date must be after the `period_end` of the most recent non-draft payroll.
  - `expense_accounting_code_id` string
  - `liability_accounting_code_id` string
  - `external_ref` string
  - `tag_assignment` object
    - `unit` 'percentage'
    - `is_component_locked` boolean
    - `tag_allocations` object[]
      - `tags` string[]
      - `value` number

## Response `200`

OK

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"pay_rate"`).
  - `data` PayRate
    - `work_assignment` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"work_assignment"`).
    - `title` string
    - `title_translations` Translations, nullable
      - `en` string
      - `fr` string
    - `title_translated` string — 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.
    - `type` 'hourly' | 'salary' — Whether this is a `salary` or `hourly` pay rate. Determines how `rate` is interpreted.
    - `rate` number — The annual salary when `type` is `salary`, or the hourly wage when `type` is `hourly`.
    - `expected_hours_per_week` number — 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.
    - `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.
    - `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.
    - `effective_from` string, date — The date from which this pay rate is applied to Pay Stubs.
    - `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.
    - `effective_to` string, date, nullable — 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.
    - `business_preset` unknown
    - `expense_accounting_code` unknown
    - `liability_accounting_code` unknown
    - `external_ref` string, nullable — 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.
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/a0c7a815860f/schema)