This guide provides a step-by-step walkthrough on how to add employee earnings in ADP using Bindbee Write APIs.
Prerequisites:
Already have a connector in Bindbee with Payroll Write Permissions
Have a user with Permission to view Employee's Employment information and Payroll information in ADP Dashboard
Step 1: Open the Connector, which has ADP Payroll write permissions in Bindbee.
Step 2: Make sure that the data has been synced. Now, we need to get the ID of the employee for which we want to add earnings. To get that, go to Bindbee API documentation here.
Step 3: Select the GET Employee API. To authenticate and authorise a request, we need the Bindbee API key and x-connector-token. You can get the API Key from the API key section of the Bindbee Dashboard.
Make sure to add it in the headers in this format:
headers : { "Authorization" : "Bearer <your-api-key>"}
Step 4: Copy the Connector token for the connector you want to write the data in.
Step 5: Paste the x-connector-token in the headers of the API as follows :
Headers : {'x-connector-token' : <your-token-here>}
Step 6: Click on Send.
Step 7: This will return the employee data. Copy the ID of the employee for which you want to write the payroll earnings.
Step 8: Now that we have the employee id, click on Create Employee Payroll Run API
Step 9: Create a Postman or any other preferred tool of your choice request with the Create Employee Endpoint. Make sure that the request method is POST. Copy the Authorisation and X-connector-token headers from the previous request into this request. For the request body, use this body :
{ "employee": "01929ee7-20ac-7100-9c84-d89838e8f3f1", "earnings": [ { "code": "BN", "amount": 0.01 }, { "code": "R", "amount": 0.02 } ], "payroll_file": "000169", "payroll_process_name": "Hours, Earning Code" }
Step 10: Add the employee ID we had copied from the above step here. Next, we will need payroll_file information. To get that, open the ADP Dashboard and go to the People Section
Step 11: Go to Employment Profile
Step 12: In the Position Card, you can get the payroll file number. Copy it and paste it in the request body.
Step 13: Now add the appropriate payroll action name
Step 14: Add appropriate earnings details. Here two json objects have been added with code BN representing Bonus and R representing Regular Earnings, each of them with $0.3. Then make the request.
Step 15: To verify that earnings have been added, Go to ADP Dashboard and open the Process tab
Step 16: Open Payroll Dashboard
Step 17: Open Manage Payroll
Step 18: Find the earnings name that we just created and verify the earnings.