Write Deduction, Earning & Tax

this guide provides a step by step walkthrough on how to add earnings in adp using bindbee write api pre requisites 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 adp connector go to the bindbee dashboard and open the adp connector in which you want to create the payroll entry make sure that the connector has completed a successful data sync before creating the payroll entry, open the get create employee payroll run meta api to authenticate and authorise the request, provide your bindbee api key in the authorization header the relevant connector token in the x connector token header and click send the response returns the request schema and the values supported by the connected adp account note the available values can differ between adp accounts, so always review the meta api response before creating the payroll entry step 2 retrieve the employee id now we need to get the bindbee id of the employee for whom we want to add the earning open the get employees api add the same authorization and x connector token headers used in the previous request, and then click send the api will return the employee data available through the connector find the relevant employee and copy the value from the top level id field this is the bindbee employee id that will be used in the create employee payroll run request step 3 open the create employee payroll run api now that we have the employee id, open the create employee payroll run api this endpoint is used to add an earning, deduction, or tax entry for an employee in adp workforce now make sure that the request method is post add the same authentication headers used in the previous requests step 4 add the employee id paste the employee id copied from the get employees response into the employee field step 5 add the earning details to add an entry to the earnings array, we will create a regular earning entry use the meta api response to confirm the earning codes available for the connected adp account to create a deduction instead, use the deductions array and provide one of the supported deduction codes returned by the meta api to submit tax related information, use the supported value returned for the taxes field step 6 add a payroll process name next, provide a recognisable payroll process name this name will help you identify the entry when verifying it in adp workforce now step 7 find the employee’s payroll file number to find the employee’s payroll file number, open the adp workforce now dashboard and go to the people section select employment profile and locate the employee for whom you are creating the payroll entry open the employee’s employment tab and find the position card the employee’s payroll file number will be displayed in this section paste this number into the payroll file field inside integration params step 8 add the payroll group code you can find the available payroll group codes in the get create employee payroll run meta response add the value to the payroll group code field inside integration params step 9 submit the payroll entry once all the required information has been entered, click send a successful api response confirms that the employee payroll entry has been submitted to adp workforce now step 10 verify the entry in adp workforce now to verify that the earning has been added, return to the adp workforce now dashboard go to the process tab and open payroll dashboard click manage payroll find the payroll entry using the payroll process name provided in the request you have now successfully created and verified an employee payroll entry in adp workforce now using bindbee’s create employee payroll run api