---
availability: INSTALLABLE
description: A plugin that helps employees view a consolidated summary of salary,
bonus, and other compensation details in one snapshot.
installation_asset_uuid: 45574e05-cb65-420c-9cbf-3b94a4d04eaf
name: Summarize Total Compensation
purple_chat_link: https://marketplace.moveworks.com/purple-chat?conversation=%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22Employee+Compensation%22%7D%5D%2C%22messages%22%3A%5B%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Can+you+provide+my+compensation+details%2C+including+salary+and+bonus%2C+for+the+first+quarter+of+2019%3F%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Identifying+the+user+in+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%2C%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22User+identified+successfully.+Retrieving+salary+and+bonus+details+for+Q1+2019.%22%7D%5D%7D%2C%7B%22richText%22%3A%22Here+are+your+salary+and+bonus+details+for+the+period+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EJanuary+1%2C+2019%3C%2Fb%3E+to+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EMarch+31%2C+2019%3C%2Fb%3E%3A%22%7D%2C%7B%22richText%22%3A%22%3Cul+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3E%3Cli%3E%3Cb%3EAnnual+Base+Salary%3C%2Fb%3E%3A+%2495%2C500+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EBase+Salary+%28per+pay+period%29%3C%2Fb%3E%3A+%243%2C979+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EFrequency%3C%2Fb%3E%3A+Bi-Weekly%3C%2Fli%3E%3Cli%3E%3Cb%3EBonus+Target%3C%2Fb%3E%3A+%246%2C500+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EBonus+Paid%3C%2Fb%3E%3A+%246%2C000+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EPay+Range%3C%2Fb%3E%3A+PR-US-SU-09%3C%2Fli%3E%3Cli%3E%3Cb%3ECompa+Ratio%3C%2Fb%3E%3A+1.1200%3C%2Fli%3E%3Cli%3E%3Cb%3ERange+Penetration%3C%2Fb%3E%3A+0.8100%3C%2Fli%3E%3Cli%3E%3Cb%3ECurrency%3C%2Fb%3E%3A+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EEvent+Reason%3C%2Fb%3E%3A+New+Hire+Compensation%3C%2Fli%3E%3C%2Ful%3E%22%7D%2C%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22View+Quarterly+Summary%22%7D%5D%7D%5D%7D%2C%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22What+were+my+total+salary+and+bonus+for+the+entire+year+2019%3F%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Retrieving+full+year+salary+and+bonus+details+for+2019+from+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%5D%7D%2C%7B%22richText%22%3A%22Here+are+your+salary+and+bonus+details+for+the+full+year+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EJanuary+1%2C+2019%3C%2Fb%3E+to+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EDecember+31%2C+2019%3C%2Fb%3E%3A%22%7D%2C%7B%22richText%22%3A%22%3Cul+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3E%3Cli%3E%3Cb%3EAnnual+Base+Salary%3C%2Fb%3E%3A+%2498%2C000+USD%3C%2Fli%3E%3Cli%3E%3Cb%3ETotal+Bonus+Target%3C%2Fb%3E%3A+%2426%2C000+USD%3C%2Fli%3E%3Cli%3E%3Cb%3ETotal+Bonus+Paid%3C%2Fb%3E%3A+%2424%2C500+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EFrequency%3C%2Fb%3E%3A+Semi-Monthly%3C%2Fli%3E%3Cli%3E%3Cb%3EPay+Range%3C%2Fb%3E%3A+PR-US-SU-09%3C%2Fli%3E%3Cli%3E%3Cb%3ECompa+Ratio%3C%2Fb%3E%3A+1.1500%3C%2Fli%3E%3Cli%3E%3Cb%3ERange+Penetration%3C%2Fb%3E%3A+0.8300%3C%2Fli%3E%3Cli%3E%3Cb%3ECurrency%3C%2Fb%3E%3A+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EEvent+Reason%3C%2Fb%3E%3A+Performance+Review%3C%2Fli%3E%3C%2Ful%3E%22%7D%2C%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22View+Annual+Compensation+Report%22%7D%5D%7D%5D%7D%2C%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Could+you+display+only+my+salary+for+2019%2C+excluding+bonuses%3F%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Retrieving+only+salary+details+for+2019+from+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%5D%7D%2C%7B%22richText%22%3A%22Here+is+your+salary+information+for+the+full+year+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EJanuary+1%2C+2019%3C%2Fb%3E+to+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EDecember+31%2C+2019%3C%2Fb%3E%3A%22%7D%2C%7B%22richText%22%3A%22%3Cul+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3E%3Cli%3E%3Cb%3EAnnual+Base+Salary%3C%2Fb%3E%3A+%2498%2C000+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EBase+Salary+%28per+pay+period%29%3C%2Fb%3E%3A+%244%2C083+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EFrequency%3C%2Fb%3E%3A+Bi-Weekly%3C%2Fli%3E%3Cli%3E%3Cb%3EPay+Range%3C%2Fb%3E%3A+PR-US-SU-09%3C%2Fli%3E%3Cli%3E%3Cb%3ECompa+Ratio%3C%2Fb%3E%3A+1.1500%3C%2Fli%3E%3Cli%3E%3Cb%3ERange+Penetration%3C%2Fb%3E%3A+0.8300%3C%2Fli%3E%3Cli%3E%3Cb%3ECurrency%3C%2Fb%3E%3A+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EEvent+Reason%3C%2Fb%3E%3A+Annual+Increment%3C%2Fli%3E%3C%2Ful%3E%22%7D%2C%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22View+Salary+Statement%22%7D%5D%7D%5D%7D%5D%7D
solution_tags:
- Finance - Payroll
- HR - Employee Records
systems:
- sap-success-factors
---
## Introduction
The “**Summarize Total Compensation**” plugin enables users to easily view their complete compensation details— including annual salary and bonus information—directly through the Moveworks AI Assistant in SAP SuccessFactors. It focuses exclusively on summarizing individual compensation data, helping employees quickly access and understand their total earnings.
This guide will walk you through how to install and configure the plugin in Agent Studio in just a few minutes. Let’s get started!
## **Prerequisites**
- Access to Agent Studio
## **What are we building?**
### Agent Design
This [purple chat](https://marketplace.moveworks.com/purple-chat?conversation=%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22Employee+Compensation%22%7D%5D%2C%22messages%22%3A%5B%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Can+you+provide+my+compensation+details%2C+including+salary+and+bonus%2C+for+the+first+quarter+of+2019%3F%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Identifying+the+user+in+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%2C%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22User+identified+successfully.+Retrieving+salary+and+bonus+details+for+Q1+2019.%22%7D%5D%7D%2C%7B%22richText%22%3A%22Here+are+your+salary+and+bonus+details+for+the+period+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EJanuary+1%2C+2019%3C%2Fb%3E+to+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EMarch+31%2C+2019%3C%2Fb%3E%3A%22%7D%2C%7B%22richText%22%3A%22%3Cul+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3E%3Cli%3E%3Cb%3EAnnual+Base+Salary%3C%2Fb%3E%3A+%2495%2C500+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EBase+Salary+%28per+pay+period%29%3C%2Fb%3E%3A+%243%2C979+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EFrequency%3C%2Fb%3E%3A+Bi-Weekly%3C%2Fli%3E%3Cli%3E%3Cb%3EBonus+Target%3C%2Fb%3E%3A+%246%2C500+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EBonus+Paid%3C%2Fb%3E%3A+%246%2C000+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EPay+Range%3C%2Fb%3E%3A+PR-US-SU-09%3C%2Fli%3E%3Cli%3E%3Cb%3ECompa+Ratio%3C%2Fb%3E%3A+1.1200%3C%2Fli%3E%3Cli%3E%3Cb%3ERange+Penetration%3C%2Fb%3E%3A+0.8100%3C%2Fli%3E%3Cli%3E%3Cb%3ECurrency%3C%2Fb%3E%3A+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EEvent+Reason%3C%2Fb%3E%3A+New+Hire+Compensation%3C%2Fli%3E%3C%2Ful%3E%22%7D%2C%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22View+Quarterly+Summary%22%7D%5D%7D%5D%7D%2C%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22What+were+my+total+salary+and+bonus+for+the+entire+year+2019%3F%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Retrieving+full+year+salary+and+bonus+details+for+2019+from+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%5D%7D%2C%7B%22richText%22%3A%22Here+are+your+salary+and+bonus+details+for+the+full+year+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EJanuary+1%2C+2019%3C%2Fb%3E+to+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EDecember+31%2C+2019%3C%2Fb%3E%3A%22%7D%2C%7B%22richText%22%3A%22%3Cul+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3E%3Cli%3E%3Cb%3EAnnual+Base+Salary%3C%2Fb%3E%3A+%2498%2C000+USD%3C%2Fli%3E%3Cli%3E%3Cb%3ETotal+Bonus+Target%3C%2Fb%3E%3A+%2426%2C000+USD%3C%2Fli%3E%3Cli%3E%3Cb%3ETotal+Bonus+Paid%3C%2Fb%3E%3A+%2424%2C500+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EFrequency%3C%2Fb%3E%3A+Semi-Monthly%3C%2Fli%3E%3Cli%3E%3Cb%3EPay+Range%3C%2Fb%3E%3A+PR-US-SU-09%3C%2Fli%3E%3Cli%3E%3Cb%3ECompa+Ratio%3C%2Fb%3E%3A+1.1500%3C%2Fli%3E%3Cli%3E%3Cb%3ERange+Penetration%3C%2Fb%3E%3A+0.8300%3C%2Fli%3E%3Cli%3E%3Cb%3ECurrency%3C%2Fb%3E%3A+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EEvent+Reason%3C%2Fb%3E%3A+Performance+Review%3C%2Fli%3E%3C%2Ful%3E%22%7D%2C%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22View+Annual+Compensation+Report%22%7D%5D%7D%5D%7D%2C%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Could+you+display+only+my+salary+for+2019%2C+excluding+bonuses%3F%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Retrieving+only+salary+details+for+2019+from+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%5D%7D%2C%7B%22richText%22%3A%22Here+is+your+salary+information+for+the+full+year+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EJanuary+1%2C+2019%3C%2Fb%3E+to+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EDecember+31%2C+2019%3C%2Fb%3E%3A%22%7D%2C%7B%22richText%22%3A%22%3Cul+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3E%3Cli%3E%3Cb%3EAnnual+Base+Salary%3C%2Fb%3E%3A+%2498%2C000+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EBase+Salary+%28per+pay+period%29%3C%2Fb%3E%3A+%244%2C083+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EFrequency%3C%2Fb%3E%3A+Bi-Weekly%3C%2Fli%3E%3Cli%3E%3Cb%3EPay+Range%3C%2Fb%3E%3A+PR-US-SU-09%3C%2Fli%3E%3Cli%3E%3Cb%3ECompa+Ratio%3C%2Fb%3E%3A+1.1500%3C%2Fli%3E%3Cli%3E%3Cb%3ERange+Penetration%3C%2Fb%3E%3A+0.8300%3C%2Fli%3E%3Cli%3E%3Cb%3ECurrency%3C%2Fb%3E%3A+USD%3C%2Fli%3E%3Cli%3E%3Cb%3EEvent+Reason%3C%2Fb%3E%3A+Annual+Increment%3C%2Fli%3E%3C%2Ful%3E%22%7D%2C%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22View+Salary+Statement%22%7D%5D%7D%5D%7D%5D%7D) shows the experience we are going to build.
## Installation Steps
While you can create a connector during plugin installation, we recommend setting up the connector in **Agent Studio** beforehand to simplify the process. Please follow our [**SAP SuccessFactors Connector Guide**](https://marketplace.moveworks.com/connectors/sap-success-factors?hist=home%2Cbrws) for detailed instructions. Once completed, refer to our plugin installation documentation to install the **Summarize Total Compensation** plugin in minutes.
For **Summarize Total Compensation**, ensure the following permissions are enabled in SAP SuccessFactors:
**Required Scopes:**
- `View Employee Salary Information`
- `View Employee Bonus Information`
- `User Profile View Access`
Note: Equity, stock, or RSU details are not available as standard SAP SuccessFactors entities and cannot be queried using the OData APIs. Please refer to the [**SAP SuccessFactors OData API documentation**](https://api.sap.com/) for more information.
After configuring the connector, refer to our [**plugin installation documentation**](https://help.moveworks.com/docs/ai-agent-marketplace-installation) for more details on completing the setup
## **Appendix**
### **API #1: GET USER ID BY EMAIL**
```bash
curl --request GET \
--url 'https://<API_SERVER_DOMAIN>/odata/v2/User?$filter=email%20eq%20%27{{user_email}}%27&$select=userId,username' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```
**Query Parameters:**
- `$filter` (string) – Filters users based on the provided email address.
- `$select` (string) – Specifies which properties to return
### **API #2: GET EMPLOYEE COMPENSATION (Salary & Bonus)**
```bash
curl --request GET \
--url 'https://<API_SERVER_DOMAIN>/odata/v2/EmpCompensation?$filter=userId%20eq%20%27{{user_id}}%27%20and%20startDate%20ge%20datetime%27{{start_date}}%27%20and%20startDate%20le%20datetime%27{{end_date}}%27&$expand=empPayCompRecurringNav,empCompensationCalculatedNav&$select=userId,startDate,lastModifiedDateTime,effectiveLatestChange,endDate,createdDateTime,createdOn,bonusTarget,payrollSystemId,event,benefitsRate,isHighlyCompensatedEmployee,lastModifiedBy,prorationFactor,eventReason,lastModifiedOn,payGroup,isEligibleForCar,createdBy,isInsider,compensationStructure,isEligibleForBenefits,empPayCompRecurringNav/payComponent,empPayCompRecurringNav/seqNumber,empPayCompRecurringNav/userId,empPayCompRecurringNav/startDate,empPayCompRecurringNav/lastModifiedDateTime,empPayCompRecurringNav/notes,empPayCompRecurringNav/effectiveLatestChange,empPayCompRecurringNav/endDate,empPayCompRecurringNav/lastModifiedBy,empPayCompRecurringNav/createdDateTime,empPayCompRecurringNav/createdOn,empPayCompRecurringNav/frequency,empPayCompRecurringNav/lastModifiedOn,empPayCompRecurringNav/createdBy,empPayCompRecurringNav/paycompvalue,empPayCompRecurringNav/currencyCode,empCompensationCalculatedNav/seqNumber,empCompensationCalculatedNav/startDate,empCompensationCalculatedNav/yearlyBaseSalary,empCompensationCalculatedNav/rangePenetration,empCompensationCalculatedNav/errorMessage,empCompensationCalculatedNav/errorCode,empCompensationCalculatedNav/currency,empCompensationCalculatedNav/compaRatio,empCompensationCalculatedNav/payRange' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```
**Query Parameters:**
- `$filter` (string) – Filters compensation records based on `userId` and date range.
- `$expand` (string) – Expands related entities such as recurring pay components and calculated compensation.
- `$select` (string) – Specifies which properties to return.