Skip to main content
GET
/
statutory_withholding_types
List employee statutory withholding types
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/statutory_withholding_types \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://sandbox.nmbr.co/services/payroll/statutory_withholding_types"

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/statutory_withholding_types', 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/statutory_withholding_types",
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/statutory_withholding_types"

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/statutory_withholding_types")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/statutory_withholding_types")

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": [
    {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "cpp",
        "label": "CPP"
      },
      "links": {
        "self": "/statutory_withholding_types/cpp"
      }
    },
    {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "cpp_2",
        "label": "CPP 2"
      },
      "links": {
        "self": "/statutory_withholding_types/cpp_2"
      }
    },
    {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "ei",
        "label": "EI"
      },
      "links": {
        "self": "/statutory_withholding_types/ei"
      }
    },
    {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "federal_income_tax",
        "label": "Federal Income Tax"
      },
      "links": {
        "self": "/statutory_withholding_types/federal_income_tax"
      }
    },
    {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "provincial_income_tax",
        "label": "Provincial Income Tax"
      },
      "links": {
        "self": "/statutory_withholding_types/provincial_income_tax"
      }
    },
    {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "qpip",
        "label": "QPIP"
      },
      "links": {
        "self": "/statutory_withholding_types/qpip"
      }
    },
    {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "qpp",
        "label": "QPP"
      },
      "links": {
        "self": "/statutory_withholding_types/qpp"
      }
    },
    {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "qpp_2",
        "label": "QPP 2"
      },
      "links": {
        "self": "/statutory_withholding_types/qpp_2"
      }
    },
    {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "territorial_income_tax",
        "label": "Territorial Income Tax"
      },
      "links": {
        "self": "/statutory_withholding_types/territorial_income_tax"
      }
    }
  ],
  "links": {
    "first": "/statutory_withholding_types?page=1",
    "last": "/statutory_withholding_types?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 9,
    "has_more": false
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

features
enum<string>

Country code that adds each type's payroll calculations to the response, as the features and form_mappings fields. Currently only ca is supported. See Line item type features.

Available options:
CA,
GB
id
string

Comma-separated list of type identifiers to return.

Case-insensitive substring match against the human-readable label, in any supported locale.

Response

200 - application/json

OK

object
string
read-only

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

data
object[]