Retrieve a business preset

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

business_preset

string

required

Query Parameters

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

id

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Default · object

Hide child attributes

data.business_entity

object

Hide child attributes

data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.business_entity.object

string

read-only

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

data.name

string

Maximum string length: 255

data.name_translations

object

Optional translations for the name property.

Hide child attributes

data.name_translations.en

string

Maximum string length: 255

data.name_translations.fr

string

Maximum string length: 255

data.name_translated

string

read-only

The translation of the name property for the request locale. Computed using the values in name and name_translations and the value of the request's Accept-Language header.

data.title

string | null

data.title_translations

object

Optional translations for the title property.

Hide child attributes

data.title_translations.en

string

Maximum string length: 255

data.title_translations.fr

string

Maximum string length: 255

data.title_translated

string

read-only

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.

data.type

string

Maximum string length: 255

data.subtype

string | null

Maximum string length: 255

data.remittance_account

any

data.is_managed

boolean

If true, this is a default Business Preset and can not be deleted, title and remittance_account may be set.

data.expense_accounting_code

any

data.liability_accounting_code

any

data.income_basis

enum<string> | null

Available options:

all_earnings,

none,

regular_earnings,

total_income

data.income_includes

object

data.external_ref

string | null

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.

Maximum string length: 255

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.