Skip to main content

​
Capture employee information

Creating an employee in Nmbr requires providing the required information to the employee API endpoint. Request 
curl --request POST \
     --url https://sandbox.nmbr.co/services/payroll/employees \
     --header 'Authorization: Bearer <access_token>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
        "employee_number": "69878",
        "first_name": "Kendall",
        "last_name": "Hintz",
        "middle_initial": null,
        "address_line_1": "Spencer Meadows",
        "address_line_2": null,
        "city": "Toronto",
        "province_code": "ON",
        "country_code": "CA",
        "postal_code": "M1M1M1",
        "sin": 366371964,
    }'
Response 
{
  "id": "01hhcy3hg60x3dq8hfj31hgyea",
  "object": "employee",
  "data": {
    "employee_number": "69878",
    "first_name": "Kendall",
    "last_name": "Hintz",
    "middle_initial": null,
    "address_line_1": "Spencer Meadows",
    "address_line_2": null,
    "city": "Toronto",
    "province_code": "ON",
    "country_code": "CA",
    "postal_code": "M1M1M1",
    "sin": 366371964,
    "is_archived": false,
    "created_at": "2023-12-11T17:16:57.000000Z",
    "updated_at": "2023-12-11T17:16:57.000000Z"
  },
  "links": {
    "self": "https://sandbox.nmbr.co/services/payroll/employees/01hhcy3hg60x3dq8hfj31hgyea"
  }
}

​
Work Assignments

A core concept in the Nmbr API is Work Assignments. Work Assignments allow you to attach an Employee and Pay-Rates to a Pay Schedule. Work Assignments offer a flexible data architecture to allow you to represent both simple and complex employment scenarios depending on your requirements. An Employee may have multiple Work Assignments, which can represent different jobs or work held by the employee within a single Business Entity. This may depend on your product needs and data architecture. When creating a Benefit, Deduction, Reimbursement, or Allowance, these entities are attached to a Work Assignment. This allows Nmbr to know which Pay-Schedule to apply these on.

​
How Business Entity influences Work Assignments

  • An Employee may have multiple Work Assignments within a single Company.
  • An Employee may only have one Work Assignment per Pay-Schedule.
  • A single Work Assignment may have multiple Pay-Rates.
  • CPP and EI Statutory Withholding limits are calculated across all Work Assignments for an Employee within a single Business Entity - meaning Employee and Employer contributions should not exceed their maximum contribution limits.
  • A Work Assignment may have a tax_jurisdiction defined. This allows you to set a Province Of Employment for the Employee that is different from that of the Business Entity. If you set this property, the Work Assignments Province Of Employment will be used for calculating Statutory Withholdings, and applicable Taxes on Benefits.

​
Creating a Work Assignment

curl --request POST \
     --url 'https://sandbox.nmbr.co/services/payroll/work_assignments' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <access_token>' \
     --data '{
         "employee_id": "<employee_id>",
         "pay_schedule_id": "<pay_schedule_id>"
         "tax_jurisdiction": "on"
}'

​
Removing a Work Assignment

  • Work Assignments may only be deleted when there are no Pay Stubs with a status of processing, failed, or paid.
  • A Work Assignment may be archived to remove it from future Payrolls. Archived Work Assignments are also removed by default from lists of Work Assignments.