Skip to main content
POST
/
employee_benefits
/
bulk
/
create
/
scope
Show bulk create scope for employee benefits
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/employee_benefits/bulk/create/scope \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_entity_id": "<id>",
  "work_assignments": {
    "include": "all"
  }
}
'
import requests

url = "https://sandbox.nmbr.co/services/payroll/employee_benefits/bulk/create/scope"

payload = {
"business_entity_id": "<id>",
"work_assignments": { "include": "all" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({business_entity_id: '<id>', work_assignments: {include: 'all'}})
};

fetch('https://sandbox.nmbr.co/services/payroll/employee_benefits/bulk/create/scope', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.nmbr.co/services/payroll/employee_benefits/bulk/create/scope",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'business_entity_id' => '<id>',
'work_assignments' => [
'include' => 'all'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox.nmbr.co/services/payroll/employee_benefits/bulk/create/scope"

payload := strings.NewReader("{\n \"business_entity_id\": \"<id>\",\n \"work_assignments\": {\n \"include\": \"all\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.nmbr.co/services/payroll/employee_benefits/bulk/create/scope")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"business_entity_id\": \"<id>\",\n \"work_assignments\": {\n \"include\": \"all\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/employee_benefits/bulk/create/scope")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business_entity_id\": \"<id>\",\n \"work_assignments\": {\n \"include\": \"all\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "work_assignment",
      "data": {
        "title": null,
        "title_translations": null,
        "title_translated": 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/employee_benefits/bulk/create/scope?page=1",
    "last": "http://localhost/employee_benefits/bulk/create/scope?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

Response

200 - application/json

OK

object
string
read-only

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

data
object[]