Skip to main content
GET
/
allowance_types
List allowance types
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/allowance_types \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "automobile_and_motor_vehicle",
        "label": "Vehicle allowance"
      },
      "links": {
        "self": "/allowance_types/automobile_and_motor_vehicle"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "cell_phone_allowance",
        "label": "Cell phone allowance"
      },
      "links": {
        "self": "/allowance_types/cell_phone_allowance"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "child_care_expenses",
        "label": "Child care allowance"
      },
      "links": {
        "self": "/allowance_types/child_care_expenses"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "child_eduction_non_taxable",
        "label": "Educational allowances for children (non-taxable)"
      },
      "links": {
        "self": "/allowance_types/child_eduction_non_taxable"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "child_eduction_taxable",
        "label": "Educational allowances for children (taxable)"
      },
      "links": {
        "self": "/allowance_types/child_eduction_taxable"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "clothing_non_taxable",
        "label": "Uniforms and protective clothing – in cash (non-taxable)"
      },
      "links": {
        "self": "/allowance_types/clothing_non_taxable"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "clothing_taxable",
        "label": "Uniforms and protective clothing – in cash (taxable)"
      },
      "links": {
        "self": "/allowance_types/clothing_taxable"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "education_and_professional_development",
        "label": "Education and professional development"
      },
      "links": {
        "self": "/allowance_types/education_and_professional_development"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "housing_allowance_cash",
        "label": "Housing allowance – in cash"
      },
      "links": {
        "self": "/allowance_types/housing_allowance_cash"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "internet_allowance",
        "label": "Internet allowance"
      },
      "links": {
        "self": "/allowance_types/internet_allowance"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "meals_taxable",
        "label": "Meals (taxable)"
      },
      "links": {
        "self": "/allowance_types/meals_taxable"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "moving_allowance_non_taxable",
        "label": "Moving allowance - non-accountable $650 or less (non-taxable)"
      },
      "links": {
        "self": "/allowance_types/moving_allowance_non_taxable"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "moving_allowance_taxable",
        "label": "Moving – non-accountable allowance over $650 (taxable)"
      },
      "links": {
        "self": "/allowance_types/moving_allowance_taxable"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "municipal_officers_expense",
        "label": "Municipal officer's expense allowance"
      },
      "links": {
        "self": "/allowance_types/municipal_officers_expense"
      }
    },
    {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "non_taxable_allowance",
        "label": "Non-taxable allowance"
      },
      "links": {
        "self": "/allowance_types/non_taxable_allowance"
      }
    }
  ],
  "links": {
    "first": "/allowance_types?page=1",
    "last": "/allowance_types?page=2",
    "prev": null,
    "next": "/allowance_types?page=2"
  },
  "meta": {
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "total": 26,
    "has_more": true
  }
}

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[]