Compute Producer Splits Action

Compute the producer splits for the producers associated with an Insurance Policy, for a Commission Statement Line Item.

This action is available in API version 63.0 and later.

Special Access Rules

The Compute Producer Splits action is available in Enterprise, Unlimited, and Developer Editions where 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/computeProducerSplits

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
commissionStatementLineItemId	String	ID of the commission statement line item record.

Outputs

Output	Type	Description
producerCommissions	sObject	Collection of producer commission records that are computed.

Example

POST

This sample request is for the Compute Producer Splits action.

{
  "inputs": [
    {
      "commissionStatementLineItemId": "1Atxx0000004DeaCAE"
    }
  ]
}

This is the sample response for the Compute Producer Splits action.

[
  {
    "actionName": "computeProducerSplits",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "producerCommissions": [
        {
          "attributes": {
            "type": "ProducerCommission"
          },
          "CommissionStatementLineItemId": "1Atxx0000004C92CAE",
          "ProducerSplitAssignmentId": "1AIxx0000004C92GAE",
          "CommissionAmount": 4000,
          "InsurancePolicyId": "0YTxx0000000001GAA",
          "ProducerId": "0Yxxx0000000001CAA",
          "ProducerSplitArngLineItemId": "1BHxx0000004C92GAE",
          "Name": "CSLI-0000000001-Amol-Commission"
        }
      ]
    },
    "sortOrder": -1,
    "version": 1
  }
]