Upsert Custom Rebate Payout
Upsert the custom calculated rebate payout for a 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/upsertCustomRebatePayout
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 |
|---|
accuralRate | Double | The accrual rate used to calculate the accrued amount for the generated program rebate type payout source record. |
accruedAmount | Double | The accrued amount calculated for the generated program rebate type payout source record. |
aggregateId | ID | Required. The ID of the aggregate record for which you want to upsert the rebate payout. |
benefitId | ID | The ID of the qualified program rebate type benefit record for which you want to upsert the rebate payout. |
payoutMemberFieldName | String | The name of the field that contains the rebate program member ID for which to perform the payout calculations. |
rebateAmount | double | Required. The rebate amount for which you want to upsert the rebate payout. |
Outputs
| Output | Type | Description |
|---|
programRebateTypePayoutSourceId | ID | The ID of the program rebate type payout source record, which is generated after the request is successful. |
Usage
Sample Request
1{
2 "inputs":[{
3 "AggregateId":"0lcxx00004000002AAA",
4 "BenefitId":"0htxx00004000002AAA",
5 "RebateAmount":"2000"
6 }]
7}
Sample Response
1{
2 "errors":null,
3 "isSuccess":true,
4 "outputValues":{
5 "programRebateTypePayoutSourceId":"0ntxx00004000002AAA",
6 }
7}