What Payero is being built to calculate
The planned API calculates payroll deductions, net pay and employer contributions from payroll data supplied by your platform. Planned coverage includes all 13 provinces and territories, including Québec.
Your platform supplies approved gross earnings. Payero’s calculation layer does not determine an employee’s contractual entitlement to wages or independently verify the information your business provides.
What your platform supplies
A calculation needs the applicable province or territory of employment, pay dates, approved gross earnings, employee and employer information, applicable elections, and sufficient opening balances or payroll history.
The required facts depend on the calculation. The planned service is designed to return diagnostics when required information is missing or unsupported, rather than guess facts or present an incomplete result as complete.
The planned calculation results
These are the planned result categories. The field names below are examples, not a final response schema.
- Net pay
net_pay - The cash amount payable after applicable deductions. Taxable non-cash benefits may affect those deductions.
- Payroll deductions
employee_deductions - Itemized amounts withheld from employee pay, including applicable source deductions.
- Employer contributions
employer_obligations - Employer contributions and other applicable employer payroll amounts, shown separately from payroll deductions and cash net pay.
- Rule version
rule_version - A reference to the calculation rules and version used for the result.
- Calculation reference
receipt_id - A reference your platform can associate with the calculation result.
Who keeps the payroll record
Your platform manages employee records and supplies the payroll facts and history needed for each request. The planned calculation service leaves payroll state and returned results with the client.
Your platform retains results, approves payroll, applies approved changes and manages payments, remittances and payroll reporting, including information slips and summaries. A calculation result does not itself approve payroll or move money.
Why calculation versions matter
Canadian payroll rules change over time. The planned service ties calculations to a defined version so clients can understand the rules and implementation behind a result.
Versioned replay is part of the planned scope. Availability, supported versions and lifecycle details will be documented before production access.
How we plan to validate results
The planning criteria call for independently established expected results, traceable to dated governing sources. Checks are planned across supported jurisdictions, rule years and edition boundaries.
These checks cover payroll deductions, cash net pay, employer contributions and changes to payroll balances. Missing-input failures and reproduction of results with retained calculation versions are also part of the criteria.
This is a validation plan. Validation against applicable payroll requirements has not been completed; passed payroll test results are not yet available.
Terms explained
These short definitions explain the wording used on this site.
- API
- Application programming interface. A way for one software system to request data or results from another.
- HR
- Human resources: the work of managing people in an organisation.
- PCP
- Payroll Compliance Professional: a professional payroll designation.
- Payroll deductions
- Amounts taken from employee pay, such as income tax deductions.
- Net pay
- Money to be paid to the employee after payroll deductions.
- Employer contributions
- Amounts paid by the employer in addition to employee pay.
- Versioned calculation
- A result linked to the set of payroll rules used. Planned replay would run the same data with that same version.