Process Rebate Batch Calculation Jobs

Process a rebate batch calculation job from the Data Processing Engine.

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

Inputs

Input Details
calcDefinitionId
Type
ID
Description
Required. The ID of the data processing engine definition record that you want to process.
rebateProgramIds
Type
array
Description
The list of IDs of the rebate program records that the custom batch calculation job processes.
programRebateTypeIds
Type
array
Description
The list of IDs of the program rebate type records that the custom batch calculation job processes.
rebateProgramPayoutPeriodIds
Type
array
Description
The list of IDs of the rebate program payout period records that the custom batch calculation job processes.
rebateProgramMemberIds
Type
array
Description
The list of IDs of the rebate program member records that the custom batch calculation job processes.

Outputs

Output Details
batchJobId
Type
ID
Description
The ID of the generated batch job record after the request is successful.
accepted
Type
boolean
Description
Indicates whether the rebate batch calculation job is accepted.

Usage

Sample Request
{
   "inputs":[{
      "calcDefinitionId": "0lcxx00004000002AAA",
      "rebateProgramIds": ["0htxx00004000002AAA","0htxx00004000002bAA"],
      "programRebateTypeIds": ["0htxx00004000002AAA","0htxx00004000002bAA"],
      "rebateProgramPayoutPeriodIds": ["0htxx00004000002AAA","0htxx00004000002bAA"],
      "rebateProgramMemberIds": ["0htxx00004000002AAA","0htxx00004000002bAA"]
   }]
}
Sample Response
{
   "errors":null,
   "isSuccess":true,
   "outputValues":{ 
      "batchJobId":"0ntxx00004000002AAA",
      }
}