List earning types
curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/earning_types \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "bonus_discretionary",
"label": "Bonus (Discretionary)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/bonus_discretionary"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "bonus_non_discretionary",
"label": "Bonus (Non-Discretionary)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/bonus_non_discretionary"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "bonus_non_taxable",
"label": "Bonus (Non-Taxable)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/bonus_non_taxable"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "commission",
"label": "Commission (Non-Periodic)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/commission"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "commission_periodic",
"label": "Commission (Periodic)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/commission_periodic"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "commission_self_employed",
"label": "Commission (Self-employed)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/commission_self_employed"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "death_benefit",
"label": "Death Benefit",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/death_benefit"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "gift_cash",
"label": "Gift (Cash)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/gift_cash"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "gratuity",
"label": "Gratuity",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/gratuity"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "in_lieu_wages",
"label": "In Lieu Wages (Dismissal Pay)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/in_lieu_wages"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "income_replacement_indemnity_non_taxable",
"label": "Income Replacement Indemnity (Non-Taxable)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/income_replacement_indemnity_non_taxable"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "income_replacement_indemnity_taxable",
"label": "Income Replacement Indemnity (Taxable)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/income_replacement_indemnity_taxable"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "invoice_payment",
"label": "Invoice Payment",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/invoice_payment"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "invoice_sales_tax",
"label": "Invoice sales tax",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/invoice_sales_tax"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "leave_bereavement",
"label": "Leave (Bereavement)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/leave_bereavement"
}
}
],
"links": {
"first": "/earning_types?page=1",
"last": "/earning_types?page=3",
"prev": null,
"next": "/earning_types?page=2"
},
"meta": {
"current_page": 1,
"last_page": 3,
"per_page": 15,
"total": 41,
"has_more": true
}
}Earning Types
List earning types
GET
/
earning_types
List earning types
curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/earning_types \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "bonus_discretionary",
"label": "Bonus (Discretionary)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/bonus_discretionary"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "bonus_non_discretionary",
"label": "Bonus (Non-Discretionary)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/bonus_non_discretionary"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "bonus_non_taxable",
"label": "Bonus (Non-Taxable)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/bonus_non_taxable"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "commission",
"label": "Commission (Non-Periodic)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/commission"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "commission_periodic",
"label": "Commission (Periodic)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/commission_periodic"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "commission_self_employed",
"label": "Commission (Self-employed)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/commission_self_employed"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "death_benefit",
"label": "Death Benefit",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/death_benefit"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "gift_cash",
"label": "Gift (Cash)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/gift_cash"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "gratuity",
"label": "Gratuity",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/gratuity"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "in_lieu_wages",
"label": "In Lieu Wages (Dismissal Pay)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/in_lieu_wages"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "income_replacement_indemnity_non_taxable",
"label": "Income Replacement Indemnity (Non-Taxable)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/income_replacement_indemnity_non_taxable"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "income_replacement_indemnity_taxable",
"label": "Income Replacement Indemnity (Taxable)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/income_replacement_indemnity_taxable"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "invoice_payment",
"label": "Invoice Payment",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/invoice_payment"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "invoice_sales_tax",
"label": "Invoice sales tax",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/invoice_sales_tax"
}
},
{
"id": "<id>",
"object": "earning_type",
"data": {
"type": "leave_bereavement",
"label": "Leave (Bereavement)",
"supported_payroll_types": {
"regular": true,
"historical": true,
"off_cycle": true
}
},
"links": {
"self": "/earning_types/leave_bereavement"
}
}
],
"links": {
"first": "/earning_types?page=1",
"last": "/earning_types?page=3",
"prev": null,
"next": "/earning_types?page=2"
},
"meta": {
"current_page": 1,
"last_page": 3,
"per_page": 15,
"total": 41,
"has_more": true
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200 - application/json
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 ("earning_type").
Hide child attributes
Hide child attributes
The string identifier for this earning type.
The human-readable display name for this earning type.
⌘I

