 | |
Important Changes | |
- Changes that require significant or non-obvious adjustments for integrations when upgrading endpoints. We may not list minor changes that would be made obvious through compilation errors. For example, slightly renaming a property
- Changes that require integrations to be adjusted in order to execute without error when upgrading versions. These are rare. We try to avoid these as much as possible.
- Significant behavior changes to heavily used areas or properties.
| Epic Version | Area / Methods | Description |
|---|---|---|
| 2021.2 | Insert_Transaction Action_Transaction_AdjustCommission | 1) Insert_transaction method will now allow zero amount direct bill transactions/installment transactions to be inserted through SDK. 2) Action_Transaction_AdjustCommission method will now allow zero amount direct bill transactions/installment transactions to be adjusted through SDK. This change affects all endpoints in version 2021.2 or later. |
| 2021.2 | Insert_GeneralLedger_ReconciliationDirectBillCommission Update_GeneralLedger_ReconciliationDirectBillCommission | Insert_GeneralLedger_ReconciliationDirectBillCommission and Update_GeneralLedger_ReconciliationDirectBillCommission method will now allow zero amount RecordDetailItems to be inserted through SDK. This change affects all endpoints in version 2021.2 or later. |
| 2021.2 | Update_Commission_BrokerCommission Update_Commission_CompanyCommission Update_Commission_EmployeeCommission | An update to Broker/Company/Employee commissions when the commission agreement is in use, SDK in some cases will throw an error message saying 'Commissions cannot be edited when the agreement is in use.' similar to Epic. Also, some properties like CommissionPercent, CommissionAmount, etc. will also be ignored on update if the agreement is in use. This change affects all endpoints in version 2021.2 or later. |
| 2021 | Action_Employee_UpdateAccountNameLookupCode | Action_Employee_UpdateAccountNameLookupCode action has been removed. User can use Update_Employee instead. This change affects all endpoints in version 2021 or later. |
| 2021 | Get_BusinessAuto_Vehicle | Get_BusinessAuto_Vehicle with SearchType = 'MarketingLineID' Or 'MarketingLineIDAndCarrierSubmissionID' will no longer display an error message saying 'No Vehicles found.' and would return an empty collection instead if no vehicles are to be returned. This change affects all endpoints in version 2021 or later. |
| 2021 | Get_PolicyInformation_EmployeeClass Update_PolicyInformation_EmployeeClass Insert_PolicyInformation_EmployeeClass Delete_PolicyInformation_EmployeeClass Get_PolicyInformation_PlanRateInformation Update_PolicyInformation_PlanRateInformation | 1) An update to the Policy Information section removed the Employee Class area from EpicSDK 2021 or later and made it obsolete in EpicSDK 2020 or before. This change affects all the methods listed above which will not work in 2020 endpoint or before, and will display an error message saying the methods are obsolete and what you can use instead in 2021 to perform the same operations. Previously written integrations will not work anymore and will receive an error message for 2020 endpoint or before and a compilation error starting 2021 or later. 2) Starting EpicSDK2021 some properties listed below have been removed/renamed from the PlanRateInformation area as well. RateName, WaitingPeriod, Beginning, BenefitTermination have been removed from the RateInformation area. MonthlyPremium, AnnualPremium, AnnualEmployeeCost have been renamed to TotalMonthlyPremium, TotalAnnualPremium, AverageTotalCostPerEmployee. |
| 2021 | Insert_CanadianPersonalAuto_Vehicle Update_CanadianPersonalAuto_Vehicle Get_CanadianPersonalAuto_Vehicle | A form update to Prince Edward Island vehicles removed limits from the current form edition. The ThirdPartyLiabilityOccasionalDriverValue, FamilyProtectionOccasionalDriverValue and FamilyProtectionPrincipalDriverValue fields are no longer accessible for current policies. These fields are still kept in order to support polices of older form editions. This change affects all endpoints in version 2021 or later. Previously written integrations will continue to execute without error. However, the behavior is as follows: On a Get call, the above mentioned fields will return blank for current form editions. On an Insert or Update call, the above mentioned fields will be ignored for current form editions. |
| 2021 | Insert_CanadianCommercialAuto_Vehicle Update_CanadianCommercialAuto_Vehicle Get_CanadianCommercialAuto_Vehicle | A form update to Prince Edward Island vehicles removed limits from the current form edition. The ThirdPartyLiabilityOccasionalDriverValue, FamilyProtectionOccasionalDriverValue and FamilyProtectionPrincipalDriverValue fields are no longer accessible for current policies. These fields are still kept in order to support polices of older form editions. This change affects all endpoints in version 2021 or later. Previously written integrations will continue to execute without error. However, the behavior is as follows: On a Get call, the above mentioned fields will return blank for current form editions. On an Insert or Update call, the above mentioned fields will be ignored for current form editions. |
| 2021 | Update_CommercialApplication_Status | The Commercial AP Status interface changed significantly. Fields were both added and removed. IsSectionTruckersMotorCarrierAttached split into IsSectionMotorCarrierAttached and IsSectionTruckersAttached. SectionTruckersMotorCarrierPremium split into SectionMotorCarrierPremium and SectionTruckersPremium. We updated the interface of the 2019 and later endpoints to reflect this change. Previously written integrations will continue to execute without error. However, the behavior is as follows: On a Get call, IsSectionTruckersMotorCarrierAttached will return true if either IsSectionMotorCarrierAttached or IsSectionTruckersAttached is true. SectionTruckersMotorCarrierPremium returns the value of SectionTruckersPremium. On an Update call, if IsSectionTruckersMotorCarrierAttached is false, IsSectionMotorCarrierAttached and IsSectionTruckersAttached with be set to false. If IsSectionTruckersMotorCarrierAttached is true, IsSectionMotorCarrierAttached and IsSectionTruckersAttached with be set to true only both values were previously false. Otherwise, the value is ignored in order to prevent data loss. If SectionTruckersMotorCarrierPremium is modified, only the SectionTruckersPremium value is modified. |
| 2021 | Insert_Policy Update_Policy | IssuingCompanyLookupCode and PremiumPayableLookupCode will only accept broker/company lookup codes which are associated to the particular type of business. This change affects all endpoints in version 2021 or later. |
| 2021 | Insert_MarketedPolicy Update_MarketedPolicy | IssuingCompanyLookupCode and PremiumPayableLookupCode will only accept broker/company lookup codes which are associated to the particular type of business. This change affects all endpoints in version 2021 or later. |
| 2021 | Insert_Line Update_Line | IssuingCompanyLookupCode and PremiumPayableLookupCode will only accept broker/company lookup codes which are associated to the particular type of business. This change affects all endpoints in version 2021 or later. |
| 2021 | Insert_Policy_MultiCarrierSchedule Update_Policy_MultiCarrierSchedule | IssuingCompanyLookupCode and PremiumPayableLookupCode will only accept broker/company lookup codes which are associated to the particular type of business. This change affects all endpoints in version 2021 or later. |
| 2021 | Insert_Contact | MarketingContactMethod now defaults to "Email" instead of "Mail". This change affects all endpoints in version 2021 or later. |
| 2021 | All Areas All Methods | Values for InputValidationFault properties "Description" and "FieldName", which were previously swapped, are now properly assigned so the value of the property corresponds to the property name. This change affects all endpoints in version 2021 or later. |
| 2021 | All Areas All Methods | The 2017_02 endpoint was retired. For more information, refer to the Versioning page. |
| 2020 MU3 | Action_Transaction_GenerateTaxFee | Action_Transaction_GenerateTaxFee() now returns an array of transaction ids that specify the transactions inserted by the action. Integrations consuming SDK without .NET users may break and require adjustment. We updated the interface of the 2021 and later endpoints to reflect this change. |
| 2020 MU2 | All Areas All Methods | Metadata publishing is now disabled by default. This prevents generating the proxy against production servers. For more information, refer to the Proxy page. |
| 2020 | Get_Risk | Get_Risk has been changed to Rating. This is to provide a more restful way to get the rating for a policy line. Integrations will be required to adapt for this change when upgrading past 2019. |
| 2020 | Get_Lookup | Many lookup type enumerations had their integer representation unintentionally increased. The enumerations with integer representation of 375 (Originally ReconciliationMethod) or above were increased. An integration that is passing the integer representation of the enumeration to the Get_Lookup would be at risk of breaking when using one of the affected lookup type enumerations. Integrations passing the string representation of the enumeration should be unaffected. Integrations will be required to adapt for this change when upgrading past 2020. |
| 2020 | All Areas All Methods | The 2017_01 endpoint was retired. For more information, refer to the Versioning page. |
| 2019 | Update_GeneralLedger_ReconciliationDirectBillCommission | Only 100 Direct Bill Reconciliation Record items can be updated at a time. This change was necessary to ensure data entirely gets rolled back upon error and to avoid time outs. This change affects all endpoints in version 2019 or later. |
| 2019 | Insert_Attachment | Attachments can no longer be inserted to folders that are not accessible by the account that the attachment is associated to. This change affects all endpoints in version 2019 or later. |
| 2019 | Update_Certificate_LiabilityHolder Update_Certificate_PropertyHolder Update_Certificate_IntermodalHolder | Certificate holders now contain multiple email addresses. We updated the interface of the 2019 and later endpoints to reflect this change. Previously written integrations will continue to execute without error. However, the behavior is as follows: On a Get call, the first email address of “Email recipients ” in the database will be displayed in the “Email” property. On an Update call, If no “Email recipients” exist in the database for the specified holder and the value in the “Email” property is set to a valid email address string, then one “Email recipient” will be insert to Epic system. On an Update call, If multiple “Email recipients” exist in the database for the specified holder and the value in the “Email” property is set to an empty string, then no “Email recipients” will be blanked out or deleted to prevent unintentional data loss in the Epic system. |
| 2019 | All Areas All Methods | The 2016_01 endpoint was retired. For more information, refer to the Versioning page. |
| 2018 | Get_Lookup | To support cultures in SDK, the Get_Lookup behavior changed for many enumerators. Get_Lookup should now always return "code like" values under the Code field and "descriptive information" under the Description field. Previously this information was either missing or located under the incorrect field. Please refer to the lookup section of the internationalization changes to discover how the behavior changed and for which enumerators. We significantly changed the behavior for 2018 and later endpoints. |
| 2018 | Update_GeneralLedger_Disbursement | New detail items can no longer be added when updating a disbursement. This change affects all endpoints in version 2018 or later. |
| 2018 | All Areas All Methods | The 2013_03, 2013_11, and 2014_11 endpoints were retired. For more information, refer to the Versioning page. |
| 2017.2 | Update_CanadianHabitational_Applicant | SDK no longer accepts blank values in cases where Epic would require values. When updating or inserting Contact Number Items, the ContactNumberNumber property needs to be populated. This change affects all endpoints in version 2017.2 or later. |
| 2017.2 | Update_Claim_PaymentExpense | Inserting, Updating, or Deleting payment/expense items will no longer automatically calculate the "Total" and "Subrogation" fields. It is up to the user to perform calculations and update those fields. This change affects all endpoints in version 2017.2 or later. |
| 2017.2 | Get_GeneralLedger_Receipt Get_GeneralLedger_Voucher Get_GeneralLedger_Disbursement | Due to scalability concerns, SDK no longer supports using the 'contains' comparison type when querying either Receipts, Vouchers or Disbursements by 'Refer #'. This change affects all endpoints in version 2017.2 or later. |
| 2017.2 | Action_MarketedPolicy_MoveMarketedLinesToCurrentPolicy | SDK no longer accepts blank values in cases where Epic would require values. If UpdateStageToOption is to set to 'Issued', then the PolicyNumber property needs to be populated. We are enforcing this rule in endpoints 2017.2 and later, in order to give more time to adapt. |
| 2017.1 | Insert_Opportunity Update_Opportunity | StageGroup is now required field. We are enforcing this rule in endpoints 2017.1 and later, in order to give more time to adapt. |