Skip to main content
POST
/
allowances
/
search
Search allowances
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/allowances/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": "allowance",
      "data": {
        "work_assignment": {
          "id": "<id>",
          "object": "work_assignment",
          "links": {
            "self": "/work_assignments/<id>"
          }
        },
        "allowance_type": {
          "id": "<id>",
          "object": "allowance_type",
          "data": {
            "type": "automobile_and_motor_vehicle",
            "label": "Vehicle allowance"
          },
          "links": {
            "self": "/allowance_types/automobile_and_motor_vehicle"
          }
        },
        "title": null,
        "title_translations": null,
        "title_translated": null,
        "amount": 35,
        "frequency": "per_payroll",
        "date_basis": null,
        "pay_period_cadence": null,
        "effective_from": "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": "/allowances/<id>"
      }
    }
  ],
  "links": {
    "first": "http://localhost/allowances/search?business_entity_id=<id>&work_assignments%5Binclude%5D=all&page=1",
    "last": "http://localhost/allowances/search?business_entity_id=<id>&work_assignments%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

The date from which this allowance 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 allowance is no longer applied. null if the allowance 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
​
ids
object

Response

200 - application/json

OK

​
object
string
read-only

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

​
data
object[]