InsCommissionService:adjust

Klasse: InsCommissionService

Metode: adjust

Beskrivelse

Denne tjenesten bruker en eksisterende Produsentkommisjon-post og Kommisjonsplan til å justere et kommisjonsbeløp for en produsent.

Slik fungerer det

For å justere en kommisjon gjør denne tjenesten følgende:

1. Godtar commissionId-inndata og henter den tilsvarende Produsentkommisjon-posten.

   Hvis en provisjon allerede er justert, krever tjenesten commissionId for den siste justeringen.

2. Hvis useOriginalSchedule er sann, brukes provisjonsplanen som er angitt i den hentede producentkommisjonsposten, til beregningen.

   Hvis useOriginalSchedule er usann, bruker tjenesten inndata fra productionCode, producerId, productId, commissionableEvent, context og effectiveDate til å bestemme hvilken kommisjonsplan som skal brukes.

3. Beregner kommisjonen basert på kommisjonsplanen.

4. Evaluerer kommisjonen for å finne ut om det er en tilbakekostnad (et returnert kommisjonsbeløp).

   • Hvis kommisjonsbeløpet er negativt, behandler tjenesten provisjonen som en tilbakekostnad.

   • Hvis kommisjonen ikke er en tilbakekostnad, sammenligner tjenesten det beregnede kommisjonsbeløpet med minste og største kommisjonsbeløp. Hvis det beregnede beløpet er for lavt eller for høyt, returnerer tjenesten minimums- eller maksimumsbeløpet i stedet for det beregnede beløpet.

5. Returnerer kommisjonsbeløpet, ID-en til kommisjonsplanen som brukes til å beregne det, og minimums- og maksimumsbeløpene som gjelder for denne kommisjonen.

Inndata

Inndata-JSON

Slik formaterer du inndata-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
   }
}

Dette eksemplet justerer en kommisjon som er utstedt for en anbefaling, ved å bruke den samme kommisjonsplanen som opprinnelig ble brukt.

{
   "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
   }
}

Utdata-JSON

Her er formatet på JSON-koden for utdata.

{
   "commissionAmount": amount,
   "commissionScheduleId": ID of the commission schedule used,
   "minCommissionAmount": CommissionScheduleAssignment.MinCommissionAmount,
   "maxCommissionAmount": CommissionScheduleAssignment.MaxCommissionAmount
}

Her er et eksempel på utdata som viser at det beregnede beløpet ($167) er innenfor området definert av minimums- og maksimumsverdier ($100-$500).

{
   "commissionAmount":167,
   "commissionScheduleId":"ab001od002",
   "minCommissionAmount":100,
   "maxCommissionAmount":500
}