InsPolicyService:createUpdatePolicy

此服務可與 Salesforce Financial Services Cloud 搭配使用,以取得選用的「付款排程」建立支援。

類別:InsPolicyService

方法:createUpdatePolicy

運作方式

1. 服務會搜尋該 inputKey 的輸入 JSON。inputKey 節點包含服務建立或更新原則所需的資訊。此服務所需的資訊包括:

   • accountId

   • term

   • productConfigurationDetail 記錄

   • insuredItems 記錄 (選用)

   • endDate

   • effectiveDate

2. 建立「保單 (資產)」物件。

3. 如果原則有現有的付款排程,則服務會傳回錯誤訊息。

4. 如果有初始付款,將會建立 InsurancePolicyTransaction。除了建立交易之外,交易細目資料也會填入交易詳細資料物件。此物件會儲存關於每個資產、參與者或涵蓋範圍在保費、稅金和費用的總交易金額貢獻的資料。僅會顯示保費、稅金或費用的至少一個值大於零的資產、參與者和涵蓋範圍。您必須將交易詳細資料物件新增至「交易的相關清單」。

5. 如果儲存付款排程,則記錄會連結至「保單」的「原始保單識別碼」。

6. 如果輸入 JSON 中有 taxesAndfees、taxAmount 和/或 feeAmount 節點,則會建立稅金和/或費用記錄。

7. 如果未傳送服務的 assetId,則傳回輸出 JSON 中的原則識別碼。

   如果服務在輸入 JSON 中傳遞一個 assetId,則服務會更新由 assetId 指定的資產。

8. 如果 calculateCommission=true:服務呼叫 InsurancePolicyService.calculateAndSaveCommission,其會為 InsCommissionService.calculate 和 InsCommissionService.saveCommissions 服務準備輸入。計算服務處理輸入後,儲存服務會將計算值儲存在 TotalCommissionAmount 中。

   • 服務會呼叫 InsurancePolicyService.calculateAndSaveCommission,這會為 InsCommissionService.calculate 和 InsCommissionService.saveCommissions 服務準備輸入。

   • 佣金類型 (例如佣金或獎金) 會以 commissionType 的形式傳遞至 InsCommissionService.saveCommissions。

   • 佣金狀態 (例如「已豁免」或「已支付」) 會以 commissionStatus 的形式傳遞至 InsCommissionService.saveCommissions。

   計算服務處理輸入後,儲存服務會將計算值儲存在 TotalCommissionAmount 中。

備註 endDate 和 effectiveDate 會決定保單持續時間。第一個原則版本的持續期間可以少於 365 天,或低於跳轉年度中的 366 天。請參閱保單的 考量事項與限制。

稅金與費用

以下是此服務在使用稅金與費用時的運作方式:

• 如果在 JSON 記錄上指定 taxesAndFees 欄位,則對應的 AssetPricingAdjustment__c 記錄會保留在 taxesAndFees 清單中的每個項目。

• 如果在 JSON 記錄上指定 taxAmount 欄位,則 TaxAmount__c 欄位會設定為已建立 AssetItem 上的 taxAmount 欄位值。

• 如果在 JSON 記錄上指定 feeAmount 欄位,則 FeeAmount__c 欄位會設定為 AssetItem 上的 feeAmount 欄位值。

遠端選項

選項	描述
assetId	選擇性。 此服務根據新或更新的資訊更新之現有原則的識別碼。服務需要更新現有原則時使用。
createContactForParticipants	選擇性。 true 或 false 預設為 true。 如果為 false,則服務不會建立連絡人記錄。
createInsuredItemsRelationships	true 或 false 如果此選項設定為 true,您可以指定受保項目之間的 instanceKey > parentInstanceKey 關係清單。 此選項支援父系 > 子系與父系 > 子系 > 孫系保險項目關係。
createTransaction	選擇性。 true 或 false 預設為 false。 如果為 true,則服務會建立收入排程服務使用的交易。 此服務也會將交易細目資料填入交易詳細資料物件。它會顯示關於每個資產、參與者和涵蓋範圍在保費、稅金和費用的總交易金額貢獻的資料。只會顯示具有至少一個保費、稅金和費用金額非零值的資產、參與者和涵蓋範圍。必須將交易詳細資料物件新增至相關的交易清單。
coolingOffPeriod	選擇性 您可以延遲第一個付款排程項目的天數。 若是冷卻期間,則原則的第一個付款排程日期會計算為生效日期 + 天數。 例如,有一個每月付款頻率,生效日期為 1 月 5 日,第一個付款排程日期為 1 月 5 日。如果我們套用 14 天的冷卻期間,則第一個付款排程項目會從 1 月 5 日變更為 1 月 19 日。剩餘的每月付款排程日期會保持不變。 備註 冷卻期間必須在原則開始日期的 1 到 28 天之間。
effectiveDate	%“YYYY-MM-DD HH:MM:SS” 或 %OmniScriptDataElement% 原則 (或原則更新) 生效的日期。 如果選項對應中沒有 effectiveDate 值,則服務會在 rootAttributes 對應中尋找該值。如果服務找不到 effectiveDate,則會使用今天的日期。 如果您使用的是 Insurance Industries Extension 封裝,則會忽略 effectiveDate 選項中的時間戳記值。而是會將有效日期時間戳記值設定為所選有效日期的凌晨 12:00,並將所選到期日期的到期日期值設定為下午 11:59。時間戳記是使用使用者指定的時區來設定。
generatePolicyNumber	true 或 false 如果為 true,此選項會使用 UniqueIdGenerator 建立唯一的原則編號。此號碼會儲存為 Asset.SerialNumber。
includePaymentSchedule	選擇性。 如果要為原則建立付款排程,則為 True。 預設為 false。
includeRevenueSchedule	選擇性。 true 或 false 如果為 true,此選項會呼叫 InsPolicyRevenueScheduleService:createRevenueSchedule 服務以建立收入排程或 InsPolicyRevenueScheduleService:modifyRevenueSchedule (如果原則正在更新)。 如果為 false,則服務不會為此原則建立收入排程。
initialPaymentRule	選擇性。 百分比、月數或天數。
initialTransactionName	選擇性。 交易名稱。 預設值會與 initialPaymentTransactionType 使用相同的值。
initialPaymentTransactionType	選擇性。 交易類型。 預設值為「保費」。
initialPaymentValue	如果提供 initialPaymentRule,則為必要。 百分比值,或「月數」或「天數」。
inputKey	必要。 此服務從中提取必要資訊以建立或更新原則的 JSON。
isCreatingPolicyTerms	true 或 false 設定為 true 時,服務會在輸出 JSON 中傳回一個 policyTermIds 節點。
isFsc	選擇性。 如果要建立的「保單」是 InsurancePolicy 物件,則為 True。 預設為 false。 您可以指定postDataCustomClassName或指定 postDataDRBundleName。 如果您未指定其中一個選項,則服務會預設為 postDataCustomClassName。
paymentCalculationMethod	如果 includePaymentSchedule 為 true,則為必要。 覆寫保單的「保費計算方法」 值。
paymentFrequency	如果 includePaymentSchedule 為 true,則為必要。 覆寫原則的 PremiumFrequency 值。
paymentStartDate	選擇性。 第一個付款排程項目的日期。 預設為原則生效日期。
paymentType	如果 includePaymentSchedule 為 true,則為必要。 覆寫保單的「保費類型」 值。
postDataCustomClassName	選擇性。 您必須指定此選項或 postDataDRBundleName。 預設值設定為 PostInsurancePolicy。
postDataDRBundleName	選擇性。 您必須指定此選項或 postDataCustomClassName。 如果您未指定此選項,則預設值為 postDataCustomClassName。
transactionType	%OmniScriptDataElement% 如果 includeRevenueSchedule 設定為 true,則使用。 如果未設定值,則預設為「已售出原則」。
calculateCommission	true 或 false 設定為 true 時,服務會計算根項目的佣金,並將總金額儲存至 TotalCommissionAmount。 設定為 false (預設值) 時,服務不會計算佣金。 備註 如果您將此選項設定為 true,則服務需要至少一個產生者或生產代碼值:producerId、productionCodeId 或 productionCodeName。
commissionType	選擇性 佣金類型 (例如,獎金或標準)。
commissionStatus	選擇性 佣金的狀態 (例如「待處理」、「已支付」或「已豁免」)。
producerId	選擇性 處理的產生者識別碼,亦即用來取得 commissionScheduleId 並計算佣金金額的產生者。 指派給已指派給 InsurancePolicy.ProducerId。
productionCodeId	選擇性 生產代碼識別碼。 指派給 InsurancePolicy.ProductionCodeId__c。
productionCodeName	選擇性 傳遞至 InsCommissionService.calculate 服務的生產代碼名稱。 如果您未輸入 productionCodeId,則服務會使用 productionCodeName 查詢 productionCodeId。如果您輸入兩個值,但這些值不相符,則 productionCodeId 會優先。
memberPlanIntegrationProcedure	根據使用者組態起始自訂整合程序。當您使用此選項時,會將服務的所有選項傳送至自訂整合程序,並將所有原則識別碼作為輸入以與物件整合,例如保單物件與成員計畫。
ratingDate	用於定價輸入 JSON 的等級日期。 備註 您無法傳遞 ratingField 的特定時間,因為欄位類型為 Date。因此,等級日期時間戳記預設為 12:00 am。
term	服務將建立的原則條款。 InsPolicyService:createUpdatePolicy 僅支援年度保單條款。
useIsPaidFlag	選擇性 如果 true 且 includePaymentSchedule 也設定為 true,則服務會為每個付款排程項目建立保單元件的貢獻記錄。 預設值為 False。

輸入 JSON

此服務會尋找 inputKey 的值。

針對此範例,inputKey = newPolicyJSON。

"newPolicyJSON": {
  "accountId": "001f400000OSHq2AAH",
  "term": "Annual",
  "endDate": "2019-05-14T07:00:00.000Z",
  "effectiveDate": "2018-05-15T07:00:00.000Z",
  "productConfigurationDetail": {
    ...
  },
  "insuredItems": {
    ...
  },
  "additionalFields": {
    "SerialNumber": "AUTO-123",
    "Status": "InForce",
    "vlocityins2__Type__c": "AUTO",
    "vlocityins2__PaymentMethodId__c": "a2Rf40000002NrgEAE"
  },
}

inputKey 內部的 JSON 包含服務建立或更新原則所需的數個金鑰/值配對。其中也包含產品 JSON,以及已投保項目的定價與保單總計。

此範例的 insuredItems 記錄包含受保項目,以及使用者為每個項目選取的值。

針對此範例,inputKey = quotepolicyJSON。

"quotepolicyJson": {
  "productConfigurationDetail": {
    ...
  }
  "insuredItems": {
    "DRIVER": [{
        "GENDER": "Female",
        "FN": "Joan",
        "AGE": 20,
        "LN": "Smith",
        "instanceKey": "Joan Smith",
        "isPrimary": false
        "isParent": false
      },
      {
        "GENDER": "Male",
        "FN": "John",
        "AGE": 30,
        "LN": "Smith",
        "instanceKey": "John Smith",
        "isPrimary": false
        "isParent": false
      },
      {
        "GENDER": "Male",
        "FN": "Robert",
        "AGE": 30,
        "LN": "Henderson",
        "instanceKey": "Robert Henderson",
        "isPrimary": false
        "isParent": false
      },
      {
        "GENDER": "Female",
        "FN": "Kinsey",
        "AGE": 20,
        "LN": "Schell",
        "instanceKey": "Kinsey Schell",
        "isPrimary": false
        "isParent": false
      }
    ],
    "AUTO": [{
        "autoLicNum": "Lexus",
        "autoModel": "LX250",
        "autoYear": 2015,
        "instanceKey": "2015 Lexus LX250",
        "BodyClass": "Sedan/Saloon",
        "VehicleType": "PASSENGER CAR",
        "isPrimary": true
        "isParent": true
      },
      {
        "autoLicNum": "Honda",
        "autoModel": "Odyssey",
        "autoYear": 2006,
        "instanceKey": "2006 Honda Odyssey",
        "BodyClass": "Minivan",
        "VehicleType": "MULTIPURPOSE PASSENGER VEHICLE (MPV)",
        "isPrimary": true
        "isParent": true                                
      }
    ]
  },
  "accountId": "0011I00000QknfjQAB",
  "opportunityId": "0061I00000AV8gBQAT"
},
"quoteId": "0Q01I000000206USAQ",
"error": "OK"

輸出 JSON

服務會傳回新建立原則的原則識別碼。

{
    "policyId": "02if4000001uCZXAA2",
    "error": "OK"
}

如果 isCreatingPolicyTerms 遠端選項設定為 true,則會包含 policyTermIds 節點。以下是 policyTermIds 節點的範例:

{  
   "policyId": "02i6g000000h110AAA",
   "policyTermIds": [
    "a5X6g000001LeUUEA0",
    "a5X6g000001LeUVEA0",
    "a5X6g000001LeUWEA0",
    "a5X6g000001LeUXEA0",
    "a5X6g000001LeUYEA0",
    "a5X6g000001LeUZEA0",
    "a5X6g000001LeUaEAK",
    "a5X6g000001LeUbEAK",
    "a5X6g000001LeUcEAK",
    "a5X6g000001LeUdEAK",
    "a5X6g000001LeUeEAK",
    "a5X6g000001LeUfEAK"
  ]
}

範例

此服務通常用於 OmniScript 報價至原則模式。