Rebate Management Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Rebate Management Standard Objects
Rebate Management Standard Invocable Actions
Add Rebate Member List
Calculate Rebate Amount and Upsert Payout
Calculate Projected Rebate Amount
Generate Rebate Payout Periods
Get Benefit and Calculate Rebate Amount
Get Eligible Program Rebate Types
Process Program Rebate Type Products
Process Rebate Batch Calculation Jobs
Process Rebate CSV Files
Upsert Custom Rebate Payout
Rebate Management Metadata API Types
Data Processing Engine, Batch Management, and Monitor Workflow Services
PDF

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
Formats
JSON, XML
HTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

Input Details
accuralRate
Type
Double
Description
The accrual rate used to calculate the accrued amount for the generated program rebate type payout source record.
accruedAmount
Type
Double
Description
The accrued amount calculated for the generated program rebate type payout source record.
aggregateId
Type
ID
Description
Required. The ID of the aggregate record for which you want to upsert the rebate payout.
benefitId
Type
ID
Description
The ID of the qualified program rebate type benefit record for which you want to upsert the rebate payout.
payoutMemberFieldName
Type
String
Description
The name of the field that contains the rebate program member ID for which to perform the payout calculations.
rebateAmount
Type
double
Description
Required. The rebate amount for which you want to upsert the rebate payout.

Outputs

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

Usage

Sample Request
{
   "inputs":[{
      "AggregateId":"0lcxx00004000002AAA",
      "BenefitId":"0htxx00004000002AAA",
      "RebateAmount":"2000"
   }]
}
Sample Response
{
   "errors":null,
   "isSuccess":true,
   "outputValues":{ 
      "programRebateTypePayoutSourceId":"0ntxx00004000002AAA",
   }
}