curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/update/scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payroll_id": "<id>",
"pay_stubs": {
"include": "all"
}
}
'import requests
url = "https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/update/scope"
payload = {
"payroll_id": "<id>",
"pay_stubs": { "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({payroll_id: '<id>', pay_stubs: {include: 'all'}})
};
fetch('https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/update/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/earning_line_items/bulk/update/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([
'payroll_id' => '<id>',
'pay_stubs' => [
'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/earning_line_items/bulk/update/scope"
payload := strings.NewReader("{\n \"payroll_id\": \"<id>\",\n \"pay_stubs\": {\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/earning_line_items/bulk/update/scope")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payroll_id\": \"<id>\",\n \"pay_stubs\": {\n \"include\": \"all\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/update/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 \"payroll_id\": \"<id>\",\n \"pay_stubs\": {\n \"include\": \"all\"\n }\n}"
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"id": "<id>",
"object": "earning_line_item",
"data": {
"pay_stub": {
"id": "<id>",
"object": "pay_stub",
"links": {
"self": "/pay_stubs/<id>"
}
},
"amount": 3000,
"custom_amount": 3000,
"managed_amount": 0,
"is_managed": false,
"line_item_type": "earning",
"earning_type": {
"id": "<id>",
"object": "earning_type",
"data": {
"type": "wage",
"label": "Wage",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true,
"correction": true
}
},
"links": {
"self": "/earning_types/wage"
}
},
"hours": 0,
"managed_hours": null,
"custom_hours": 0,
"custom_rate": null,
"custom_rate_multiplier": null,
"accrued_vacation_pay": 0,
"recurrence": null,
"pay_rate": null,
"overtime_rate": null,
"title": null,
"title_translations": null,
"title_translated": null,
"expense_accounting_code": null,
"managed_expense_accounting_code": null,
"custom_expense_accounting_code": null,
"expense_accounting_code_rule": null,
"liability_accounting_code": null,
"managed_liability_accounting_code": null,
"custom_liability_accounting_code": null,
"liability_accounting_code_rule": null,
"business_preset": null,
"source_adjustment": null,
"component_settings": {
"attributes_locked": false
},
"earned_on": null,
"managed_earned_on": null,
"custom_earned_on": null,
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/earning_line_items/<id>"
}
}
],
"links": {
"first": "http://localhost/earning_line_items/bulk/update/scope?page=1",
"last": "http://localhost/earning_line_items/bulk/update/scope?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 earning line items
curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/update/scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payroll_id": "<id>",
"pay_stubs": {
"include": "all"
}
}
'import requests
url = "https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/update/scope"
payload = {
"payroll_id": "<id>",
"pay_stubs": { "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({payroll_id: '<id>', pay_stubs: {include: 'all'}})
};
fetch('https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/update/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/earning_line_items/bulk/update/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([
'payroll_id' => '<id>',
'pay_stubs' => [
'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/earning_line_items/bulk/update/scope"
payload := strings.NewReader("{\n \"payroll_id\": \"<id>\",\n \"pay_stubs\": {\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/earning_line_items/bulk/update/scope")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payroll_id\": \"<id>\",\n \"pay_stubs\": {\n \"include\": \"all\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/update/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 \"payroll_id\": \"<id>\",\n \"pay_stubs\": {\n \"include\": \"all\"\n }\n}"
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"id": "<id>",
"object": "earning_line_item",
"data": {
"pay_stub": {
"id": "<id>",
"object": "pay_stub",
"links": {
"self": "/pay_stubs/<id>"
}
},
"amount": 3000,
"custom_amount": 3000,
"managed_amount": 0,
"is_managed": false,
"line_item_type": "earning",
"earning_type": {
"id": "<id>",
"object": "earning_type",
"data": {
"type": "wage",
"label": "Wage",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true,
"correction": true
}
},
"links": {
"self": "/earning_types/wage"
}
},
"hours": 0,
"managed_hours": null,
"custom_hours": 0,
"custom_rate": null,
"custom_rate_multiplier": null,
"accrued_vacation_pay": 0,
"recurrence": null,
"pay_rate": null,
"overtime_rate": null,
"title": null,
"title_translations": null,
"title_translated": null,
"expense_accounting_code": null,
"managed_expense_accounting_code": null,
"custom_expense_accounting_code": null,
"expense_accounting_code_rule": null,
"liability_accounting_code": null,
"managed_liability_accounting_code": null,
"custom_liability_accounting_code": null,
"liability_accounting_code_rule": null,
"business_preset": null,
"source_adjustment": null,
"component_settings": {
"attributes_locked": false
},
"earned_on": null,
"managed_earned_on": null,
"custom_earned_on": null,
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/earning_line_items/<id>"
}
}
],
"links": {
"first": "http://localhost/earning_line_items/bulk/update/scope?page=1",
"last": "http://localhost/earning_line_items/bulk/update/scope?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 15,
"total": 1,
"has_more": false
}
}Authorizations
Body
Response
OK
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
The type of earning for this line item.
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
A map of Payroll types to whether this earning type is available on that Payroll type.
Hide child attributes
Hide child attributes
How this type affects the calculation, broken down by jurisdiction. Jurisdictions where it does not apply are omitted.
Hide child attributes
Hide child attributes
How this type affects the payroll calculation in this jurisdiction.
accrues_vacation_pay, included_in_gross_pay, included_in_hour_totals, included_in_stat_holiday_pay, moves_money, reduces_base, tax_credit, withholding Hide child attributes
Hide child attributes
The boxes on the form this type contributes to in at least one province.
Hide child attributes
Hide child attributes
The provinces of employment where amounts of this type are reported in this box. RL-1 boxes apply only in Quebec. Most T4 and T4A boxes apply in every province; a few, such as for Quebec tips, do not.
The province of employment (e.g. ca_on, ca_qc).
The hourly rate this line item is paid at when it isn't paid under a Pay Rate. managed_amount is calculated as hours x custom_rate, or with custom_rate_multiplier, hours x (custom_rate x custom_rate_multiplier, rounded to the cent), the same way a Pay Rate and Overtime Rate calculate it. The pay stub shows this rate (with its multiplier applied) in the rate column. A line item has either a Pay Rate (and optionally an Overtime Rate) or a custom_rate, not both.

