Skip to main content
GET
/
business_presets
List business presets
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/business_presets \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "business_preset",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "name": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49",
        "name_translations": null,
        "name_translated": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49",
        "title": "Business Preset",
        "title_translations": null,
        "title_translated": "Business Preset",
        "type": "earning",
        "subtype": null,
        "remittance_account": null,
        "is_managed": false,
        "expense_accounting_code": null,
        "liability_accounting_code": null,
        "income_basis": null,
        "income_includes": [],
        "external_ref": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/business_presets/<id>"
      }
    }
  ],
  "links": {
    "first": "/business_presets?business_entity_id=<id>&page=1",
    "last": "/business_presets?business_entity_id=<id>&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.

Query Parameters

​
business_entity_id
string
required
​
type
enum<string>
Available options:
allowance,
deduction,
earning,
employee_benefit,
employer_benefit,
employer_statutory_withholding,
reimbursement,
statutory_withholding
​
subtype
string
​
sort
enum<string>

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

Available options:
name,
subtype,
subtype.label,
title,
type,
type.label
​
include_managed
boolean
​
external_ref
string
​
expand
enum<string>[]
Available options:
allowances,
business_entity,
deductions,
earnings,
employee_benefits,
employer_benefits,
expense_accounting_code,
liability_accounting_code,
pay_rates,
reimbursements,
remittance_account

Response

200 - application/json

OK

​
object
string
read-only

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

​
data
object[]