CDN Payroll Employees

This API uploads employees to the Canadian Payroll system.

The primary purpose of this API is to upload employee data. The built-in download is intended for testing and returns only fields that can be uploaded. Access to this API supersedes user field-level security restrictions.

User security

System Administration > Jonas Template Uploads > Canadian Payroll > Upload CDN Payroll: Employees

WebMethod

GJZF21J – required

Option

Template – get the employee data template
scan – error scan only
update – upload employees
download – download employee data for testing

CompanyCode

required

PayrollCode

required

DefaultEmployeeCode

required
A generic employee record containing typical default settings must be configured to use this program.

errorsFound

returned result

PR_EmployeeMaster_tbl

Field	Description
`EmployeeCode`	required
`LastName`	required
`FirstName`	required
`AddressLine1`
`AddressLine2`
`AddressLine3`	Enter a valid city and province here if you intend to use `MAGNETIC - T4`.
`PostalZipCode`
`PhoneNumber`
`Status`	`A` \| `T` • A – Active • T – Terminated
`SIN`	required
`DateOfBirth`	required
`DepartmentCode`
`OccupationCode`

PR_EmployeeMiscellaneousInformation_tbl

Field	Description
`DateOriginallyHired`
`EmergencyContactLine1`	maximum 35 characters
`EmergencyContactLine2`	maximum 35 characters
`DriverLicenceNumber`
`EmailAddress`	maximum 45 characters

PR_EmployeePaymentInformation_tbl

Field	Description
`UnionAffiliation`	Enter `NONE` if the employee is not affiliated with a union or group.
`HourlyOrSalaried`	`H` – Hourly `S` – Salaried
`StandardPayRate`	Enter 0 to use the standard pay rate set up in the applicable Union Agreement. Enter the hourly or salary amount if the employee is paid a standard rate per hour or pay period.
`StandardHoursPerPay`	Enter the standard number of hours worked per pay period (for example, 40 hours per week). Normally used only for automatic time entry.
`BankAccount`	Used for Direct Deposit. Leave a space between the 5-digit transit number, 3-digit institution identification, and account number (maximum 12 digits). To temporarily disable Direct Deposit, add a space and the letter `N` at the end of the banking information string.
`VacationPayOwing`	During initial start-up, enter the vacation pay owed to this employee.

PR_EmployeeTaxInformation_tbl

Use the underscored JSON property names shown in the template.

Field	Description
`Province_Code`
`Federal_Exemption`	Enter the federal exemption (Net Claim) amount from the employee's TD1 form; do not enter the Net Claim code. • Enter 0 to use the current year's Basic Personal Exemption amount. • Enter 999999 to make the employee tax exempt. • Enter 1 if the employee should claim no federal exemption (for example, a non-resident).
`Provincial_Exemption`	Enter the provincial exemption (Net Claim) amount from the employee's provincial TD1 form; do not enter the Net Claim code. • Enter 0 to use the current year's Basic Personal Exemption amount. • Enter 999999 to make the employee tax exempt. • For Quebec, enter the basic exemption.

PR_EmployeeSpareInfo_tbl

Field	Description
`SpareField1`	If this is to appear on the T4, see the F7 Jonas Note "Comment on T4s" for more information. If this amount is to be used to CAP Non-Taxable Earnings see F7 Jonas Note on Non Taxable Earnings CAP.
`SpareField2`	If this is to appear on the T4, see the F7 Jonas Note "Comment on T4s" for more information.
`SpareField3`	If this is to appear on the T4, see the F7 Jonas Note "Comment on T4s" for more information.
`SpareField4`	If this is to appear on the T4, see the F7 Jonas Note "Comment on T4s" for more information.

Template

{
  "WebMethod": "GJZF21J",
  "Option": "template",
  "CompanyCode": "",
  "PayrollCode": "",
  "DefaultEmployeeCode": "",
  "PR_EmployeeMaster_tbl": [{
    "EmployeeCode": "",
    "LastName": "",
    "FirstName": "",
    "AddressLine1": "",
    "AddressLine2": "",
    "AddressLine3": "",
    "PostalZipCode": "",
    "PhoneNumber": "",
    "Status": "A",
    "SIN": "",
    "DateOfBirth": "1970-01-01T00:00:00Z",
    "DepartmentCode": "",
    "OccupationCode": "",
    "PR_EmployeeMiscellaneousInformation_tbl": {
      "DateOriginallyHired": "1970-01-01T00:00:00Z",
      "EmergencyContactLine1": "",
      "EmergencyContactLine2": "",
      "DriverLicenceNumber": "",
      "EmailAddress": ""
    },
    "PR_EmployeePaymentInformation_tbl": {
      "UnionAffiliation": "",
      "HourlyOrSalaried": "H",
      "StandardPayRate": 0,
      "StandardHoursPerPay": 0,
      "BankAccount": "",
      "VacationPayOwing": 0
    },
    "PR_EmployeeTaxInformation_tbl": {
      "Province_Code": "",
      "Federal_Exemption": 0,
      "Provincial_Exemption": 0
    },
    "PR_EmployeeSpareInfo_tbl": {
      "SpareField1": "",
      "SpareField2": "",
      "SpareField3": "",
      "SpareField4": ""
    }
  }]
}

Scan example

{
  "WebMethod": "GJZF21J",
  "Option": "scan",
  "CompanyCode": "01",
  "PayrollCode": "WKLY",
  "PR_EmployeeMaster_tbl": [{
    "EmployeeCode": "JOHN",
    "LastName": "Doe",
    "FirstName": "John",
    "Status": "A",
    "DateOfBirth": "1941-12-07T00:00:00Z",
    "DepartmentCode": "AUTO",
    "OccupationCode": "TECH",
    "PR_EmployeePaymentInformation_tbl": {
      "UnionAffiliation": "NONE",
      "HourlyOrSalaried": "H",
      "StandardPayRate": 50
    }
  }]
}

Scan result with error

{
  "WebMethod": "GJZF21J",
  "Option": "scan",
  "CompanyCode": "01",
  "PayrollCode": "WKLY",
  "errors": ["DefaultEmployeeCode required"]
}

Successful scan result

{
  "WebMethod": "GJZF21J",
  "Option": "scan",
  "CompanyCode": "01",
  "PayrollCode": "WKLY",
  "DefaultEmployeeCode": "DEFLT",
  "RecordsProcessed": 1,
  "errorsFound": 0
}

Download single employee

The built-in download is intended for testing and returns only fields that can be uploaded.

{
  "WebMethod": "GJZF21J",
  "Option": "download",
  "CompanyCode": "01",
  "PayrollCode": "WKLY",
  "PR_EmployeeMaster_tbl": [{
    "EmployeeCode": "JOHN"
  }]
}

Download result with error

{
  "WebMethod": "GJZF21J",
  "Option": "download",
  "CompanyCode": "01",
  "PayrollCode": "WKLY",
  "errors": ["No recs found"]
}

Successful download result

{
  "WebMethod": "GJZF21J",
  "Option": "download",
  "CompanyCode": "01",
  "PayrollCode": "WKLY",
  "PR_EmployeeMaster_tbl": [{
    "EmployeeCode": "JOHN",
    "LastName": "Doe",
    "FirstName": "John",
    "Status": "A",
    "DateOfBirth": "1941-12-07T00:00:00Z",
    "DepartmentCode": "AUTO",
    "OccupationCode": "TECH",
    "PR_EmployeePaymentInformation_tbl": {
      "UnionAffiliation": "NONE",
      "HourlyOrSalaried": "H",
      "StandardPayRate": 50
    }
  }]
}