Skip to main content
GET
/
deduction_types
List deduction types
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/deduction_types \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "deduction_type",
      "data": {
        "type": "charitable_donation",
        "label": "Charitable donations",
        "locale": "en"
      },
      "links": {
        "self": "/deduction_types/charitable_donation"
      }
    },
    {
      "id": "<id>",
      "object": "deduction_type",
      "data": {
        "type": "garnishment_order",
        "label": "Garnishment Order",
        "locale": "en"
      },
      "links": {
        "self": "/deduction_types/garnishment_order"
      }
    },
    {
      "id": "<id>",
      "object": "deduction_type",
      "data": {
        "type": "income_tax",
        "label": "Income tax debt",
        "locale": "en"
      },
      "links": {
        "self": "/deduction_types/income_tax"
      }
    },
    {
      "id": "<id>",
      "object": "deduction_type",
      "data": {
        "type": "other_deduction",
        "label": "Other Deduction",
        "locale": "en"
      },
      "links": {
        "self": "/deduction_types/other_deduction"
      }
    },
    {
      "id": "<id>",
      "object": "deduction_type",
      "data": {
        "type": "union_dues",
        "label": "Union Dues",
        "locale": "en"
      },
      "links": {
        "self": "/deduction_types/union_dues"
      }
    },
    {
      "id": "<id>",
      "object": "deduction_type",
      "data": {
        "type": "union_dues_post_tax",
        "label": "Union Dues Post Tax",
        "locale": "en"
      },
      "links": {
        "self": "/deduction_types/union_dues_post_tax"
      }
    }
  ],
  "links": {
    "first": "/deduction_types?page=1",
    "last": "/deduction_types?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 6,
    "has_more": false
  }
}

Authorizations

Authorization
string
header
required

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

Response

200 - application/json

OK

object
string
read-only

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

data
object[]