This API allows you to send employees' regular, overtime (OT), double overtime (DOT) hours and other earnings such as bonuses, tips, and commissions etc. It directly interacts with our payroll system to process the earnings being sent for a pay period. The data shared through the API is processed when regular payroll for that pay period is initiated.

Business Rules

• If a specific amount is being sent for regular wages, it will be used for payroll purposes regardless of the rate or hours sent through the API or already available in the system.
• If only the hours and rate are being sent, the system will calculate the earnings value. Overtime and double overtime wages will be calculated based on the regular rate sent through the API or the rate available on the employee profile.
• The job code is mandatory when sending the information. If no specific job code is provided, the default job code to use is always '001', which represents the 'Primary Job'.
• For non-exempt employees who are eligible for overtime, only the hours for overtime and double overtime should be sent. System will determine the rate as 1.5 or 2.0 times of the regular rate to calculate the overtime and double overtime wages respectively.
• For break premiums, provide the job codes to which they apply. If no specific job code is available, use '001', which represents the 'Primary Job'.
• Earnings cannot be posted for employees whose hire date falls after the requested pay period.
• For hourly employees, if multiple rates are applicable in the pay period for Primary Job then rate effective date needs to be specified for each rate. All the dependent earnings like Overtime, Double Overtime etc. should also have the same date as applicable for regular wage.