Skip to main content
Line item types include earning types, deduction types, allowance types, reimbursement types, and employee and employer benefit types. Different Line Item types in Nmbr have different effects on payroll calculations, depending on multiple factors including:
  • the type of line item
  • the Work Assignments Province Of Employment (POE)
  • the tax documents which have been completed
You can use the Nmbr API to get an overview of the ways in which different line item types are treated in payroll calculations.

​
Payroll Features Query

When using the Line Item Types APIs, you may pass a features query parameter with the value ca. The response will then contain a features array, which details how each line item type is treated in payroll calculations. This query can be used with the following endpoints: Request 
curl --request GET \
     --url https://sandbox.nmbr.co/services/payroll/earning_types/salary?features=ca \
     --header 'Authorization: Bearer <access_token>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
Response 
{
  "id": "salary",
  "object": "earning_type",
  "data": {
    "type": "salary",
    "label": "Salary",
    "supported_payroll_types": {
      "regular": true,
      "historical": true,
      "off_cycle": true
    },
    "features": [
      {
        "type": "income_tax",
        "label": "Income Tax",
        "definitions": [
          {
            "jurisdiction": "ca_federal",
            "effects": [
              "withholding"
            ],
            "help_text": null,
            "program_label": null
          }
          // ...
        ]
      }
    ]
  }
}

​
Definitions

Each entry in the features array contains:
  • type: The type of payroll feature.
  • definitions: Details on how the line item type is treated for each jurisdiction. These fields are informational and don’t describe rates, thresholds, or full calculation logic. If an entry is missing for a given jurisdiction, it means that the line item type has no effect for that payroll treatment in that jurisdiction.

​
Payroll feature types

The possible values for the type field are:
  • income_tax: Federal and Provincial/Territorial Income tax withholding calculations.
  • pensionable: Federal and Quebec pension plans, such as the Canada Pension Plan (CPP) and Quebec Pension Plan (QPP).
  • insurable: Federal and Quebec insurance plans, such as the Employment Insurance (EI) and Quebec Parental Insurance Plan (QPIP).
  • wcb: Workers’ Compensation Board contributions, which vary by province.
  • eht: Employer Health Tax contributions, applicable in certain provinces.
  • vacationable: Provincial rules for vacation pay accrual on remuneration.

​
Definition fields

Each entry in the definitions array contains:
  • jurisdiction: The jurisdiction to which the definition applies, e.g. ca_federal, ca_on, ca_bc, etc.
  • effects: An array of effects that the line item type has for the given jurisdiction and payroll feature type. Possible effects include:
    • withholding: The line item type is included in the calculation base for withholding calculations.
    • reduces_base: The line item type reduces the base amount for the given payroll feature.
    • tax_credit: The line item type provides a tax credit for the given payroll feature.
    • accrues_vacation_pay: The line item type accrues vacation pay.
  • help_text: Additional information or context about the feature, if applicable.
  • program_label: The specific program or plan label associated with the feature, if applicable. E.g., “CPP”, “EI”, etc.