Mapping Hourly Rates and Employees
Once the Organisation/Employer has been selected the Employer's Hourly Rates and Employees can be retrieved from the Payroll API. Then the user can map Hourly Rates and Employees between the Timesheet application and BrightPay in preparation for the upload of the TimeSheet data. Also, any previously stored Hourly Rates and Employee mappings can be loaded to reduce the user effort.
Mapping Hourly Rates
In order to map Hourly Rates between the Timesheet application and BrightPay, please retrieve from Payroll API the Hourly Rates using GetEmployerHourlyRates. For any listbox presented for selection use the field rateNameWithHint as the display value and the field rateName as the identifier.
It is important to use rateNameWithHint for the display value as around the turn of the financial year the Payroll API may be working across two financial years. During this time the Hourly Rates may be returned with a hint indicating which year the rate is set up for. However, the rateName field should be passed in the request to create hourly payments and should be saved when storing the mapping for future use.
Mapping Employees
In order to map Employees between the Timesheet application and BrightPay, please retrieve from Payroll API the Employees using GetEmployees. Then for any list presented for selection use the field fullNameWithHint as the display value and the field employeeId as the identifier.
It is important to use fullNameWithHint for the display value as around the turn of the financial year the Payroll API may be working across two financial years. During this time the Employees may be returned with a hint indicating which year the rate is set up for. However, the employeeId field should be passed in the request to create hourly payments and should be saved when storing the mapping for future use.
Last updated