HolidayCalc API
The PaymentEvolution REST API uses standard HTTP authorization header to pass authorization information. The Authorization header has the following form:
Authorization: PE signature= <issued signature token>
Overview:
The PaymentEvolution HolidayCalc API calculates statutory holiday pay.
| Endpoint | /api/v2/holidaycalc |
| Methods supported | POST |
| Description | Allows you to calculate statutory holiday pay for all provinces and territories. |
* Note: All elements are required. An empty string or 0 is sufficient.
| Elements | Expected input | Description |
| Province | String: AB BC MB NB NL NS NT NU ON PE QC SK YT | Two letter province abbreviation. Province of legislation. |
| StatHoliday | Date | Date of holiday. |
| StatHolidayName | String | Name of holiday. E.g. “New Year’s Day” |
| RegularWages | Decimal | Regular wages earned during a specified period. E.g. 3475.93 |
| EarnSame | Yes/No | Whether the employee earns the same amount of regular wages each week. |
| VacPay | Decimal | Amount of vacation pay earned. E.g. 203.43 |
| HoursWorked | Decimal | Number of hours worked on the holiday. E.g. 7 |
| HourlyRate | Decimal | Employee’s hourly rate. E.g. 15 |
| Commissions | Yes/No | Whether the employee earns commissions. |
| Incentive | Decimal | The amount of incentive pay earned. E.g. 110.43 |
| HoursPayPeriod | Decimal | Number of hours worked in a given pay period. E.g. 100 |
| HowManyDays | Int | The number of days worked in a given period. E.g. 21 |
| NormalHours | Decimal | The number of hours normally worked in a day. E.g. 7.5 |
| WagesCD | Decimal | Yukon specific: Wages earned in a given period. E.g. 2784.56 |
| HoursVary | Yes/No | Whether the employee’s hours of work or wages vary. |
| Daytoday | Yes/No | Whether the employee’s wages vary from day to day. |
| TimeBasis | Yes/No | Whether the employee has their wages calculated on the basis of time. |
| Applicable | String: A B C D | Yukon specific: “A” if the employee works irregular hours or less than the standard hours. “B” if the employee works a standard number of hours and has an hourly wage.”C” if the employee works a standard number of hours and is paid a commission or on a piece-work basis. “D” if the employee works a standard number of hours and earns a weekly or monthly salary. Other provinces: “”. |
Sample Code:
{
"Province":"AB",
"StatHoliday":"Mon Jan 02 2023",
"StatHolidayName":"New Year's Day",
"RegularWages":"3473.93",
"EarnSame":"",
"VacPay":"0",
"HoursWorked":"7",
"HourlyRate":"15",
"Commissions":"",
"Incentive":"0",
"HoursPayPeriod":"0",
"HowManyDays":"20",
"NormalHours":"0",
"WagesCD":"0",
"HoursVary":"",
"Daytoday":"",
"TimeBasis":"",
"Applicable":""
}
