Calculate Rebate Amount and Upsert Payout

Calculate the rebate amount and upsert the rebate payout 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/calculateRebateAmountAndUpsertPayout

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 and 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.

Outputs

Output	Type	Description
`programRebateTypePayoutSourceId`	ID	The ID of the program rebate type payout source record, which is generated if the request is successful.

Usage

Sample Request

1{
2   "inputs":[
3      {"aggregateId":"a00xx000000cCtxAAE"},
4      {"aggregateId":"a00xx000000cCvZAAU"},
5      {"aggregateId":"a00xx000000cCxBAAU"}
6   ]
7}

Sample Response

1{
2   "errors":null,
3   "isSuccess":true,
4   "outputValues":{ 
5      "programRebateTypePayoutSourceId":"0ntxx00004000002AAA"
6   }
7}