Sie befinden sich hier:
InsCommissionService:adjust
Verwenden Sie diesen Service, um einen Betrag für die Erzeugerprovision anzupassen.
Methode: adjust
Beschreibung
Dieser Service verwendet einen vorhandenen Datensatz der Erzeugerkommission und einen vorhandenen Provisionsplan, um einen Provisionsbetrag für einen Erzeuger anzupassen.
Funktionsweise
Zum Anpassen einer Provision:
-
Akzeptiert
commissionIdund ruft den entsprechenden Datensatz der Erzeugerkommission ab.Wenn eine Provision bereits angepasst wurde, benötigt der Service die
commissionIdfür die letzte Anpassung. -
Wenn der
useOriginalSchedulewahr ist, wird für die Berechnung der im abgerufenen Datensatz der Erzeugerkommission angegebene Provisionsplan verwendet.Wenn die
useOriginalSchedulefalsch ist, verwendet der ServiceproductionCode-,producerId-,productId-,commissionableEvent-,context- undeffectiveDate-Eingaben, um zu bestimmen, welcher Kommissionsplan verwendet werden soll. -
Berechnet die Provision anhand des Provisionsplans.
-
Wertet die Provision aus, um festzustellen, ob es sich um eine Rückerstattung (einen zurückgegebenen Provisionsbetrag) handelt.
-
Wenn der Provisionsbetrag negativ ist, behandelt der Service die Provision als Rückerstattung.
-
Wenn es sich bei der Provision nicht um eine Rückerstattung handelt, vergleicht der Service den berechneten Provisionsbetrag mit den minimalen und maximalen Provisionsbeträgen. Wenn der berechnete Betrag zu niedrig oder zu hoch ist, gibt der Service den Mindest- oder Höchstbetrag anstelle des berechneten Betrags zurück.
-
-
Gibt den Provisionsbetrag, die ID des zu seiner Berechnung verwendeten Provisionsplans sowie die Mindest- und Höchstbeträge zurück, die für diese Provision gelten.
Eingaben
Eingabe |
Beschreibung |
|---|---|
|
Pflichtangabe. ID der anzupassenden Erzeugerkommission. |
|
Wenn der Service auf Wenn er auf |
|
Optional. Der Name des Produktionscodes, nicht die ID, für den verarbeitenden Produzenten. |
|
Die ID des verarbeitenden Produzenten. |
|
Erforderlich, wenn Die ID des Produkts, für das die Provision gezahlt wird. |
|
Das Ereignis oder die Transaktion, das bzw. die eine Provisionsberechnung auslöst (z. B. "Angebot", "Verkaufsrichtlinie" oder "Geändert/Bestätigt"). |
|
Optional. Das Datum des Inkrafttretens der Anpassung. Bei null verwendet der Service das heutige Datum. |
|
Pflichtangabe. Feldname und Wertepaare für den Datensatz, für den die Provision berechnet wird. Sie müssen:
Format ohne Nachschlagefeld:
Format mit Nachschlagefeld:
Sie können bis zu zwei Ebenen von Feldern angeben, wenn Sie die Eingabe mit einem Nachschlagefeld formatieren. |
|
Der Betrag, auf dem die Provisionsberechnung basiert. |
Input JSON
So formatieren Sie die Eingabe-JSON.
{
"commissionId": ProducerCommission.Id,
"useOriginalSchedule": true,
"productionCode": ProductionCode.Name,
"producerId": Producer.Id,
"product2Id": Product2.Id,
"commissionableEvent": event type,
"commissionableAmount": amount of the transaction,
"context": {
"objectId": ID of applicable object used,
"objectAPI.fieldAPI" : value
}
}In diesem Beispiel wird eine Provision, die für eine Bestätigung ausgestellt wurde, mit demselben Provisionsplan angepasst, der ursprünglich verwendet wurde.
{
"commissionId": apwe045asx,
"useOriginalSchedule": true,
"productionCode":AX001,
"producerId":ay001jh002,
"product2Id":az011jh022,
"commissionableEvent":"Endorsement",
"commissionableAmount":500,
"context":{
"Quote.vlocity_ins__TotalPremiumforTerm__c":100,
"QuoteLineItem.vlocity_ins__GroupClassId__r.vlocity_ins__ClassCode__c":"Managers",
"QuoteLineItem.vlocity_ins__FeeAmount__c":5,
"objectId":ax003jh001
}
}Ausgabe-JSON
Im Folgenden finden Sie das Format der Ausgabe-JSON.
{
"commissionAmount": amount,
"commissionScheduleId": ID of the commission schedule used,
"minCommissionAmount": CommissionScheduleAssignment.MinCommissionAmount,
"maxCommissionAmount": CommissionScheduleAssignment.MaxCommissionAmount
}Im Folgenden finden Sie eine Beispielausgabe, aus der hervorgeht, dass der berechnete Betrag (167 EUR) innerhalb des durch Mindest- und Höchstwerte (100 EUR bis 500 EUR) definierten Bereichs liegt.
{
"commissionAmount":167,
"commissionScheduleId":"ab001od002",
"minCommissionAmount":100,
"maxCommissionAmount":500
}