supplemental surepath user guide for epic v1-3€¦ · the epic billing integration permission...

Supplemental User

Guide for Epic

Integration Version 1.3b

Table of Contents SurePath is designed to provide policy and invoice information to the Applied Systems Epic agency management system. This process is referred to as Billing Integration and involves the sending of data requested by Epic to Epic for data import. This manual is a supplemental User Guide written for agencies utilizing this functionality. For other SurePath information refer to the SurePath User Manual or the online Help.

BEFORE YOU BEGIN ............................................................................................................................................... 1

OVERVIEW.....................................................................................................................................................................1 WHAT EXPORTS TO EPIC...................................................................................................................................................1 REQUIREMENTS / SET UP CHECKLIST ..................................................................................................................................1

CONFIGURE SUREPATH FOR EPIC BILLING INTEGRATION ....................................................................................... 3

BEFORE YOU BEGIN.........................................................................................................................................................3 USER PERMISSION TO ENABLE/DISABLE BOND RECORDS ........................................................................................................3 PRODUCER AND SERVICER SET UP ......................................................................................................................................4

Overview.................................................................................................................................................................4 Identify SurePath Users to be Used by Epic ............................................................................................................4 Set Up Client Producers and Servicers ....................................................................................................................4 Override Client Producers and Servicers in Execution.............................................................................................5 Change Producers and Servicers for an Individual Bond (for Subsequent Transactions)........................................5 Change Producers and Servicers for All Bonds .......................................................................................................5

BROKER BILL SET UP........................................................................................................................................................5 CLIENT LEVEL CONFIGURATION ..........................................................................................................................................6

Enable the Client, Bid Bonds and All Existing Bonds ...............................................................................................6 Disable the Client and All Existing Bonds................................................................................................................7 Tracking Client Integration Status ..........................................................................................................................7

EPIC MAPPING ....................................................................................................................................................... 8

BOND RECORD ENABLING AND DISABLING............................................................................................................ 9

DISABLE BILLING INTEGRATION FOR A NEW BOND OR SUBSEQUENT TRANSACTION ......................................................................9 New Bond ...............................................................................................................................................................9 Subsequent Transactions........................................................................................................................................9

ENABLE EXISTING BONDS FOR SUBSEQUENT TRANSACTIONS..................................................................................................10 TRACKING BOND INTEGRATION STATUS.............................................................................................................................10

TRANSACTION PROCESSING ................................................................................................................................ 11

OVERVIEW AND PROCESSING NOTES.................................................................................................................................11 EXECUTE AND RENEWAL TRANSACTION TYPES ....................................................................................................................11 DIRECT BILL .................................................................................................................................................................12

REPORTS.............................................................................................................................................................. 13

OVERVIEW...................................................................................................................................................................13 CLIENT AND SUBSIDIARY REPORT......................................................................................................................................13 CLIENT INTEGRATION STATUS REPORT...............................................................................................................................14 EPIC BOND RECONCILIATION REPORT................................................................................................................................15 USER PRODUCER/SERVICER CODE REPORT ........................................................................................................................17 NEW CUSTOM REPORT COLUMN FOR INTEGRATION STATUS .................................................................................................17

APPENDIX ............................................................................................................................................................ 18

APPENDIX A – DATA ELEMENTS PROVIDED IN EPICBILLINGINTEGRATION RESPONSE...................................................................18 APPENDIX B – DATA ELEMENTS PROVIDED IN EPICLOOKUP RESPONSE ....................................................................................22

Agency Site Lookup...............................................................................................................................................22 Transaction Type Lookup......................................................................................................................................22 SAA Code Lookup..................................................................................................................................................23 Billing Carriers ......................................................................................................................................................23 Issuing Carriers .....................................................................................................................................................23 Producers and Servicers........................................................................................................................................23

APPENDIX C – SAMPLE RESPONSE TO EPICBILLINGINTEGRATION CALL.....................................................................................24 This document is the confidential and proprietary property of InSure Vision Technologies and shall be used as an internal document

by the Licensee

1 Before You Begin

Before You Begin

Overview

SurePath is designed to provide policy and invoice information to the Applied Systems Epic agency management system reduce or eliminate duplicate entry of bond/policy data for accounting and invoicing purposes. The integration utilizes a series of web service calls using SOAP and XML protocols. • The EpicBillingIntegration call returns to Epic SurePath records for transactions processed for the requested site,

by the requested user and within the requested date range. • The EpicLookup call returns to Epic SurePath table contents needed for data elements for which Epic requires

mapping. Applied Systems hosts the integration interface and handles errors. Failures are recorded in Applied’s integration interface. After set up is complete SurePath users process transactions in SurePath as they normally do. Epic initiates a web service call requesting data. SurePath returns requested data to Epic for processing.

What Exports to Epic

For accounts that are configured for billing integration SurePath sends: • All bond types excluding Bid Bonds. Note: Although SurePath has the ability to include bid bonds Epic will not

process them in the current integration version. • All transaction types except the request, bid result and manual upload transaction. • Single and co-surety bonds • Agency and Direct Bill bonds • Broker Bill Data that is exported includes: o Invoicing data, such as payee, premium, commission, surcharge and municipal tax o Producer information for up to three Producers o Servicer information o Bond data such as description and Obligee name o The SurePath processing user For a more detailed field list, including mapping to Epic, refer to the Appendix on page 18. Please refer to Applied System’s user documentation for information on how Epic processes data received from SurePath.

Requirements / Set Up Checklist

1. Existing bonds that will be maintained through the integration must be in SurePath in the same term as they are in Epic.

2. The agency must be licensed by both Applied Systems and InSure Vision Technologies to use the SurePath

Epic Billing Integration. 3. The agency may require an Epic software update to utilize the integration. Please contact Applied Systems for

more information on these requirements. 4. Agencies may be required to make a firewall change to allow a web service call from SurePath to the Epic

server. This communication will use https and port 443. All of the Epic integration will occur via this web service. 5. The agency must configure SurePath. For detailed instructions refer to Configure SurePath for Epic Billing

Integration on page 3.

2 Before You Begin

6. The agency must configure Epic. Epic requires mapping of several data elements (i.e., carriers and SAA codes) for successful processing of transactions in Epic. The agency must complete this mapping prior to implementation and then maintain the mapping as data changes in SurePath. Mapping is accomplished through a series of EpicLookup web service calls where Epic requests current data from SurePath. For detailed instructions refer to Applied Systems’s documentation.

7. The agency must map existing SurePath clients and bonds to existing Epic clients and policies prior to using the

integration. Reports can be generated from SurePath to assist with this mapping (see Reports on page 13). For detailed information on mapping in Epic refer to Applied Systems’s documentation.

3 Configure SurePath for Epic Billing Integration

Configure SurePath for Epic Billing Integration

Before You Begin

Your site must be licensed to use the SurePath Epic Billing integration. For more information please contact [email protected]. This supplemental user guide assumes that all clients have been set up in SurePath and that all bonds have been entered. For information on adding a client or an existing bond to SurePath please refer to the SurePath Online Manual located in the Help section of SurePath.

User Permission to Enable/Disable Bond Records

The EPIC BILLING INTEGRATION permission gives a user the ability to exclude a bond record from billing integration either during or after execution. Transactions for an excluded bond will need to be manually entered into Epic. The EPIC BILLING INTEGRATION permission is set to disallow disabling of bonds by default. A SurePath user with Agency Administrator permission must assign the permission to allow disabling, if applicable.

Figure 1 - Epic Billing Integration Permission in User Profile

If Epic Billing Integration is … Then …

Checked User can disable integration for an individual bond during or after execution. Transactions are entered manually into Epic.

Unchecked User cannot disable integration for an individual bond. Transactions are entered in Epic via billing integration.


Producer and Servicer Set Up

Overview

Epic may be configured to use Producer and Servicer information provided by SurePath. Producers and Servicers must be identified in SurePath and then attached to the accounts to which they belong. Bond record changes may be made in Execution in Advanced Process or on the Bond Details page using the Edit Bond Producers/Servicers processing option. Identify SurePath Users to be Used by Epic

A user must have Agency Administrator permissions to make this change. 1. Select USERS from the SurePath menu. 2. Select a user to be used by AMS360. 3. Enter a value in the PRODUCER / SERVICER CODE field. Note: The user’s Epic lookup code is recommended.

SurePath filters users for Epic based on the field being NULL or not NULL.

Figure 2 - Producer/Servicer Code Field in SurePath

If Producer / Servicer Code is … Then …

Empty This user cannot be assigned to a SurePath client or bond as a Producer or Servicer.

Not Empty This user can be assigned to a SurePath client or bond as a Producer or Servicer. The value must be the corresponding Epic look up code.

4. Click SUBMIT to save changes.

Set Up Client Producers and Servicers

1. Select the CLIENT. Result: The Client / General page displays. 2. Complete the NAME column in the Producers and Servicers section of the screen.

Figure 3 - Producers and Servicers (SurePath)

3. Select SUBMIT to save changes. Notes: This change affects new bonds only. To apply these changes to all

existing bonds use Site / Reset Producer Servicers Codes.


Override Client Producers and Servicers in Execution

1. Start bond execution. 2. Complete the BASIC INFORMATION page. 3. Select ADVANCED PROCESS. 4. Select NEXT on the Issuing Carriers page. 5. Select NEXT on the Carrier’s rate/program page. Result: The Producers and Servicers page displays. 6. Modify entries in the NAME column as needed. 7. Select NEXT and continue with execution. Change Producers and Servicers for an Individual Bond (for Subsequent Transactions)

1. Select the bond. 2. Go to the PROCESSING OPTIONS section of the Bond Details screen. 3. Select EDIT BOND PRODUCERS / SERVICERS. 4. Modify entries in the name column as needed. 5. Click SUBMIT to save changes. Note: Producers and Services are sent to AMS360 on execution and renewal

only. Change Producers and Servicers for All Bonds

A user must have Agency Administrator permission to make this change. The Reset all Producers and Servicers feature applies the client Producer/Servicer setting, including Broker Bill To Code, to all existing bonds. 1. Select SITES from the main SurePath menu. 2. Select the Site for which this change applies. 3. Select RESET PRODUCER / SERVICER CODES from the toolbar. 4. Select RESET ALL PRODUCERS AND SERVICERS TO THE ACCOUNT DEFAULTS. Existing Producers / Servicers will be

overwritten. 5. Select SUBMIT. Result: A confirmation screen displays when the process is complete. All existing bonds are

updated with client Producer/Servicer defaults (the settings on the Client / General page).

Broker Bill Set Up

Epic may be configured to use Broker Bill commission information provided by SurePath. It is used in Epic for Billing to Broker and Bill Broker net. When Epic receives the commission for this account, the Bill Broker Net will get commission first. Note that brokers who are payees are billing carriers and would be handled in the carrier set up for the SurePath account. A single Broker Bill To Code may be attached to an account. Broker Bill is configured in the Producer/Servicer section of SurePath. Bond record changes may be made in Execution in Advanced Process or on the Bond Details page using the Edit Bond Producers/Servicers processing option. To send Broker Bill information to Epic enter the Epic Broker Bill code in the SurePath Broker Bill To Code field. Select the Commission Type and enter the corresponding Calculation Amount.

Figure 4 - Broker Bill to Code in SurePath


To update the Broker Bill To Code on all existing bonds use the Reset all Producers and Servicers feature described in Change Producers and Servicers for All Bonds.

Client Level Configuration

Enable the Client, Bid Bonds and All Existing Bonds

The following configuration options are available at the client level. These options may be defined during or after client creation. Only the Primary Agent or users with the Take Ownership permission can modify an existing client.

Figure 5 - Client / General Page for Client Level Configuration

SurePath Feature Description

Enable Epic Integration If checked, Epic integration is enabled for all new bonds on the account. Notes: o Users with the Epic Billing integration permission may disable individual

bonds during or after execution. o The client and all existing bonds are disabled when the checkmark is

removed. o Only the Primary Agent and users with the Take Ownership permission

can modify this setting.

Include Bid Bonds in Epic Integration

If checked, SurePath includes bid bonds in billing integration. Notes: o This option is not available unless Enable Epic Integration is checked. o Removing the checkmark excludes future bid bonds from integration

but has no affect on existing bid bonds. o Only the Primary Agent and users with the Take Ownership permission

can modify this setting. o Epic does not process Bid Bonds in the current integration version.

Bulk Enable Epic Integration for Existing Bonds

Check this option to enable all existing bonds on the account. Notes: o This action is not available unless Enable Epic Integration is checked. o Bid bonds are enabled based on the status of the Include Bid Bonds

option. o Only the Primary Agent and users with the Take Ownership permission

can perform this action.


Disable the Client and All Existing Bonds

Only the Primary Agent and users with the Take Ownership permission can disable a client. Disabling the client also disables all existing bonds. To disable the client and all existing bonds do the following: 1. Select the client. 2. Remove the checkmark from the ENABLE EPIC INTEGRATION option. 3. Click the Submit button. 4. Select OK when prompted to confirm you wish to proceed. Note: if you select Cancel and Enable Bid Bonds is

selected, you will need to reselect it when cancellation is complete.

5. Click OK at the final warning message. Result: The account and all existing bonds are disabled. All future

transactions must be entered manually in Epic.

Tracking Client Integration Status

If clients are individually enabled or disabled it may be difficult to keep track of client integration status. To generate a list of clients and their integration status run the CLIENT INTEGRATION STATUS REPORT. For more information refer to Reports on page 13.

8 Epic Mapping

Epic Mapping Epic requires mapping of several data elements (i.e., carriers and SAA codes) for successful processing of transactions in Epic. The agency must complete this mapping prior to implementation and then maintain the mapping as data changes in SurePath. Mapping is accomplished through a series of EpicLookup web service calls where Epic requests current data from SurePath. SurePath data elements that require mapping in Epic include:

• Agency Site • Transaction Type • SAA Code • Issuing Carrier • Billing Carrier • Producer • Servicer

For details on data sent to Epic in response to an EpicLookup call refer to Appendix B on page 22 For detailed instructions on mapping these data elements in Epic refer to Applied Systems’s documentation.

9 Bond Record Enabling and Disabling

Bond Record Enabling and Disabling

Disable Billing Integration for a New Bond or Subsequent Transaction

New Bond

An option has been added to SurePath execution that allows users with the Epic Billing Integration permission to remove a new bond from billing integration. To disable a new bond in execution remove the checkmark from the ENABLE EPIC INTEGRATION FOR THIS BOND option. Bonds removed from billing integration must be manually entered in Epic.

Figure 6 - Disable Epic Integration in Execution

Subsequent Transactions

An option has been added to the Bond Details page Processing Options that allows users with Epic Billing Integration permission to disable a bond record. Disabling a bond record disables billing integration for all subsequent transactions. To disable a bond go to the Bond Details page and select the enabled hyperlink in the EPIC INTEGRATION ENABLED option. Subsequent transactions for a bond that is disabled must be manually entered in Epic.

Figure 7 - Disable Bond Record

Please note that when a SurePath client is disabled all bonds for that client will be automatically disabled.

10 Bond Record Enabling and Disabling

Enable Existing Bonds for Subsequent Transactions

Existing bonds must be enabled for subsequent transactions to be included in billing integration. Existing bonds may be enabled in one of two ways: • Individually using the disabled link in the EPIC INTEGRATION DISABLED processing option on the Bond Details page

(see Figure 7). • Bulk using the BULK ENABLE EPIC INTEGRATION FOR EXISTING BONDS option on the Client / General page (see

Figure 5).

Tracking Bond Integration Status

If bonds are individually enabled or disabled it may be difficult to keep track of bond integration status. To generate a list of bonds and their integration status run the Epic Bond Reconciliation report or create a custom report using the Billing Integration column option. For more information refer to Reports on page 13.

11 Transaction Processing

Transaction Processing

Overview and Processing Notes

This supplemental user guide assumes that all existing bonds are in SurePath. Important! If you enter a bond in SurePath that is already in Epic you must use the Mark as Uploaded option in execution. Bonds processed without this option will be sent to Epic and inserted as a new policy.

Figure 8 - Mark as Uploaded in Execution for Existing Bonds

Important Processing Notes: • Carrier B2B transactions are not available for billing integration until SurePath receives a carrier acceptance or

the user removes a rejected or pending B2B transaction from the B2B upload. • Clients must be mapped in Epic before transactions can be successfully processed in Epic. • Existing bonds must be mapped in Epic before subsequent transactions can be successfully processed in Epic.

Execute and Renewal Transaction Types

A second transaction type has been added to execution and renewal that provide additional options for mapping Epic status and transaction codes.

Figure 9 - ExecuteAdditional - Execution

Figure 10 - RenewalNew - Renew

The user makes the selection, if applicable, when processing a new bond or renewal. The selection dictates the transaction type that is sent to Epic. For more information refer to Epic Mapping – Transaction Types on page 8.

12 Transaction Processing

In… If… Send…

Execution EXECUTE AS NEW ADDITIONAL is unchecked EXECUTE

Execution EXECUTE AS NEW ADDITIONAL is checked EXECUTEADDITIONAL

Renew RENEW AS NEW BUSINESS is unchecked RENEWAL

Renew RENEW AS NEW BUSINESS is checked RENEWALNEW

Direct Bill

An option has been added to SurePath Execution and Renewal for Direct Bill. The user makes the selection, if applicable, when processing a new bond or renewal. Subsequent transactions default to the setting of the previous new bond or renewal.

Figure 11 - Direct Bill

If… Send…

DIRECT BILl is unchecked A for Agency Bill

DIRECT BILL is checked D for Direct Bill

13 Reports

Reports

Overview

There are 4 standard reports located in the Reports module to help you: • Manage the integration status of clients and bonds • Map existing clients and bonds to Epic • Assess the set up requirements for identifying SurePath uses for use in Epic integration

.

Figure 12 - Standard Reports in SurePath

A column option has also been added to SurePath Custom Reports to assist you in tracking integration status using a custom report. All reports can be printed using the Internet Explorer print function or exported to Microsoft Excel.

Client and Subsidiary Report

The CLIENT AND SUBSIDIARY REPORT lists all clients and their subsidiaries and includes pertinent information for mapping SurePath clients to Epic clients. The report accommodates all SurePath billing integration initiatives. When configured for Epic it shows:

Column Notes

Site Code Unique code identifying the SurePath site

Client Name Name of client

ClientGUID Unique ID for the client (IVT_ClientCode) viewable on the Clients / General page

Subsidiary Name Subsidiary name

SubsidiaryGUID Unique ID for the subsidiary (OrgUnitGUID) viewable on the Clients / Subsidiary page. This displays on the report only if selected on the Report Layout screen.

ClientGUID SubsidiaryGUID

The concatenated code required by Epic for mapping a SurePath client to an Epic client.

14 Reports

Figure 13 - Client and Subsidiary Report Sample

To generate the Client and Subsidiary Report: 1. Click REPORTS from the SurePath menu. 2. Click CLIENT AND SUBSIDIARY REPORT. 3. If you have access to all Sites select the Site whose clients you want to view. 4. Select the client(s) you want to include on the report. 5. Select INCLUDE CLIENT GUID AND SUBSIDIARY GUID 6. Select the EXPORT TO EXCEL option to export the report contents to Microsoft Excel. 7. Click RUN REPORT. The report displays to the screen or exports to Excel depending on your selection.

Client Integration Status Report

To generate a list of clients and their billing integration status run the CLIENT INTEGRATION STATUS REPORT. SurePath lists clients and the enable status for billing integration, Bid Bonds and B2B. The report also includes unique Client IDs that can be used to map to corresponding clients in Epic. Included in the report is:

Column Notes

Agency Site Site Name and Site GUID

Client Client name

Client GUID Unique ID for client (IVT_ClientCode) viewable on the Clients / General page in SurePath. This displays on the report only if selected on the Report Layout screen.

Agency Billing Code This field is not used in Epic integration

Billing Integration • If the client is enabled for billing integration the word Epic displays. • If the client is disabled the field is empty

Bid Bonds Enabled • If Bid Bonds are included in billing integration a Y displays • If Bid Bonds are excluded from billing integration the field is empty

B2B Enabled • If B2B is enabled for this client a Y displays • If B2B is not enabled for this client the field is empty

15 Reports

Figure 14 - Client Integration Status Report Sample

To generate the Client Integration Status Report: 1. Click REPORTS from the SurePath menu. 2. Click CLIENT INTEGRATION STATUS REPORT. 3. If you have access to all Sites select the Site whose clients you want to view. 4. Select the client(s) to include on the report. 5. If desired, select INCLUDE CLIENT GUID. 6. Select the EXPORT TO EXCEL option to export the report contents to Microsoft Excel. 7. Click RUN REPORT. The report displays to the screen or exports to Excel depending on your selection.

Epic Bond Reconciliation Report

To obtain a list of bonds and billing integration status run the EPIC BOND RECONCILIATION REPORT. This report also provides pertinent information needed to map existing SurePath bonds to Epic policies. All custom report search criteria and report options are available on this report. The standard version of this report includes the following information for all open bonds except Bid Bonds:

Column Notes

Client name Client Name

ClientGUID Unique ID for client (IVT_ClientCode) viewable on the Clients / General page in SurePath.

Subsidiary Subsidiary Name

SubsidiaryGUID Unique ID for the subsidiary (OrgUnitGUID) viewable on the Clients / Subsidiary page.

16 Reports

Column Notes

Site Code Unique code identifying the SurePath site

Principal Address Principal address

Principal City City of the principal address

Principal State State of the principal address

Principal Zip Zip of the principal address

Bond ID Unique ID for the Bond

Bond Number SurePath Bond Number

Current Effective Date

Current term effective date

Expiration Date Current term expiration date

Issuing Carrier Code Unique ID for the issuing carrier

Issuing Carrier Issuing carrier name

Billing Carrier Code Unique ID for the billing carrier

Billing Carrier Billing carrier name

Billing Integration • If the bond is enabled for billing integration the word Epic displays. • If the bond is disabled the field is empty

BondID BondNO ICCode BCCode

Concatenated value required by Epic to map SurePath bond with Epic policy

Figure 15 – Epic Bond Reconciliation Report Sample

To generate the Epic Bond Reconciliation Report: 1. Click REPORTS from the SurePath menu. 2. Click EPIC BOND RECONCILIATION REPORT. 3. To run the report “as is” select RUN REPORT. Otherwise, prior to selecting Run Report, configure the report as

desired.

17 Reports

User Producer/Servicer Code Report

The USER PRODUCER/SERVICE CODE REPORT is a list of all SurePath users and the value in the Producer/Service code field. This report is available to users with Agency Administrator permissions and is useful in monitoring the identification of users to be used by Epic.

Column Notes

Site The unique code for the SurePath site to which the user belongs.

Logon The user’s logon

User Type Identifies the user as either Agent or Client user. The report can be filtered to show Active, Inactive or Both. Both is the default.

Name User’s name

Phone User’s phone number

Email User’s email address

Active User Identifies the user’s status as either Active or Inactive. The report can be filtered to show Active, Inactive or Both. Both is the default.

Producer/Servicer Code

The value entered in the user’s profile in the Producer/Servicer code field

Agency Admin An X identifies the user as an Agency Administrator

1. To generate the User Producer/Servicer Code Report: 2. Click Reports from the SurePath menu. 3. Click User Producer/Servicer Code Report. 4. To run the report “as is” select Run Report. Otherwise, prior to selecting Run Report, configure the report as

desired.

New Custom Report Column for Integration Status

A new column option called BILLING INTEGRATION has been added to the Custom Reports. This column is used to track integration status and displays the word Epic for enabled bonds and is blank for disabled bonds.

Figure 16 - Billing Integration Column Option

For more information and using SurePath Custom Report features refer to How Do I Use the Bond List Report Writer location online in SurePath Help / For Agents.

18 Appendix

Appendix

Appendix A – Data Elements Provided in EpicBillingIntegration Response

The following data elements are sent to Epic when transaction data is requested in the EpicBillingIntegration call. Not all data may be used by Epic. Please refer to documentation provided by Applied Systems Systems for information on how the data is used in Epic.

Tag Name in

Response

SurePath Field Name and Description

Epic

pagesTotal

Indicates the number of pages in the response

AgencyCode Unique identifier identifying the agency to which the transaction belongs.

AgencyName Agency name

BillingCarrierCode Unique identifier for the billing carrier on the bond. Billing Company. Must be mapped. See Epic Mapping – Carriers.

BillingCarrier FriendlyName

Friendly name of the billing carrier.

IssuingCarrierCode Unique identifier for the issuing carrier on the bond. Issuing Company. Must be mapped. See Epic Mapping – Carriers.

IssuingCarrierFriendlyName

Friendly name of issuing carrier.

BondAmount Bond Amount Description

BondID Unique ID for bond.

BondNumber Issuing carrier’s bond number. The value is “bid bond” for Bid Bonds.

Policy Number

BrokerBillCommissionCalcAmt

Number used to calculate broker’s commission.

BrokerBillCommissionType

Method for calculating broker’s commission. See ProducerCommissionType for values sent.

BrokerBillToCode Broker bill code from third party billing system.

BondUser SurePath logon for the user that processed the transaction.

CancellationType

Provide when Transaction Type = CANCEL. Indicates the type of cancellation. SurePath sends value 1-7 as follows: 1=Client Request 2= Non-Payment of Premium 3=Regulatory Change 4=Release by Obligee 5=Other 6=Flat 7=Close

IVT_ClientCode The Client ID which can be viewed on the Client / Client LookupCode

19 Appendix

Tag Name in

Response


Epic

General page. It is a unique identifier for the client to which the bond/transaction belongs.

ClientName Client name to which the bond/transaction belongs. Name

CommissionAmt Term commission for issuing carrier. Will be NULL for transactions that do not change premium/commission

Policy Estimated Commission

CommissionAmtChange

Commission change for issuing carrier. Will be NULL for transactions that do not change premium/commission

???

Description Bond description. Description

EffectiveDate Current term effective date. Note: Effective date is updated when TransType = RENEWAL or RENEWALNEW.

Effective Date

ExpirationDate Term expiration date. Mandatory SurePath field. Note: The Expiration Date may updated when TransType = RIDER, AUDIT, CANCEL or REVOKE

Expiration Date

StateofExecution Unique code for State of Execution (i.e., CA for California)

Issuing location

GlobalTransactionID

Unique ID for Transaction processed in SurePath. Epic may use this in their “resolved” table after the transaction is linked to monitor transactions that have already been processed.

InitialEffectiveDate Initial effective date Agency first written

MuniTax Term Municipal Tax for Issuing Carrier. Will be NULL for transactions that do not change premium/commission

???

MuniTaxChange Municipal Tax change for Issuing Carrier. Will be NULL for transactions that do not change premium/commission.

???

ObligeeName Obligee Name on bond. Description

OrgUnitGUID Unique identifier for Client Subsidiary.

OrgUnitName Subsidiary name for OrgUnitGUID.

PercentageofBusiness

Percentage of Liability for Issuing Carrier

PremiumAmt Term premium for the issuing carrier. Includes Maintenance Charges, if any. Will be NULL for transactions that do not change premium/commission

Policy Estimated Premium

PremiumAmtChange

Premium change for issuing carrier. Includes Maintenance Charges, if any. Will be NULL for transactions that do not change premium/commission

Amount (transaction)

PrincipalAddress Principal address on bond

PrincipalCity Principal city on the bond

PrincipalCountry Principal country on the bond

PrincipalName The Insured’s name on the bond

20 Appendix

Tag Name in

Response


Epic

PrincipalState Principal State on the bond

PrincipalZip Principal Zip Code on the bond

ProducerCommissionCalcAmt

Number used to calculate Producer’s commission. Percent and Amount

ProducerCommissionType

Method for calculating Producer’s commission. Respond with: None = Null 0 = Flat $ 1 = % of Premium 2 = % of Agency Commission 3 = % of Agency Net Commission

Type

RateCodeGUID Unique identifier for SAA Code on the bond. Type and Line. Mapping required. See Epic Mapping – SAA Codes.

RateCodeDesc Description for SAA Code on the bond.

SiteGUID Unique identifier identifying the Agency Site to which the bond/transaction belongs.

Agency and Branch. Must be mapped. See Epic Mapping – Agency Site.

SiteName Agency Site Name associated with SiteGUID

StateSurcharge Term State Surcharge for the Issuing Carrier. Will be NULL for transactions that do not change premium/commission

Mapping required.

StateSurchargeChange

State Surcharge Change for Issuing Carrier. Will be NULL for transactions that do not change premium/commission

Mapping required.

TransactionDate Date/time the transaction was processed

TransDescription Transaction description

TransEffectiveDate Effective date of Transaction Effective Date

TransType Unique code for Transaction Type. Policy Status and Transaction Code. Mapping required. See Epic Mapping – Transaction Types.

TransTypeDescription

Name associated with TransType. Indicates the type of transaction processed in SurePath (i.e., Execute).

ProducerCode Epic lookup code entered in Producer/Servicer Code field of Surepath user profile. Identifies SurePath users that are Epic Producers and Servicers.

UserName User Name associated with Producer. Producer assignment is made using Producer 1, 2 and 3 and is provided in an array as 1, 2 or 3. See Figure 3.

21 Appendix

Tag Name in

Response


Epic

UserLogon SurePath unique ID for Producer or Servicer Varies by agency. Mapping required. See Epic Mapping – Producers and Servicers.

ServicerCode Epic lookup code entered in Producer/Servicer Code field of Surepath user profile. Identifies SurePath users that are Epic Producers and Servicers. See Figure 3.

UserName User Name associated with UserLogon. Servicer assignment is made using Servicer 1, 2 or 3 and is provided in an array as 1, 2 or 3. See Figure 3.

UserLogon SurePath logon (unique ID) for Producer or Servicer. Varies by agency. Mapping required. See Epic Mapping – Producers and Servicers.

BillMethod SurePath sends A for Agency Bill and D for Direct Bill. User selects Direct Bill, if applicable, during bond execution and renewal.

Agency/Direct Bill Mode

22 Appendix

Appendix B – Data Elements Provided in EpicLookup Response

Agency Site Lookup

SurePath Agency Sites must be mapped to Epic Agency and Branch to successfully process a transaction in Epic. Upon request SurePath sends the following information for each of the agency’s SurePath Sites:

Field Name Contents

SiteGUID Unique code for the SurePath site (i.e., BALT-TEST)

SiteName The name of the SurePath site (i.e., Baltimore Test Agency)

Note: The Agency Site list is not filtered by Epic license; the list contains all of the agency’s SurePath Sites. Transaction Type Lookup

SurePath Transaction Types must be mapped to Epic Status and Transaction Code to successfully process a transaction in Epic. Upon request SurePath sends the following information:

TransType Transaction Type Notes

3 CANCEL For cancellations from the Cancel this bond link or Copy/Execute & Cancel

23 CLOSE For term bond closure initiated from Auto Close, Close Bond link, or Final Contract Audit. This is a SurePath status change only.

19 EXECUTE For new bond records initiated from Execute or Copy Bond and that do not have Mark as Uploaded checked.

18 EXECUTEADDITIONAL Same as Execute except the new bond record also has EXECUTE AS

NEW ADDITIONAL BUSINESS IN EPIC (EXECUTEADDITIONAL) checked.

22 OPEN For a term bond that is opened using the Open Bond link. This is a SurePath status change only and has no impact on premium.

16 UNDERRUN For a premium decrease issued from Final Contract Audit.

17 OVERRUN For a premium increase issued from Final Contract Audit.

5 REINSTATE For bond reinstatement initiated from Reinstate this bond.

21 RENEWAL For renewals initiated from Renew this bond link.

20 RENEWALNEW Same as renewal except the renewal also has RENEW AS NEW

BUSINESS IN EPIC (RENEWALNEW) checked.

9 REVOKE For revocations issued from the Revoke Bond link or Copy/Execute & Revoke.

2 RIDER For changes made using the SureForm Edit button, Edit Bond Information/Issue Rider link and Consent of Surety.

The Upload transaction, which is generated in Execute or Copy Bond when Mark as Uploaded is checked, is excluded from integration.

23 Appendix

SAA Code Lookup

SurePath SAA Codes must be mapped to Epic Type and Line for transactions to successfully process in Epic. Upon request SurePath sends the following for SAA Codes used as of the request date:

Field Name Contents

RateCodeGUID Unique identifier for the SAA Code (i.e., 50201985-2BB1-11D2-BDBB-204C4F4F5020)

RateCodeDesc SAA Code description (i.e., All Contractors License – Compliance)

Billing Carriers

SurePath billing carriers must be mapped to Epic Billing Companies for transactions to successfully process in Epic. Upon request SurePath sends the following for billing carriers used as of the request date:

Field Name Contents

BillingCarrierCode Unique code for SurePath billing carrier (i.e., CASHEA)

BillingCarrierFriendlyName The “friendly name” of the billing carrier (i.e., C.A. Shea & Company, Inc. – Intermediary)

Issuing Carriers

SurePath issuing carriers must be mapped to Epic Issuing Companies for transactions to successfully process in Epic. Upon request SurePath sends the following for issuing carriers used as of the request date:

Field Name Contents

IssuingCarrierCode Unique code for SurePath issuing carrier (i.e., CASHEATRAVELERSIC)

IssuingCarrierFriendlyName The “friendly name” of the issuing carrier (i.e., Travelers Casualty and Surety Company - CA SHEA)

BillingCarrierCode Unique code for SurePath billing carrier for reference (i.e., CASHEA)

Producers and Servicers

SurePath Producers and Servicers must be mapped in Epic for transactions to successfully process in Epic. Upon request SurePath sends the following for active agency users at Epic enabled Sites. Note the Site(s) must be enabled to retrieve this list.

Field Name Contents

ProducerCode Epic lookup code for the Producer or Servicer

UserLogon Unique ID for the SurePath user (i.e., aagent)

UserName User’s Name (i.e., Andy Agent)

SiteGUID Unique ID for the SurePath Site to which the user belongs (i.e., BALT-TEST)

SiteName Name of the SurePath Site to which the user belongs (Baltimore Test Agency)

24 Appendix

Appendix C – Sample Response to EpicBillingIntegration Call

<?xml version="1.0" encoding="utf-8" ?> - <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"> - <soap:Body>

- <EpicBillingIntegrationResponse xmlns="BillingIntegration">

- <EpicBillingIntegrationResult>

- <XMLDoc xmlns="">

<pagesTotal>1</pagesTotal>

- <Record>

<AgencyCode>LAURANEPIC</AgencyCode>

<AgencyName>Lauran's Epic Test Agency</AgencyName>

<BondAmount>50000.0000</BondAmount>

<BondID>7DADE9FA-C739-4F69-99E4-75B500AB22C9</BondID>

<IVT_ClientCode>62BA0DDA-E974-47D2-9560-5A60670F77B9</IVT_ClientCode>

<ClientName>Demo Client 010815</ClientName>

<Description>test</Description>

<EffectiveDate>2016-02-29T00:00:00</EffectiveDate>

<ExpirationDate>2017-02-27T00:00:00</ExpirationDate>

<StateOfExecution>CA</StateOfExecution>

<GlobalTransactionID>97F18E8D-AB1F-4E3E-A12B-

6822174538AD</GlobalTransactionID> <InitialEffectiveDate>2016-02-29T00:00:00</InitialEffectiveDate>

<ObligeeName>City of Los Angeles Dept of Public Works</ObligeeName>

<OrgUnitGUID>B1BC754F-7EA5-45BD-A7F9-DF01A9FD07B4</OrgUnitGUID>

<OrgUnitName>Demo Client 010815 Sub 2</OrgUnitName>

<PrincipalAddress>PO Box 123</PrincipalAddress>

<PrincipalCity>Orange</PrincipalCity>

<PrincipalCountry>US</PrincipalCountry>

<PrincipalName>Demo Client 010815</PrincipalName>

<PrincipalState>CA</PrincipalState>

<PrincipalZip>928669</PrincipalZip>

<RateCodeGUID>4A1C9E30-7601-11D2-97B3-EC2E0BC10000</RateCodeGUID>

<RateCodeDesc>Class A Contract</RateCodeDesc>

<SiteGUID>LAURANEPIC</SiteGUID>

<SiteName>Lauran's Epic Test Agency</SiteName>

<TransactionDate>2016-02-29T11:04:57</TransactionDate>

<TransDescription>Execution</TransDescription>

<TransEffectiveDate>2016-02-29T00:00:00</TransEffectiveDate>

<TransType>19</TransType>

<TransTypeDescription>EXECUTE</TransTypeDescription>

<BondUser>epic1</BondUser>

- <Carriers>

25 Appendix

- <Carrier>

<BillingCarrierCode>ACEBC</BillingCarrierCode>

<BillingCarrier_FriendlyName>ACE American Insurance

Company</BillingCarrier_FriendlyName>

<IssuingCarrierCode>ACEAMERICANIC</IssuingCarrierCode>

<IssuingCarrier_FriendlyName>ACE American Insurance

Company</IssuingCarrier_FriendlyName>

<PercentageofBusiness>100.0000</PercentageofBusiness>

<BondNumber>022916-000</BondNumber>

<CommissionAmt>150.0000</CommissionAmt>

<CommissionAmtChange>150.0000</CommissionAmtChange>

<MuniTax>0.0000</MuniTax>

<MuniTaxChange>0.0000</MuniTaxChange>

<PremiumAmt>500.0000</PremiumAmt>

<PremiumAmtChange>500.0000</PremiumAmtChange>

<StateSurcharge>0.0000</StateSurcharge>

<StateSurchargeChange>0.0000</StateSurchargeChange>

</Carrier>

</Carriers>

- <Producers>

- <Producer1>

<ProducerCode>E24</ProducerCode>

<UserName>Bart Bailey</UserName>

<UserLogon>epic24</UserLogon>

<CommissionCalcAmt>20.0000</CommissionCalcAmt>

<CommissionType>2</CommissionType>

</Producer1>

- <Producer2>


<UserName>Brian Stamper Test User</UserName>




</Producer2>

- <Producer3>


<UserName>Epic 20 Producer</UserName>




</Producer3>

</Producers>

- <Servicers>

- <Servicer1>

<ServicerCode>E21</ServicerCode>

<UserName>Epic 21 Servicer</UserName>




26 Appendix

</Servicer1>

- <Servicer2>


<UserName>Epic User 2</UserName>




</Servicer2>

</Servicers>

- <Producers>

- <Producer>


<UserName>Bart Bailey</UserName>




</Producer>

- <Producer>


<UserName>Brian Stamper Test User</UserName>




</Producer>

- <Producer>


<UserName>Epic 20 Producer</UserName>




</Producer>

</Producers>

- <Servicers>

- <Servicer>


<UserName>Epic 21 Servicer</UserName>




</Servicer>

- <Servicer>


<UserName>Epic User 2</UserName>




</Servicer>

</Servicers>

<BillMethod>A</BillMethod>

27 Appendix

</Record>

</XMLDoc>

</EpicBillingIntegrationResult>

</EpicBillingIntegrationResponse>

</soap:Body>

</soap:Envelope>

supplemental surepath user guide for epic v1-3€¦ · the epic billing integration permission...

Documents