Skip to main content
POST
/
overtime_rates
/
bulk
/
update
/
scope
Show bulk update scope for overtime rates
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/overtime_rates/bulk/update/scope \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_entity_id": "<id>",
  "work_assignments": {
    "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/bulk/update/scope?business_entity_id=<id>&work_assignments%5Binclude%5D=all&pay_rates%5Binclude%5D=all&page=1",
    "last": "http://localhost/overtime_rates/bulk/update/scope?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
​
has_business_preset
boolean
​
business_presets
object
​
expense_accounting_codes
object
​
liability_accounting_codes
object
​
effective_on
string<date>
​
not_effective_on
string<date>
​
effective_from
string

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_from=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31
​
effective_to
string

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_to=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31
​
subtypes
object
​
ids
object

Response

200 - application/json

OK

​
object
string
read-only

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

​
data
object[]