curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/effective_tax_properties \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.nmbr.co/services/payroll/effective_tax_properties"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.nmbr.co/services/payroll/effective_tax_properties', 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/effective_tax_properties",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.nmbr.co/services/payroll/effective_tax_properties"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.nmbr.co/services/payroll/effective_tax_properties")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.nmbr.co/services/payroll/effective_tax_properties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"object": "effective_tax_property",
"data": {
"type": "ca::province_of_employment",
"value": "ca_on",
"source_tax_property": {
"id": "<id>",
"object": "tax_property",
"links": {
"self": "/tax_properties/<id>"
}
}
}
},
{
"object": "effective_tax_property",
"data": {
"type": "ca::province_of_work",
"value": "ca_on",
"source_tax_property": {
"id": "<id>",
"object": "tax_property",
"links": {
"self": "/tax_properties/<id>"
}
}
}
}
]
}List effective tax properties
curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/effective_tax_properties \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.nmbr.co/services/payroll/effective_tax_properties"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.nmbr.co/services/payroll/effective_tax_properties', 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/effective_tax_properties",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.nmbr.co/services/payroll/effective_tax_properties"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.nmbr.co/services/payroll/effective_tax_properties")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.nmbr.co/services/payroll/effective_tax_properties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"object": "effective_tax_property",
"data": {
"type": "ca::province_of_employment",
"value": "ca_on",
"source_tax_property": {
"id": "<id>",
"object": "tax_property",
"links": {
"self": "/tax_properties/<id>"
}
}
}
},
{
"object": "effective_tax_property",
"data": {
"type": "ca::province_of_work",
"value": "ca_on",
"source_tax_property": {
"id": "<id>",
"object": "tax_property",
"links": {
"self": "/tax_properties/<id>"
}
}
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter by Work Assignment. Required if business_entity_id is not provided.
The work_assignment_id field is required when business_entity_id is not present.
Filter by Business Entity. Required if work_assignment_id is not provided.
The business_entity_id field is required when work_assignment_id is not present.
The date on which to resolve Tax Property values. Defaults to today.
Filter to specific Tax Property types. Accepts a comma-separated list.
ca::ab::claim_amount, ca::ab::total_income_less_than_total_claim_amount, ca::ab::workers_compensation_class, ca::bc::claim_amount, ca::bc::eht, ca::bc::total_income_less_than_total_claim_amount, ca::bc::workers_compensation_class, ca::cpp_exempt, ca::ei_exempt, ca::ei_premium_reduction, ca::federal::additional_tax, ca::federal::annual_deduction_at_source, ca::federal::claim_amount, ca::federal::commission_expenses, ca::federal::commission_total_income, ca::federal::income_tax_rate, ca::federal::total_income_less_than_total_claim_amount, ca::federal_oc_surtax_exempt, ca::first_nation_exemptions, ca::mb::claim_amount, ca::mb::eht, ca::mb::total_income_less_than_total_claim_amount, ca::mb::workers_compensation_class, ca::nb::claim_amount, ca::nb::total_income_less_than_total_claim_amount, ca::nb::workers_compensation_class, ca::nl::claim_amount, ca::nl::eht, ca::nl::total_income_less_than_total_claim_amount, ca::nl::workers_compensation_class, ca::ns::claim_amount, ca::ns::total_income_less_than_total_claim_amount, ca::ns::workers_compensation_class, ca::nt::claim_amount, ca::nt::territorial_payroll_tax, ca::nt::total_income_less_than_total_claim_amount, ca::nt::workers_compensation_class, ca::nu::claim_amount, ca::nu::territorial_payroll_tax, ca::nu::total_income_less_than_total_claim_amount, ca::nu::workers_compensation_class, ca::on::claim_amount, ca::on::dependent_children_credit, ca::on::eht, ca::on::impaired_dependants_credit, ca::on::total_income_less_than_total_claim_amount, ca::on::workers_compensation_class, ca::pe::claim_amount, ca::pe::total_income_less_than_total_claim_amount, ca::pe::workers_compensation_class, ca::province_of_employment, ca::province_of_work, ca::provincial::income_tax_rate, ca::qc::additional_tax, ca::qc::claim_amount, ca::qc::commission_percentage_taxed, ca::qc::eht, ca::qc::income_tax_rate, ca::qc::qpip_exempt, ca::qc::qpp_exempt, ca::qc::tax_id, ca::qc::total_income_less_than_total_claim_amount, ca::qc::workers_compensation_class, ca::sk::claim_amount, ca::sk::total_income_less_than_total_claim_amount, ca::sk::workers_compensation_class, ca::statutory_holiday_pay, ca::tax_id, ca::yt::claim_amount, ca::yt::total_income_less_than_total_claim_amount, ca::yt::workers_compensation_class source_tax_property 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 ("effective_tax_property").
- Default
- With source_tax_property expanded
Hide child attributes
Hide child attributes
The type of tax property being resolved (e.g. ca::province_of_work). Always reflects the requested type, even when the value was inherited from a different type on a parent owner (e.g. POW resolved via a POE Tax Property).
The resolved value for this type as of the requested date, after applying the inheritance chain. null if no value exists anywhere in the chain (only present when filtering to a specific type that has no value).

