SSP policy by calculator method
This API is used to initiate calculation for SSP batch of SSP calculator method.
A system-generated compliance ID on creating or updating the policy
Name of SSP Calculator Policy.
Name of SSP Calculator Policy Batch.
Calculate SSP
Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.
Displays the outcome of the action. It is commonly used to provide success confirmations, error details, or other informational responses from the API after the operation is executed.
PUT /apis/policy-sets/v1/policy/ssp/{compliance_id}/calculate HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 1296
{
"policy_name": "SSP_Calc_01",
"batch_name": "SSP_Calc_01_batch02",
"policy_spec": {
"active": true,
"batches": [],
"can_delete": true,
"ceiling_percentage": null,
"created_at": 1748328707,
"created_by": "username@rightrev.com",
"data_identifiers": [
"customer_name",
"legal_entity"
],
"entity_type": "policy",
"expression": "",
"floor_percentage": null,
"hierarchy_no": 1,
"is_user_defined": true,
"method": "calculator",
"name": "SSP_Calc_01",
"transaction_above_range": "above_mid_point",
"transaction_below_range": "below_mid_point",
"transaction_mid_range": "mid_point",
"type": "ssp",
"updated_at": 1748328707,
"updated_by": "username@rightrev.com",
"when": [],
"isEditable": true,
"canDelete": true
},
"batch_spec": {
"apply_ssppercent_on": "total_list_price",
"can_delete": true,
"ceiling_percentage": 6,
"created_at": 1748329008,
"created_by": "username@rightrev.com",
"effective_end_date": "2021-12-31",
"effective_start_date": "2021-01-01",
"entity_type": "batch",
"file_id": null,
"file_name": null,
"floor_percentage": 4,
"is_user_defined": true,
"name": "SSP_Calc_01_batch02",
"policy_name": "SSP_Calc_01",
"ssp_calculation_method": "optimizer",
"ssp_range_calc_type": "absolute",
"status": "batch_created",
"timestamp": 1748329008,
"updated_at": 1748329008,
"updated_by": "username@rightrev.com",
"when": [
{
"field_name": "customer_name",
"operator": "==",
"value": "SSP_CALC_first"
}
]
}
}Calculate SSP
{
"error": [],
"message": "SSP calculation initiated successfully"
}This API is used to refresh and check status of the ssp values at batch level in SSP calculator method.
A system-generated compliance ID on creating or updating the policy
Name of the SSP Policy.
Name of the SSP Policy Batch.
Refresh SSP
Name of the SSP Policy Batch
Type of the record. For e.g ssp values
A unique combination of SSP Policy Name and batch name.
name of the SSP Policy.
GET /apis/policy-sets/v1/policy/ssp/{compliance_id}/ssp-values?policy_name=text&batch_name=text HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Refresh SSP
{
"batch_name": "test_12456",
"entity_type": "ssp_values",
"name": "Test_SSP_Calculator_test_12456",
"policy_name": "Test_SSP_Calculator",
"ssp_values": [
{
"above_mid_point": 110,
"below_mid_point": 90,
"compliance_percent": 83.33,
"effective_end_date": "2026-02-27",
"effective_start_date": "2026-02-27",
"mid_point": 100,
"product_name": "Booking_PIT",
"ssp_value_id": "57e817a8-8c85-4572-88c3-88df17569e7e",
"transactions_count": 42,
"value_type": "percent",
"withinrange_count": 35
}
]
}This API is used to retrieve all bell curve details of SSP calculator value id.
A system-generated compliance ID on creating or updating the policy
Name of the SSP Policy.
Name of the SSP Policy Batch.
Unique SSP batch value ID assigned by system on completion of calculation.
Bell Curve SSP
Name of the SSP Policy Batch.
Name of SSP Policy
Unique SSP batch value ID assigned by system on completion of calculation.
GET /apis/policy-sets/v1/policy/ssp/{compliance_id}/bell-curve?policy_name=text&batch_name=text&ssp_value_id=text HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Bell Curve SSP
{
"batch_name": "Test_SSP_Calculator_B2",
"bell_curve": [
{
"x-axis": 76,
"y-axis": 41
},
{
"x-axis": 0,
"y-axis": 5
},
{
"x-axis": -100,
"y-axis": 2
},
{
"x-axis": 69,
"y-axis": 8
},
{
"x-axis": 50,
"y-axis": 2
},
{
"x-axis": 79,
"y-axis": 1
},
{
"x-axis": 25,
"y-axis": 1
},
{
"x-axis": 100,
"y-axis": 29
},
{
"x-axis": 81,
"y-axis": 6
},
{
"x-axis": -69,
"y-axis": 2
},
{
"x-axis": 90,
"y-axis": 6
},
{
"x-axis": 82,
"y-axis": 31
},
{
"x-axis": 40,
"y-axis": 6
},
{
"x-axis": 60,
"y-axis": 5
},
{
"x-axis": 55,
"y-axis": 5
}
],
"bell_curve_label": {
"x-axis": "Sell Price Percent",
"y-axis": "Transaction Count"
},
"policy_name": "Test_SSP_Calculator",
"ssp_value_id": "6f1f585e-d856-4377-b0d9-a6b49e79a681"
}This API is used to upload CSV file of transactions that to be exclude from SSP calculator calculation.
A system-generated compliance ID on creating or updating the policy
CSV file to be uploaded with transactions which are to be excluded from SSP calculator calculation.
Unique SSP batch value ID assigned by system on completion of calculation.
Name of the SSP Policy.
Name of the SSP Policy Batch.
Exclude SSP
Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.
Displays the outcome of the action. It is commonly used to provide success confirmations, error details, or other informational responses from the API after the operation is executed.
PUT /apis/policy-sets/v1/policy/ssp/{compliance_id}/exclude-transactions HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: multipart/form-data
Accept: */*
Content-Length: 70
{
"file": null,
"ssp_value_id": null,
"policy_name": null,
"batch_name": null
}Exclude SSP
{
"error": [],
"message": "SSP Update Transactions initiated successfully"
}This API is used to download the CSV file uploaded to exclude the transactions to be part of SSP calculator calculation.
A system-generated compliance ID on creating or updating the policy
Download SSP
GET /apis/policy-sets/v1/policy/ssp/{compliance_id}/transactions HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Download SSP
{}This API is used to REVIEW or APPROVE the SSP batches created under SSP by upload or SSP calculator method.
Two actions are supported here. review or approve
A system-generated compliance ID on creating or updating the policy
Name of the SSP Policy Batch.
Review and Approve SSP Policy
A system-generated compliance ID on creating or updating the policy
Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.
PATCH /apis/policy-sets/v1/policy/ssp/{action}/{compliance_id}/{batch_name} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Review and Approve SSP Policy
{
"compliance_details": [
{
"error": [],
"message": "updated successfully",
"unique_key": "SSP_Test_1"
}
],
"compliance_id": "805d37e1-02d5-49e1-98c5-d61f60794a46",
"error": []
}Last updated
Was this helpful?