Get Benefit and Calculate Rebate Amount

Get the details benefits and optionally calculate the rebate amount for the specified aggregate record.

This object is available in API version 51.0 and later for users with Rebate Management license.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/getBenefitAndCalculateRebateAmount

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: GET, HEAD, POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Input	Type	Description
`aggregateId`	ID	Required. The ID of the aggregate record for which you want to calculate the rebate amount.
`payoutMemberFieldName`	ID	The name of the field that contains the rebate program member ID for which to perform the payout calculations.
`skipRebateCalc`	Boolean	Indicates whether to skip calculation of the rebate amount.

Outputs

Output	Type	Description
`accuralRate`	Double	The accrual rate if the request is successful.
`accruedAmount`	Double	The accrued amount calculated if the request is successful.
`aggregateId`	ID	The ID of the aggregate record for which you want to calculate the rebate amount.
`benefitId`	ID	The ID of the applied Program Rebate Type Benefit record if the request is successful.
`payoutMemberFieldName`	String	The name of the field that contains the rebate program member ID for which to perform the payout calculations.
`qualifyingBenefits`	string	The comma-separated list of IDs of the qualified Program Rebate Type Benefit records if the request is successful.
`rebateAmount`	double	The rebate amount calculated if the request is successful.

Usage

Sample Request

1{
2   "inputs":[
3      {"AggregateId": "a00xx000000cCtxAAE",
4      "SkipRebateCalc": false},
5      {"AggregateId": "a00xx000000cCvZAAU",
6      "SkipRebateCalc": false},
7      {"AggregateId": "a00xx000000cCxBAAU",
8      "SkipRebateCalc": false}
9   ]
10}

Sample Response

1{
2   "errors":null,
3   "isSuccess":true,
4   "outputValues":{ 
5      "AggregateId":"0ntxx00004000002AAA",
6      "BenefitId":"0ntxx00004000002AAA",
7      "RebateAmount":"2000"
8   }
9}