curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/employee_benefits/bulk/update/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": "employee_benefit",
"data": {
"work_assignment": {
"id": "<id>",
"object": "work_assignment",
"links": {
"self": "/work_assignments/<id>"
}
},
"business_preset": null,
"employee_benefit_type": {
"id": "<id>",
"object": "employee_benefit_type",
"data": {
"type": "health",
"label": "Health"
},
"links": {
"self": "/employee_benefit_types/health"
}
},
"employer_benefit": null,
"title": null,
"title_translations": null,
"title_translated": null,
"income_basis": "regular_earnings",
"income_includes": [],
"max_annual_contribution_basis": "this_benefit",
"apply_sales_tax": true,
"remittance_account_id": null,
"remittance_account": null,
"amount": 35,
"amount_type": "fixed",
"coverage_multiplier": 1,
"max_annual_contribution": null,
"frequency": "per_payroll",
"date_basis": null,
"pay_period_cadence": null,
"effective_from": "2026-01-01",
"effective_to": 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": "/employee_benefits/<id>"
}
}
],
"links": {
"first": "http://localhost/employee_benefits/bulk/update/scope?business_entity_id=<id>&work_assignments%5Binclude%5D=all&page=1",
"last": "http://localhost/employee_benefits/bulk/update/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
}
}Show bulk update scope for employee benefits
curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/employee_benefits/bulk/update/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": "employee_benefit",
"data": {
"work_assignment": {
"id": "<id>",
"object": "work_assignment",
"links": {
"self": "/work_assignments/<id>"
}
},
"business_preset": null,
"employee_benefit_type": {
"id": "<id>",
"object": "employee_benefit_type",
"data": {
"type": "health",
"label": "Health"
},
"links": {
"self": "/employee_benefit_types/health"
}
},
"employer_benefit": null,
"title": null,
"title_translations": null,
"title_translated": null,
"income_basis": "regular_earnings",
"income_includes": [],
"max_annual_contribution_basis": "this_benefit",
"apply_sales_tax": true,
"remittance_account_id": null,
"remittance_account": null,
"amount": 35,
"amount_type": "fixed",
"coverage_multiplier": 1,
"max_annual_contribution": null,
"frequency": "per_payroll",
"date_basis": null,
"pay_period_cadence": null,
"effective_from": "2026-01-01",
"effective_to": 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": "/employee_benefits/<id>"
}
}
],
"links": {
"first": "http://localhost/employee_benefits/bulk/update/scope?business_entity_id=<id>&work_assignments%5Binclude%5D=all&page=1",
"last": "http://localhost/employee_benefits/bulk/update/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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Hide child attributes
Hide child attributes
The date from which this benefit 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
The date after which this benefit is no longer applied. null if the benefit 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
Response
OK
The type of the object in Nmbr ("list").
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("employee_benefit").
Hide child attributes
Hide child attributes
The type of employee benefit, which determines how it is taxed and reported.
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("employee_benefit_type").
255The 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.
Determines the income used as the base for percentage-based benefit calculations. regular_earnings includes only salary and wage earnings. all_earnings includes all earnings. total_income includes all earnings, taxable allowances, and taxable reimbursements. none doesn't include any line items, and can be used with income_includes for completely custom definitions of income.
all_earnings, none, regular_earnings, total_income An optional list of specific earnings, allowances, and other line item types to include in the income calculation in addition to those included via income_basis.
Whether max_annual_contribution accumulates across pay periods or applies as a fixed per-period cap.
all_line_items_of_type, this_benefit Whether provincial sales tax is applied to the benefit amount.
The remittance account to which collected benefit amounts are remitted.
32The contribution amount per pay period. When amount_type is percent, this is interpreted as a percentage of the income basis (0-100); otherwise as a fixed dollar amount.
Whether amount is a fixed dollar value (fixed) or a percentage of the income basis (percent).
fixed, percent A multiplier applied to the Employee's earnings to determine the benefit coverage amount, used for coverage-based benefits such as life insurance.
The maximum dollar amount that will be contributed in a calendar year. Contributions stop once this limit is reached.
The frequency at which this benefit is applied to Pay Stubs. When per_month, the amount is distributed across the selected Payrolls in the calendar month. per_month requires amount_type to be fixed.
once, per_month, per_payroll Which payroll date determines the calendar month for the allocation. Applies only to per_month benefits.
by_pay_date, by_period_end_date, by_period_start_date 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 benefits.
The date from which this benefit is applied to Pay Stubs.
The date after which this benefit is no longer applied. null if the benefit applies indefinitely.
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.
255The date and time the object was created in Nmbr.
The date and time the object was last updated in Nmbr.