Skip to main content
POST
/
pay_rates
/
search
Search pay rates
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/pay_rates/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_entity_id": "<id>",
  "work_assignments": {
    "include": "all"
  }
}
'
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "pay_rate",
      "data": {
        "work_assignment": {
          "id": "<id>",
          "object": "work_assignment",
          "links": {
            "self": "/work_assignments/<id>"
          }
        },
        "title": "Marketing Manager",
        "title_translations": null,
        "title_translated": "Marketing Manager",
        "type": "hourly",
        "rate": 15,
        "expected_hours_per_week": 40,
        "is_editable": true,
        "is_deletable": true,
        "effective_from": "2026-01-01",
        "earliest_valid_effective_to": "2026-01-01",
        "effective_to": null,
        "business_preset": null,
        "expense_accounting_code": null,
        "liability_accounting_code": null,
        "external_ref": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/pay_rates/<id>"
      }
    }
  ],
  "links": {
    "first": "http://localhost/pay_rates/search?business_entity_id=<id>&work_assignments%5Binclude%5D=all&pay_rates%5Binclude%5D=all&page=1",
    "last": "http://localhost/pay_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

The business entity whose pay rates to search.

​
work_assignments
object
required

Filter pay rates by their work assignment.

work_assignments.include must be either the string "all", or an object containing one or more of ids, payee_type (employee or contractor), pay_schedule_id, archived.

work_assignments.exclude (optional) accepts the same keys.

​
has_business_preset
boolean
​
business_presets
object

Filter pay rates by business_preset_id (include/exclude ids).

​
expense_accounting_codes
object

Filter pay rates by expense_accounting_code_id (include/exclude ids).

​
liability_accounting_codes
object

Filter pay rates by liability_accounting_code_id (include/exclude ids).

​
effective_on
string<date>
​
not_effective_on
string<date>
​
effective_from
string

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

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

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.

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

Filter pay rates by type (salary or hourly) via subtypes.include / subtypes.exclude arrays.

​
ids
object

Filter pay rates by id via ids.include / ids.exclude arrays.

Response

200 - application/json

OK

​
object
string
read-only

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

​
data
object[]