SAP Commissions - Productitive APIs for Quick CalculationService

[yogananda]

Dear All,

Most productive APIs provided will help to determine your Incentive calculation in quickest time without running a pipeline Job for Compensation Admins.

Calculation services are APIs which enables the Admin user to perform calculations in real-time.

Using these APIs, Comp Admins or developers can build applications which can automatically calculate the output of any given rule or rule elements expression without requiring any complicated algorithms.

The APIs usually provide support for basic and complex calculations and also provide interface for solving incentive/commissions calculations problems. Additionally, developers can also use them to graph functions, calculate derivatives, integrals and perform various other mathematical operations.

These APIs are used in a variety of applications such as SAP BTP Build Advanced Workzone or manual calculators and analysis tools.

Below APIs are available for Commissions tenants running on HANA and Oracle stack for customers.                 

This APIs are not available for GCP or SAP Commissions on Hyperscaler.  Kindly reach out to Commissions PM

Pre-requisites

● All the Rules and Payees used in the estimation is exist in the Commission product
● API for Calculation can only be done for active payee. Active payee is a payee associated to a
position with a plan assigned.
● API Authentication User should have permissions to Commissions Product

API to get the definition of an Incentive Rule

###

GET {{url}}/CallidusPortal/services/OutputReferenceService/getIncentiveRule/ITR_TelBMS_Indv_Connection_Total_Volume_Bonus?searchDate=2023-11-23
Content-Type: application/json
Authorization: Basic {{authtoken1}}

REST API to get Measurement and Incentive name

###

GET {{url}}/CallidusPortal/services/OutputReferenceService/getPrimaryMeasurementLike/pm?searchDate=2023-01-31
Content-Type: application/json
Authorization: Basic {{authtoken1}}

API to calculate an Incentive Rule for an active Payee and the given Measurements and Incentives:

###/CallidusPortal/services/CalculationService/incentive/{incentiveName}/{ruleName}/{positionName}/{payeeId}
POST {{url}}/CallidusPortal/services/CalculationService/incentive/inc2/IR_Revenue_Commission_Quarterly/User221/User221?searchDate=2022-01-31&returnCurrentValue=true
Content-Type: application/json
Authorization: Basic {{authtoken1}}

{
	"inputMeasurements": [
		{
			"type": "Measurement",
			"name": "pm1",
			"periodType": "month",
			"offset": 0,
			"positionSource": "Direct",
			"value": {
				"amount": 100.0,
				"unitType": "USD"
			}
		}
	],
	"inputIncentives": [
		{
			"type": "Incentive",
			"name": "inc1",
			"periodType": "month",
			"offset": 0,
			"positionSource": "Direct",
			"value": {
				"amount": 200.0,
				"unitType": "USD"
			}
		}
	]
}

API to calculate all Reward Rules (i.e. Secondary Measurement Rule, Incentive Rule and Commission Rule) for an active Payee for a Sales Transaction:

### /CallidusPortal/services/CalculationService/allRewardRules/{positionName}/{payeeId}
POST {{url}}/CallidusPortal/services/CalculationService/allRewardRules/SalesResp_Test1_Sha/TestParticipant1?searchDate=2022-01-31
Content-Type: application/json
Authorization: Basic {{authtoken1}}

{
	"salesTransactions": [
		{
			"value": {
				"amount": 100,
				"unitType": "USD"
			},
			"targetMeasurement": "PMR_Revenue_Commission"
		}

	]

}

API to calculate all the Credit Rules for an active Payee for and a Sales Transaction:

### /CallidusPortal/services/CalculationService/allCreditRules/{positionName}/{payeeId}
POST {{url}}/CallidusPortal/services/CalculationService/allCreditRules/D0000000001/Newuser1?searchDate=2021-04-31&calendar=Main%20Monthly%20Calendar&processingUnit=GERMANY
Content-Type: application/json
Authorization: Basic {{authtoken1}}

{
	"salesTransactions": [
		{
			"orderId": "DE-001-001-001-001",
			"eventType": "invoicing",
			"lineNumber": 1,
			"subLineNumber": 1,
			"value": {
				"amount": 30000,
				"unitType": "EUR"
			},
			"compensationDate": "2020-11-15",
			"targetMeasurement": "PMR%20New%20Sales"
		}
	]
}

API to calculate all Rules (i.e. Credit Rule, Measurement Rule, Commission Rule and Incentive Rule) for an active Payee for a Sales Transaction

### /CallidusPortal/services/CalculationService/allRewardRules/{positionName}/{payeeId}
POST {{url}}/CallidusPortal/services/CalculationService/allRewardRules/SalesResp_Test1_Sha/TestParticipant1?searchDate=2022-01-31
Content-Type: application/json
Authorization: Basic {{authtoken}}



{
	"salesTransactions": [
		{
			"value": {
				"amount": 100,
				"unitType": "USD"
			},
			"targetMeasurement": "PMR_Revenue_Commission"
		}
	]
}

API to calculate a formula for an active Payee:

###
POST {{url}}/CallidusPortal/services/CalculationService/formula
Content-Type: application/json
Authorization: Basic {{authtoken}}

{ 
    "formula": "F_TelBMS_OTI_Incentive",
    "position": "TestTelco1",
    "payeeId": "TestTelco1",
    "period": "January 2022",
    "calendar": "Main Monthly Calendar"
}