Create Producer Commissions Action
Create records for the commissions that producers receive for the insurance policy associated with the specified commission statement line item, and update the commission statement line item record status.
This action is available in API version 63.0 and later.
Special Access Rules
The Create Producer Commissions action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need Insurance Commission Management and Insurance Brokerage User permission sets.
Supported REST HTTP Methods
URI : /services/data/vXX.X/actions/standard/createProducerCommissions
Where XX.X is the latest API version.
Formats : JSON
HTTP Methods : GET, POST
Authentication : Authorization: Bearer TOKEN
Where TOKEN is your OAuth access token.
Inputs
Input Type Description producerCommissionssObject A collection of computed producer commission records to be created. commissionStatementLineItemIdString ID of the commission statement line item record. successStatusString The status that the associated commission statement line item is set to when the producer commission record is created. failureStatusString The status that the associated commission statement line item is set to when the producer commission record isn’t created.
Outputs
Output Type Description producerCommissionIdsString A collection of IDs of the producer commission records that are created.
Example
POST
This sample request is for the Create Producer Commissions action.
1 {
2 "inputs": [
3 {
4 "commissionStatementLineItemId": "1Atxx0000004DeaCAE",
5 "producerCommissions": [
6 {
7 "CommissionAmount": 3000,
8 "InsurancePolicyId": "0YTxx00000002BVGAY",
9 "ProducerId": "0Yxxx00000001IfCAI",
10 "ProducerSplitArngLineItemId" : "1BHxx0000004CXEGA2",
11 "CommissionStatementLineItemId": "1Atxx0000004DeaCAE",
12 "Name": "Sanjeev"
13 },
14 {
15 "InsurancePolicyId": "0YTxx00000002BVGAY",
16 "ProducerId": "0Yxxx00000001KHCAY",
17 "ProducerSplitArngLineItemId" : "1BHxx0000004CXEGA2",
18 "CommissionStatementLineItemId": "1Atxx0000004DeaCAE",
19 "Name": "Deepak"
20 }
21 ]
22 }
23 ]
24 }
This is the sample response for the Create Producer Commissions action.
1 [
2 {
3 "actionName": "createProducerCommissions",
4 "errors": null,
5 "invocationId": null,
6 "isSuccess": true,
7 "outcome": null,
8 "outputValues": {
9 "producerCommissionIds": [
10 "0kAxx0000000001"
11 ]
12 },
13 "sortOrder": -1,
14 "version": 1
15 }
16 ]