Enterprise Quick Start
You are the CEO of ACME Ltd, maker of fine anvils since 1903.
You would like to integrate with Wagestream so that your hard-working anvil-makers can pay themselves whenever they want.
This involves several steps:
- Tell Wagestream some basic information about your employees
- Find out which employees have requested to enrol in Wagestream
- Tell Wagestream some additional information about enrolled employees
- Tell Wagestream about the shifts of enrolled employees
Tell Wagestream some basic information about your employees
The employees file is how you tell Wagestream about your staff. It's a single data file that handles both new joiners and changes in your employee population (including leavers). Simply send a list of employees as a .csv, like so:
Example file
Download an example of the basic data to send Wagestream on your employees. Please note when opening a CSV file, your date format may incorrectly change to DD/MM/YYYY. The upload format for Wagestream is YYYY-MM-DD.
Find out which employees have requested to enrol in Wagestream
When an employee starts using Wagestream, they will be in a "pending enrolment" state. The employee will not be able to access any wages until the employer (you!) completes their enrolment.
The "enrolments" file will return a list of all the employees who have requested to enrol in Wagestream, and in this example only two of the three employees have requested to enrol in Wagestream. This is Wile and Bugs.
Example file
Download Enrolments File example. Please note when opening a CSV file, your date format may incorrectly change to DD/MM/YYYY. The upload format for Wagestream is YYYY-MM-DD.
The field bank_name will inform about whether the bank account was created for an employee. If the return value:
- Is
Wagestream, these are the bank accounts Wagestream has created on behalf of that employee. - is
UNKNOWN BANK, this means that we are either waiting for you to supply bank account details via the Employees file, or there has been an error activating this employee. - Is some other bank name, it means an employee is no longer enrolled in Wagestream, and, in this case, the other banking fields will be populated with the employees original bank account information.
null is returned for people who do not have banking at all (neither beneficiary nor Wagestream). This can happen when employee is pushed without any banking details to us.
Tell Wagestream some more information about your employees
Another employees file will be sent, but this time to a add additional data for the two enrolling employees, Wile and Bugs. Send us a file in the format as per the below
Example file
Download an example of the complete record to send Wagestream on your employees when they request to enrol. Please note when opening a CSV file, your date format may incorrectly change to DD/MM/YYYY. The upload format for Wagestream is YYYY-MM-DD.
Note: You are only sending data for the two employees that have requested to enrol.
You've now told Wagestream about the employees, and how much they have earned, but your employees won't be able to use Wagestream yet because they haven't been activated.
You can find more information about this data flow in the Time and Attendance ⏰ article.
Enrol pending employees
We return to the enrollments file from above. The file returned by Wagestream will now be slightly different, because the two employees who requested enrollment have complete information including banking.
Below is an example file of what will be returned.
Example file
Download Enrolements File example. Please note when opening a CSV file, your date format may incorrectly change to DD/MM/YYYY. The upload format for Wagestream is YYYY-MM-DD.
Note that bank_sort_code and bank_account_number are no longer null. The state has also changed from PENDING to TO_COMPLETE.
As CEO of ACME Ltd, you will need to update your payroll system with these bank details so that their pay check is deposited in the correct place.
There is no need to keep their old bank details in your payroll system; those bank details are securely encrypted and stored with Wagestream.... any payments sent to their Wagestream bank will automatically and instantly forward to their personal bank account.
When each employee is updated in payroll, the final step is to send the complete employee file for enrolled employees, which will allow the employee to start using the Wagestream platform
Tell Wagestream about the shifts of enrolled employees
The shifts data file is how you tell Wagestream that an employee has worked and earned some wages. The wages that you pass to this endpoint are the gross wages earned.
Let's imagine that Porkey Pig is sick, and hasn't worked this week, but Wile and Bugs have both worked. You might send the following information that's in the example file below.
Example file
Download Shifts File example. Please note when opening a CSV file, your date format may incorrectly change to DD/MM/YYYY. The upload format for Wagestream is YYYY-MM-DD.
Updated over 1 year ago