Loading
Forsikring
InsCommissionService:adjust

breadcrumbDescription

  1. helpHomeLinkText
  2. docsHomeLinkTextShort
  3. Digital forsikring

InsCommissionService:adjust

Brug denne tjeneste til at justere et producentkommissionsbeløb.

Kategori: InsCommissionService

Metode: adjust

Beskrivelse

Denne tjeneste bruger en eksisterende producerkommissionsregistrering og Kommissionsplan til at justere et kommissionsbeløb for en producent.

Sådan fungerer det

Hvis du vil justere en kommission, gør denne tjeneste følgende:

  1. Accepterer commissionId og henter den tilsvarende producentkommission.

    Hvis en kommission allerede er blevet justeret, kræver tjenesten commissionId for den seneste justering.

  2. Hvis useOriginalSchedule er sandt, anvendes Kommissionens tidsplan, der er angivet i den hentede producentkommission.

    Hvis useOriginalSchedule er falsk, bruger tjenesten input af typen productionCode, producerId, productId, commissionableEvent, context og effectiveDate til at bestemme, hvilken kommissionsplan der skal bruges.

  3. Beregner kommissionen baseret på kommissionens tidsplan.

  4. Evaluerer kommissionen for at bestemme, om det er en tilbagebetaling (et returneret kommissionsbeløb).

    • Hvis det beløb, der kan bestilles, er negativt, behandler tjenesten kommissionen som en tilbagebetaling.

    • Hvis kommissionen ikke er en tilbagebetaling, sammenligner tjenesten det beregnede kommissionsbeløb med minimum og maksimum kommissionsbeløb. Hvis det beregnede beløb er for lavt eller for højt, returnerer tjenesten det mindste eller maksimale beløb i stedet for det beregnede beløb.

  5. Returnerer kommissionsbeløbet, id'et for den kommissionstidsplan, der bruges til at beregne det, og de mindste og maksimale beløb, der gælder for denne kommission.

Input

Input

Beskrivelse

commissionId

Påkrævet.

Id for producentkommissionen, der skal justeres.

useOriginalSchedule

true eller false

Når den er indstillet til true, bruger tjenesten den tidsplan for kommissionen, der er angivet i den hentede producentkommission.

Når den er indstillet til false, bruger tjenesten andre input til at bestemme, hvilken kommissionsplan der skal bruges.

productionCode

Valgfrit.

Produktionskodenavnet, ikke id'et for den behandlende producent.

producerId

Valgfrit.

Id'et på den behandlende producent.

productId

Påkrævet, hvis useOriginalSchedule er false.

Id'et på det produkt, som provisionen betales for.

commissionableEvent

Valgfrit.

Den begivenhed eller transaktion, der udløser en kommissionsberegning (f.eks. Tilbud, Solgt politik eller Ændret/anbefales).

effectiveDate

Valgfrit.

Datoen for justeringens ikrafttræden. Hvis nul, bruger tjenesten dags dato.

context

Påkrævet.

Feltnavn og værdipar for den registrering, som kommissionen beregnes på. Du skal:

  • Inkluder et navneområde i API-navnet, hvis der findes et.

  • Inkluder objectId, dvs. id'et på den registrering, som provisionen beregnes for.

Format uden opslagsfelt:

{ objectAPI.fieldAPI : fieldValue }

Format med opslagsfelt:

{ objectAPI.relationshipAPI.fieldAPI : fieldValue }

Du kan angive op til to niveauer af felter, hvis du formaterer inputtet med et opslagsfelt.

commissionableAmount

Valgfrit.

Det beløb, som kommissionsberegningen er baseret på.

Input JSON

Sådan formateres input-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 eksempel justerer en kommission, der er udstedt for en anbefaling, ved brug af den samme kommissionstidsplan, der oprindeligt blev brugt. 

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

Output JSON

Her er formatet på output-JSON.

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

Her er der et eksempeloutput, der viser det beregnede beløb ($167) inden for det område, der er defineret af minimum- og maksimumværdier ($100-$500). 

{
   "commissionAmount":167,
   "commissionScheduleId":"ab001od002",
   "minCommissionAmount":100,
   "maxCommissionAmount":500
}
 
Indlæser
Salesforce Help | Article