Show bulk create scope for allowances

curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/allowances/bulk/create/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": "work_assignment",
      "data": {
        "title": null,
        "employee": {
          "id": "<id>",
          "object": "employee",
          "links": {
            "self": "/employees/<id>"
          }
        },
        "pay_schedule": {
          "id": "<id>",
          "object": "pay_schedule",
          "links": {
            "self": "/pay_schedules/<id>"
          }
        },
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "current_tax_jurisdiction": "ca_on",
        "is_primary": true,
        "accrued_vacation_pay": 0,
        "paid_vacation_pay": 0,
        "first_non_draft_period_start": null,
        "last_non_draft_period_end": null,
        "available_tax_properties": [
          "ca::province_of_employment",
          "ca::province_of_work",
          "ca::federal_oc_surtax_exempt",
          "ca::cpp_exempt",
          "ca::ei_exempt",
          "ca::qc::qpp_exempt",
          "ca::qc::qpip_exempt",
          "ca::nt::territorial_payroll_tax",
          "ca::nu::territorial_payroll_tax",
          "ca::federal::additional_tax",
          "ca::federal::claim_amount",
          "ca::federal::total_income_less_than_total_claim_amount",
          "ca::federal::annual_deduction_at_source",
          "ca::statutory_holiday_pay",
          "ca::first_nation_exemptions",
          "ca::ab::workers_compensation_class",
          "ca::bc::workers_compensation_class",
          "ca::mb::workers_compensation_class",
          "ca::nb::workers_compensation_class",
          "ca::nl::workers_compensation_class",
          "ca::ns::workers_compensation_class",
          "ca::nt::workers_compensation_class",
          "ca::nu::workers_compensation_class",
          "ca::on::workers_compensation_class",
          "ca::pe::workers_compensation_class",
          "ca::qc::workers_compensation_class",
          "ca::sk::workers_compensation_class",
          "ca::yt::workers_compensation_class",
          "ca::on::claim_amount",
          "ca::on::dependent_children_credit",
          "ca::on::impaired_dependants_credit"
        ],
        "external_ref": null,
        "archived_at": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/work_assignments/<id>"
      }
    }
  ],
  "links": {
    "first": "http://localhost/allowances/bulk/create/scope?business_entity_id=<id>&work_assignments%5Binclude%5D=all&page=1",
    "last": "http://localhost/allowances/bulk/create/scope?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
  }
}

POST

allowances

bulk

create

scope

Show bulk create scope for allowances

curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/allowances/bulk/create/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": "work_assignment",
      "data": {
        "title": null,
        "employee": {
          "id": "<id>",
          "object": "employee",
          "links": {
            "self": "/employees/<id>"
          }
        },
        "pay_schedule": {
          "id": "<id>",
          "object": "pay_schedule",
          "links": {
            "self": "/pay_schedules/<id>"
          }
        },
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "current_tax_jurisdiction": "ca_on",
        "is_primary": true,
        "accrued_vacation_pay": 0,
        "paid_vacation_pay": 0,
        "first_non_draft_period_start": null,
        "last_non_draft_period_end": null,
        "available_tax_properties": [
          "ca::province_of_employment",
          "ca::province_of_work",
          "ca::federal_oc_surtax_exempt",
          "ca::cpp_exempt",
          "ca::ei_exempt",
          "ca::qc::qpp_exempt",
          "ca::qc::qpip_exempt",
          "ca::nt::territorial_payroll_tax",
          "ca::nu::territorial_payroll_tax",
          "ca::federal::additional_tax",
          "ca::federal::claim_amount",
          "ca::federal::total_income_less_than_total_claim_amount",
          "ca::federal::annual_deduction_at_source",
          "ca::statutory_holiday_pay",
          "ca::first_nation_exemptions",
          "ca::ab::workers_compensation_class",
          "ca::bc::workers_compensation_class",
          "ca::mb::workers_compensation_class",
          "ca::nb::workers_compensation_class",
          "ca::nl::workers_compensation_class",
          "ca::ns::workers_compensation_class",
          "ca::nt::workers_compensation_class",
          "ca::nu::workers_compensation_class",
          "ca::on::workers_compensation_class",
          "ca::pe::workers_compensation_class",
          "ca::qc::workers_compensation_class",
          "ca::sk::workers_compensation_class",
          "ca::yt::workers_compensation_class",
          "ca::on::claim_amount",
          "ca::on::dependent_children_credit",
          "ca::on::impaired_dependants_credit"
        ],
        "external_ref": null,
        "archived_at": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/work_assignments/<id>"
      }
    }
  ],
  "links": {
    "first": "http://localhost/allowances/bulk/create/scope?business_entity_id=<id>&work_assignments%5Binclude%5D=all&page=1",
    "last": "http://localhost/allowances/bulk/create/scope?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

Hide child attributes

work_assignments.exclude

object

Hide child attributes

work_assignments.exclude.ids

string[]

work_assignments.exclude.payee_type

enum<string>

Available options:

contractor,

employee

work_assignments.exclude.pay_schedule_id

string

work_assignments.exclude.archived

boolean

work_assignments.exclude.payee_names

string

Response

200 - application/json

object

string

read-only

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

data

object[]

Hide child attributes

data.id

string

read-only

The unique identifier of the object in Nmbr.

data.object

string

read-only

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

data.data

Allowance · object

Hide child attributes

data.data.work_assignment

object

Hide child attributes

data.data.work_assignment.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.work_assignment.object

string

read-only

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

data.data.allowance_type

object

The type of allowance, which determines how it is taxed and reported on Pay Stubs.

Hide child attributes

data.data.allowance_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.allowance_type.object

string

read-only

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

data.data.allowance_type.data

Allowance Type · object

Hide child attributes

data.data.allowance_type.data.type

string | null

The string identifier for this allowance type.

data.data.allowance_type.data.label

string | null

The human-readable display name for this allowance type.

data.data.title

string | null

data.data.title_translations

object

Optional translations for the title property.

Hide child attributes

data.data.title_translations.en

string

Maximum string length: 255

data.data.title_translations.fr

string

Maximum string length: 255

data.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.data.amount

number<decimal>

The monetary amount applied each time this allowance is included on a Pay Stub.

data.data.frequency

enum<string>

The frequency at which this allowance is applied to Pay Stubs. When per_month, the amount is distributed evenly across all Payrolls in the calendar month.

Available options:

once,

per_month,

per_payroll

data.data.date_basis

enum<string> | null

Which payroll date determines the calendar month for the allocation. Applies only to per_month recurrences.

Available options:

by_pay_date,

by_period_end_date,

by_period_start_date

data.data.pay_period_cadence

object

Which pay periods within the month receive the allocation. An array of 1-based positions; -1 is the final period. Applies only to per_month recurrences.

data.data.effective_from

string<date>

The date from which this allowance is applied to Pay Stubs.

data.data.effective_to

string<date> | null

The date after which this allowance is no longer applied. null if the allowance applies indefinitely.

data.data.business_preset

any

data.data.expense_accounting_code

any

data.data.liability_accounting_code

any

data.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.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.data.updated_at

string<dateTime>

read-only

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

Bulk create allowances Bulk update allowances

⌘I