put https://api.elliemae.com/encompass/v3/users//compensationPlans
Used to Add (assign), Update, or Delete future user compensation plans for a specified Encompass internal user.
This API endpoint added with the 24.2 release of Encompass.
Usage Notes
- Access Rights
- Only administrators (admin account, Super Administrator persona, and/or Administrator persona) or non-admin users with the Settings “Organizations/User” persona can update user accounts.
- The calling user only has access to update users within their same organization, or lower child organizations of their organization.
- To retrieve a list of compensation plans from your instance, use GET /encompass/v3/settings/fees/loCompensationPlans .
- Current and Historical Compensation Plans are read-only and cannot be updated.
- Future Compensation Plans
- Only Future Plans can be included in the request payload.
- The ‘startDate’ is required, and cannot be earlier than tomorrow’s date.
- After you add a future plan with a startDate equal to tomorrow’s date, this becomes the ‘currentPlan’. After this is done, the ‘currentPlan’ cannot be deleted.
- To Add additional future plans, the request must include any existing future plans, as well as the plans you wish to add. The entire ‘futurePlans’ collection is replaced with what is provided in the request body.
- To remove all future plans, send the futurePlans array as empty. To only remove specific plans, send the futurePlans array with only the plans that should remain. The entire ‘futurePlans’ collection is replaced with what is provided in the request body.
© ICE Mortgage Technology, Inc. All rights reserved.