With Oyster’s Zapier integration, you can now automate your payroll change workflows even more. The Oyster Zapier integration supports the following actions:
- Create a payroll change
- Delete a payroll change
- Update a payroll change
- Find payroll changes
Prerequisites
Before using Zapier for payroll changes, make sure you follow this help article and correctly set up the Zapier integration with Oyster.
Required fields for each action
The actions to delete or update a payroll change include the following field:
- Payroll change ID - required
The action to create a payroll change includes the following fields:
- Engagement ID - required, the ID of the team member for who the payroll change should be created. Note: you can see the engagement IDs for all your team members in the "Team member report", which you can download from Company > Reports.
- Type - required, the type of the payroll change. Valid values include BONUS, COMMISSION, EMPLOYER_PENSION_RETIREMENT_CONTRIBUTION, HEALTH_INSURANCE, RISK_INSURANCE, TRAVEL_ALLOWANCE, WORK_FROM_HOME_ALLOWANCE, WELLBEING, MEALS
- Year - required, number, the year the payroll change will be paid
- Month - required, number, the month the payroll change will be paid
- Amount - required, number, the gross amount to be paid, in the Team Member's currency
- Currency - required, the Team Member's currency in the ISO 4217 standard
- Notes - optional
The action to find payroll changes includes the following fields:
- Engagement ID - optional, the ID of the team member
- From - optional, in YYYY-MM format
- To - optional, in YYYY-MM format
- Page - optional, number
- Per page - optional, number
Using a spreadsheet to submit payroll changes
Setting up the Trigger
You can set up a Zap between Google Sheets or another supported spreadsheet app and Oyster, allowing you to submit payroll changes in bulk. To do so, you must first decide which supported spreadsheet app you would like to use and set the Trigger as that app. Then, you must choose the trigger event from the available options.
You will then be asked to authorize your account on the spreadsheet app you would like to link.
At this point, depending on your chosen event, you will be asked to choose the spreadsheet where the new payroll changes will be added. You must make sure the linked spreadsheet contains the required fields listed above.
To get started, you can make a copy of this template that includes all the relevant columns needed to create payroll changes.
Setting up the action
After choosing Oyster as the Action app, you can choose “Create Payroll change” as the Event. You will then be asked to authorize your Oyster account.
You will now need to map the fields in the spreadsheet you’ve selected to the Oyster fields. Any required fields are marked with an asterisk.
You will then be able to test the zap before it is published. At this point, you can identify if any values are submitted in the wrong format, and Zapier will return an error.
Once you verify the zap works, you can publish and have your payroll changes synced automatically with Oyster!