AcordDescription

Allows to retrieve/update ACORD description

APIDescription
GET v1/Businesses/{businessID}/AcordDescription

Get the ACORD Description for a business

POST v1/Businesses/AcordDescription

Upsert ACORD Description for Certificate Holder or Lienholder

AcordForms

Allows you to retrieve/update ACORD forms

APIDescription
GET v1/ACORDForms/{acordFormID}

Get ACORD Form with data object

POST v1/ACORDForms/{acordFormID}/AssociatePolicy?policyID={policyID}

Updates the ACORD form with the PolicyID that it is associated with or -1 if it should be associated to the contact only.

POST v1/ACORDForms/{acordFormID}/Rename?newDescription={newDescription}

Rename an ACORD Form

GET v1/ACORDForms/ByCustomer/{customerID}

Get all acord form data for a customer/prospect ID. This does not result in the file, but the data that supports creating the ACORD Form

GET v1/ACORDForms/Templates/{templateID}

Get ACORD form template descriptions by acord form template ID

GET v1/ACORDForms?policyID={policyID}&contactId={contactId}

Get a list of ACORD forms for contact and policy

AdditonalContacts

Allows to retrieve additional/business contacts for customers

APIDescription
GET v1/CommercialCustomers/{parentEntityID}/BusinessContacts

Get a list of additional/business contacts for a customer (for 3rd party devs)

GET v1/PersonalCustomers/{parentEntityID}/AdditionalContacts

Get a list of additional/business contacts for a customer (for 3rd party devs)

AddressInfo

Allows to retrieve default address information

APIDescription
GET v1/Locations/{locationID}/Contacts/AddressInfo

Get the default address information

AgencyCommissionRules

Allows to retrieve/add Agency Commissions rules

APIDescription
POST v1/Commissions/AgencyRules/Get

Gets the list of Agency Commissions rules based on the filter

POST v1/Commissions/AgencyRules/Update

Adds or updates a commission rule for the agency

AgencyFees

Allows to retrieve/upsert agency fees

APIDescription
GET v1/Locations/{locationID}/Policies/AgencyFees

Get a list of Agency Fees

POST v1/Locations/{locationID}/Policies/AgencyFees

Upsert and agency fee

Billing

This endpoint return a list of billing information.

APIDescription
GET v1/Billing/LastModifiedCreated?startDate={startDate}&endDate={endDate}&pageNumber={pageNumber}&pageSize={pageSize}

Get a paged list of customer billing information that were created in a specified date range.

CampaignTemplateEditor

Allows to save template data

APIDescription
POST v1/CampaignTemplateEditor/TemplateData

Save template data

CancellationReasons

Allows to perform CRUD operations for cancellation reasons

APIDescription
GET v1/Locations/{locationID}/Policies/CancellationReasons

Get a list of cancellation reasons

POST v1/Locations/{locationID}/Policies/CancellationReasons

Insert a new cancellation reason

PUT v1/Locations/{locationID}/Policies/CancellationReasons/{cancellationReasonID}

Update a cancellation reason

DELETE v1/Locations/{locationID}/Policies/CancellationReasons/{cancellationReasonID}

Delete a cancellation reason

CarrierFees

Allows to perform CRUD operations for carrier fees

APIDescription
GET v1/Locations/{locationID}/Policies/CarrierFees

Get a list of carrier fees

POST v1/Locations/{locationID}/Policies/CarrierFees

Insert a carrier fee

PUT v1/Locations/{locationID}/Policies/CarrierFees/{carrierFeeID}

Update a carrier fee

DELETE v1/Locations/{locationID}/Policies/CarrierFees/{carrierFeeID}

Delete a carrier fee

Carriers

Allows to retrieve carriers

APIDescription
GET v1/Carriers

Get a list of all carriers for a user.

CommercialAutoVehicles

Allows to retrieve vehicles on a Commercial Auto Policy Details

APIDescription
GET v1/Policies/Details/{policyDetailID}/CommercialAuto/Vehicles

Get a list of vehicles on a Commercial Auto Policy Details

PUT v1/Policies/Details/CommercialAuto/Vehicles/Create

No documentation available.

CommInlandMarineAdditionalInterests

Allows to retrieve, update and delete additional interests section

APIDescription
POST v1/Policies/Details/{policyDetailID}/InlandMarine/AdditionalInterests

Update the Additional Interests Section on the Policy Details

DELETE v1/Policies/Details/{policyDetailID}/InlandMarine/AdditionalInterests/{additionalInterestID}?notes={notes}

Delete the Additional Interests Section on the Policy Details

POST v1/Policies/Details/{policyDetailID}/InlandMarine/AdditionalInterests/Import/{equipmentID}

Import Additional Interests to the Section on the Policy Details

GET v1/Policies/Details/{policyDetailID}/InlandMarine/AdditionalInterests?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&sortDirection={sortDirection}

Get a list of Additional Interests on the Policy Details

GET v1/Policies/Details/InlandMarine/AdditionalInterests/{additionalInterestID}

Get an Additional Interests Item on the Policy Details

CommInlandMarineBasicInfo

Allows to retrieve and upsert Basic Info Section data

APIDescription
GET v1/Policies/Details/{policyDetailID}/InlandMarine/BasicInfo

Get the Basic Info Section data for Inland Marine type policies

POST v1/Policies/Details/InlandMarine/BasicInfo

Upsert the Basic Info Section data for Inland Marine type policies

CommInlandMarineCoverageInfo

Allows to retrieve and upsert coverage info section data

APIDescription
GET v1/Policies/Details/{policyDetailID}/InlandMarine/CoverageInfo

Get the Coverage Info Section data for Inland Marine type policies

POST v1/Policies/Details/InlandMarine/CoverageInfo

Upsert the Coverage Info Section data for Inland Marine type policies

CommInlandMarineEquipmentStorage

Allows to retrieve, upsert and delete equipment storages

APIDescription
GET v1/Policies/Details/{policyDetailID}/InlandMarine/EquipmentStorage

Get all of the equipment storages for the specified Inland Marine type policies.

GET v1/Policies/Details/{policyDetailID}/InlandMarine/EquipmentStorage/{equipmentStorageID}

Get all of the details for a specific equipment storage for Inland Marine type policies.

POST v1/Policies/Details/InlandMarine/EquipmentStorage

Upserts an equipment storage for an existing Inland Marine type policy.

DELETE v1/Policies/Details/InlandMarine/EquipmentStorage/{equipmentStorageID}

Removes an equipment storage.

CommInlandMarineGeneralInfo

Allows to retrieve and upsert general info section data

APIDescription
GET v1/Policies/Details/{policyDetailID}/InlandMarine/GeneralInfo

Get the General Info Section data for Inland Marine type policies

POST v1/Policies/Details/InlandMarine/GeneralInfo

Upsert the General Info Section data for Inland Marine type policies

CommInlandMarineScheduleEquipment

Allows to retrieve, update and delete scheduled equipment data

APIDescription
GET v1/Policies/Details/{policyDetailID}/InlandMarine/ScheduledEquipment

Get the Scheduled Equipment Section data for Commercial Inland Marine type policies

GET v1/Policies/Details/{policyDetailID}/InlandMarine/ScheduledEquipment/{scheduledEquipmentID}

Get the Scheduled Equipment Section specific item for Commercial Inland Marine type policies

POST v1/Policies/Details/{policyDetailID}/InlandMarine/ScheduledEquipment/{scheduledEquipmentID}

Delete the Scheduled Equipment Section data for Commercial Inland Marine type policies

POST v1/Policies/Details/InlandMarine/ScheduledEquipment

Insert the Scheduled Equipment Section data for Commercial Inland Marine type policies

CommInlandMarineUnscheduleEquipment

Allows to retrieve, update and delete unscheduled equipment data

APIDescription
GET v1/Policies/Details/{policyDetailID}/InlandMarine/UnscheduledEquipment

Get the Unscheduled Equipment Section data for Commercial Inland Marine type policies

POST v1/Policies/Details/{policyDetailID}/InlandMarine/UnscheduledEquipment/{unscheduledEquipmentID}

Delete the Unscheduled Equipment Section data for Commercial Inland Marine type policies

POST v1/Policies/Details/InlandMarine/UnscheduledEquipment

Insert the Unscheduled Equipment Section data for Commercial Inland Marine type policies

Commissions

Allows to remove commission rules

APIDescription
DELETE v1/Commissions/Delete?ruleId={ruleId}

Deletes a commission rule

ContactInformation

Allows to retrieve contact Info types

APIDescription
GET v1/Contacts/{contactID}/ContactInformation/Types

Get all of Contact Info types

Contacts

Allows to retrieve/insert contacts

APIDescription
PUT v1/Contacts

Insert a contact into Catalyst with a simple contract

GET v1/Contacts/{contactId}/ContactSummaryDTO

Gets contact summary info for a single contact

GET v1/Contacts/LastModifiedCreated?startDate={startDate}&endDate={endDate}&pageNumber={pageNumber}&pageSize={pageSize}

Get a paged list of contacts that were created or modified in a specified date range.

ContactsAccountInfo

Allows to retrieve contact account information

APIDescription
GET v1/Contacts/{contactID}/AccountInfo

Get the account information for a contact including Agent and CSR

ContactsAddresses

Allows to retrieve contact addresses

APIDescription
GET v1/Contacts/{contactID}/Addresses

Return a list of address for a contact.

ContactsEmails

Allows to retrieve/update contact emails

APIDescription
GET v1/Contacts/{contactID}/Emails

Get the Emails for a contact

POST v1/Contacts/{contactID}/Emails

Update the Emails for a contact.

ContactsXDates

Allows to retrieve/update contact xDates

APIDescription
GET v1/Contacts/{contactID}/XDates

Return a list of xDates for a contact.

POST v1/XDates

Upsert xDate

GET v1/XDates/{id}

Get xDate by id

POST v1/XDates/{id}/AutoAdvance

Advances the date on the Xdate to the next interval based on the term/period (monthly,semi,annual,etc)

CustomerBilling

These endpoints return a list of billing information for a customer.

APIDescription
GET v1/Customers/{contactId}/Billing/CompanyCommission?numDaysPrior={numDaysPrior}

Gets Company Commission Billing Information for a customer

GET v1/Customers/{contactId}/Billing/CompanyPremium?numDaysPrior={numDaysPrior}

Gets Company Premium Billing Information for a customer

GET v1/Customers/{contactId}/Billing/Customer?numDaysPrior={numDaysPrior}

Gets Customer Billing Information for a customer

GET v1/Customers/{contactId}/Billing/FinancePremium?numDaysPrior={numDaysPrior}

Gets Finance Premium Billing Information for a customer

GET v1/Customers/{contactId}/Billing/ProducerCommission?numDaysPrior={numDaysPrior}

Gets Producer Commission Billing Information for a customer

CustomerEmployer

Allows to retrieve employers for a customers

APIDescription
GET v1/Customers/{customerID}/Employers

Get a list of employers for a customer id (for 3rd party devs)

CustomerNumbers

Allows to update customer number settings

APIDescription
PUT v1/CustomerNumbers/Put?locationID={locationID}

Update the location's customer number settings

Customers

Allows to retrieve/relocate customers

APIDescription
POST v1/Customers/{contactID}/Relocate?newOfficeId={newOfficeId}

Relocate a customer/prospect to a different location

GET v1/Customers/{customerID}/CustomerDetailSummary

Get a detail summary of information about a customer (for 3rd party devs)

CustomerSources

Allows to perform CRUD operations for customer sources

APIDescription
GET v1/Locations/{locationID}/Contacts/CustomerSources

Get a list of Customer Sources

POST v1/Locations/{locationID}/Contacts/CustomerSources

Insert a customer source

PUT v1/Locations/{locationID}/Contacts/CustomerSources/{customerSourceID}

Update a customer source

DELETE v1/Locations/{locationID}/Contacts/CustomerSources/{customerSourceID}

Delete a Customer Source

Departments

Allows to perform CRUD operations for departments

APIDescription
POST v1/Locations/{locationID}/Contacts/Departments

Insert a department

GET v1/Locations/{locationID}/Contacts/Departments

Get a list of Departments

PUT v1/Locations/{locationID}/Contacts/Departments/{departmentID}

Update an department

DELETE v1/Locations/{locationID}/Contacts/Departments/{departmentID}

Delete a department

Documents

Allows to retrieve images associated with the contact, update avatar

APIDescription
GET v1/Documents/Images?entityId={entityId}

Get a list of images associated to the contact

POST v1/Documents/UpdateAvatar?entityId={entityId}&blobInfoId={blobInfoId}

Sets a particular file as the avatar

Emails

Allows to retrieve available email attachments (ACORD Forms, Documents, and Images (files))

APIDescription
GET v1/Emails/ACORDs?entityId={entityId}&entityType={entityType}&excludeCertificates={excludeCertificates}&orderBy={orderBy}&sortDirection={sortDirection}

Get a list of Acord Forms to display as available email attachments

GET v1/Emails/DocsAndImages?entityId={entityId}&entityType={entityType}&excludeFileTypes={excludeFileTypes}&orderBy={orderBy}&sortDirection={sortDirection}

Get a list of Documents and Images (files) to display as available email attachments

Employees

Allows to retrieve logged in user's login status

APIDescription
GET v1/Employees/LoginStatus

Get the current logged in user's login status.

EmployeeShifts

Allows to retrieve employee shifts

APIDescription
GET v1/Employees/{id}/EmployeeShifts

Get the employee's shifts

EndorsementReasons

Allows to perform CRUD operations for endorsement reasons

APIDescription
GET v1/Locations/{locationID}/Policies/EndorsementReasons

Get a list of endorsement reasons

POST v1/Locations/{locationID}/Policies/EndorsementReasons

Insert a new endorsement reason

PUT v1/Locations/{locationID}/Policies/EndorsementReasons/endorsementReasonID?endorsementReasonID={endorsementReasonID}

Update an endorsement reason

DELETE v1/Locations/{locationID}/Policies/EndorsementReasons/endorsementReasonID?endorsementReasonID={endorsementReasonID}

Delete an endorsement reason

Endorsements

Allows to update approved endorsements

APIDescription
POST v1/Policies/Endorsements/UpdateApproved

Update approved endorsements

FileFolders

Methods to maintain File Folders

APIDescription
GET v1/FileFolders?entityId={entityId}

Get Folders by entity id

FileProperties

Methods to maintain File Properties

APIDescription
POST v1/Files/Properties/{id}

Update the file properties for a specific file

GET v1/Files/Properties/{id}?downloadAs={downloadAs}

Get the file properties for a specific file id.

Files

Allows to retrieve/upload files

APIDescription
GET v1/Files/{id}

Get the raw stream of the file by ID

PUT v1/Files/File

Upload a stream to the cloud associated to contact ID, asynchronously.

GET v1/Files/FilesByContact?contactid={contactid}&dlFileType={dlFileType}&pageNumber={pageNumber}&pageSize={pageSize}

Get a list of files associated to a Contact ID.

GET v1/Files/FilesByPolicy?contactid={contactid}&policyid={policyid}&dlFileType={dlFileType}&pageNumber={pageNumber}&pageSize={pageSize}

Get a list of files associated to a Policy ID.

GarageCoverages

Allows to retrieve and upsert garage coverages

APIDescription
GET v1/Policies/Details/{policyDetailId}/Garage/Coverages

Get a list of garage coverages for policy

POST v1/Policies/Details/Garage/Coverages

Upsert garage coverages with provided coverages

GarageOperations

Allows to retrieve and upsert policy details garage operations

APIDescription
GET v1/Policies/Details/{policyDetailId}/Garage/Operations

Get policy details garage operations by policy details Id

POST v1/Policies/Details/Garage/Operations

Upsert policy details garage operations

HomeownersLocations

Allows to retrieve locations on a Homeowners Policy Details

APIDescription
GET v1/Policies/Details/{policyDetailID}/Homeowners/Locations

Get a list of locations on a Homeowners Policy Details

Industries

Allows to perform CRUD operations for industries and related occupations

APIDescription
GET v1/Locations/{locationID}/Contacts/Industries

Get a list of Industries and related occupations

POST v1/Locations/{locationID}/Contacts/Industries

Insert an Industry and it's related occupations

PUT v1/Locations/{locationID}/Contacts/Industries/{industryID}

Update an Industry and its occupations

DELETE v1/Locations/{locationID}/Contacts/Industries/{industryID}

delete an industry

GET v1/Locations/{locationID}/Contacts/Industries/{industryId}/Occupations

get a list of Occupations for an Industry

Invoice

This endpoint returns invoice information with billing details.

APIDescription
GET v1/Locations/{locationId}/Invoices/{invoiceNo}

Gets Invoice Information with Billing Details

InvoiceNumbers

Allows to retrieve/update invoice number

APIDescription
GET v1/Locations/{locationID}/Finance/InvoiceNumbers

Get the Invoice number settings

POST v1/Locations/{locationID}/Finance/InvoiceNumbers

Update the Invoice Number Settings

Languages

Allows to perform CRUD operations for languages

APIDescription
GET v1/Locations/{locationID}/Contacts/Languages

Get the list of languages

POST v1/Locations/{locationID}/Contacts/Languages

Insert a language

PUT v1/Locations/{locationID}/Contacts/Languages/{languageID}

Update a language ID Record

DELETE v1/Locations/{locationID}/Contacts/Languages/{languageID}

Delete a language ID

LinesOfBusiness

Allows to retrieve/assign/remove Lines of Business and Coverages

APIDescription
GET v1/Locations/{locationID}/Policies/LinesOfBusiness

Get the Lines of Business' and Coverages

DELETE v1/Locations/{locationID}/Policies/LinesOfBusiness/{locationLOBID}

Remove(Hide) a line of business for a location

DELETE v1/Locations/{locationID}/Policies/LinesOfBusiness/{locationLOBID}/Coverages/{locationCoverageID}

Remove(hide) a location's coverage from the location's line of business

POST v1/Locations/{locationID}/Policies/LinesOfBusiness/{locationLOBID}/Coverages?systemCoverageID={systemCoverageID}

Assign a system coverage for a line of business for a Location.

POST v1/Locations/{locationID}/Policies/LinesOfBusiness/{systemLineOfBusinessID}

Assign a Line of Business to a Location

GET v1/Locations/{locationID}/Policies/LinesOfBusiness/{systemLineOfBusinessID}/SystemCoverages

Get the available coverages that can be added to a Line Of Business

GET v1/Locations/Policies/SystemLines

Get the available Lines of Business that can be added to a Location

LinkedAccount

Allows to retrieve linked accounts

APIDescription
GET v1/Customers/{customerID}/LinkedAccounts

Get Linked Accounts

Locations

Allows to retrieve current user's locations, location details

APIDescription
GET v1/Locations/{locationID}

Get full details on a location

GET v1/Locations/{locationID}/Address

Get the locations main address

GET v1/Locations/UserLocations

Get the current user's list of locations

Lookups

Provides methods for getting the possible values of "dropdown" properties.

APIDescription
GET v1/Lookups/AddressTypes

Returns the list of Address types

POST v1/Lookups/BusinessTypes

Gets a list of Business Types used for Commercial Customers, such as LLC or Incorporation.

GET v1/Lookups/ContactInfoTypes

Get a list of Contact Info Types to be used to insert/update EntityContactInfoDTO, PhoneNumberDTO, EmailDTO, WebsiteDTO, etc.

GET v1/Lookups/ContactSubTypes

Get list of contact sub types

GET v1/Lookups/ContactTypes

Get list of Contact Types

GET v1/Lookups/ContactTypesAndSubTypes

Get list of Contact Types with their child sub types

GET v1/Lookups/Countries

Returns a list of Countries

GET v1/Lookups/Countries/{countryCode}/States

Returns the states/provinces for the specified country

GET v1/Lookups/DownloadAsFileTypes

Get list of download file types

GET v1/Lookups/FileRelations

Get list of file relations

POST v1/Lookups/QQSolutionsStatus

Get The System Status for all of QQSolutions

GET v1/Lookups/States

Returns the states for The United States of America

GET v1/Lookups/States/{stateCode}

Returns a specific state

NamedInsured

Allow to retrieve named insured for the specified policy

APIDescription
GET v1/Policies/{policyId}/NamedInsured

Gets the named insured for the specified policy

NonCustomerBilling

These endpoints return a list of billing information for noncustomers: carriers, employees, finance companies, MGAs, and prospects.

APIDescription
GET v1/NonCustomers/{contactId}/Billing/CompanyCommission?numDaysPrior={numDaysPrior}

Gets Company Commission Billing Information for noncustomers. This endpoint is available for carriers, MGAs and prospects.

GET v1/NonCustomers/{contactId}/Billing/CompanyPremium?numDaysPrior={numDaysPrior}

Gets Company Premium Billing Information for noncustomers. This endpoint is available for carriers, MGAs and prospects.

GET v1/NonCustomers/{contactId}/Billing/Customer?numDaysPrior={numDaysPrior}

Gets Customer Billing Information for noncustomers. This endpoint is available for prospects.

GET v1/NonCustomers/{contactId}/Billing/FinancePremium?numDaysPrior={numDaysPrior}

Gets Finance Premium Billing Information for noncustomers. This endpoint is available for finance companies and prospects.

GET v1/NonCustomers/{contactId}/Billing/ProducerCommission?numDaysPrior={numDaysPrior}

Gets Producer Commission Billing Information for noncustomers. This endpoint is available for employees and prospects.

Notes

Allows to retrieve/create notes

APIDescription
GET v1/Contacts/{contactID}/Notes?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}

Get a paged list of notes for a contact

PUT v1/Contacts/Notes

Create a new note

Occupations

Allows to perform CRUD operations for occupations

APIDescription
GET v1/Locations/{locationID}/Contacts/Occupations

Get the list of occupations

POST v1/Locations/{locationID}/Contacts/Occupations

insert a new occupation

PUT v1/Locations/{locationID}/Contacts/Occupations/{occupationID}

Update an occupation

DELETE v1/Locations/{locationID}/Contacts/Occupations/{occupationID}

Delete an occupation

PaymentInformation

Allows to retrieve/update payment information

APIDescription
GET v1/Locations/{locationID}/Finance/PaymentInformation

Get the payment information

POST v1/Locations/{locationID}/Finance/PaymentInformation

Update the Payment information

PaymentPayableAddress

Allows to retrieve/update Payment Payable To address

APIDescription
GET v1/Locations/{locationID}/Finance/PaymentPayableAddress?payableToType={payableToType}

Get the Payment Payable To address for a specific location.

POST v1/Locations/Finance/PaymentPayableAddress

Update a Payment Payable To address

PersonalAutoDrivers

Allows to retrieve details for a drivers on a personal auto

APIDescription
GET v1/Policies/Details/{policyDetailID}/PersonalAuto/DriverList

Get a list of Drivers on a personal auto policy detail

GET v1/Policies/Details/PersonalAuto/Drivers/{driverID}

Get details for a specific driver on a personal auto policy detail

PersonalAutoLiabilityCoverages

Allows to retrieve liability coverages on a policy detail for personal auto

APIDescription
GET v1/Policies/Details/{policyDetailID}/PersonalAuto/LiabilityCoverages

Get a list of Liability Coverages on a policy detail for personal auto

PersonalAutoPhysicalDamageCoverages

Allows to retrieve physical coverages per vehicle for policy details for personal auto

APIDescription
GET v1/Policies/Details/PersonalAuto/Vehicles/{vehicleID}/PhysicalCoverages

Get a list of physical coverages per vehicle for policy details for personal auto

PersonalAutoVehicles

Allows to retrieve vehicles on a Personal Auto Policy Details

APIDescription
GET v1/Policies/Details/{policyDetailID}/PersonalAuto/Vehicles

Get a list of vehicles on a Personal Auto Policy Details

PersonalInformation

Allows to retrieve personal information section for a customer

APIDescription
GET v1/Customers/{customerID}/PersonalInformation

Get Personal Information section for a customer

PersonalInlandMarineAdditionalInterests

Allows to retrieve, update and remove additional interest on the policy details

APIDescription
POST v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/AdditionalInterests

Update the Additional Interests Section on the Policy Details

DELETE v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/AdditionalInterests/{additionalInterestID}?notes={notes}

Delete the Additional Interests Section on the Policy Details

POST v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/AdditionalInterests/Import/{equipmentID}

Import Additional Interests to the Section on the Policy Details

GET v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/AdditionalInterests?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&sortDirection={sortDirection}

Get a list of Additional Interests on the Policy Details

GET v1/Policies/Details/PersonalInlandMarine/AdditionalInterests/{additionalInterestID}

Get an Additional Interests Item on the Policy Details

PersonalInlandMarineCoverageInfo

Allows to retrieve, upsert and remove coverage infos

APIDescription
GET v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/CoverageInfo

Get all of the coverage infos for the specified Personal Inland Marine type policies

GET v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/CoverageInfo/{coverageInfoID}

Get all of the details for a specific coverage info for Personal Inland Marine type policies

POST v1/Policies/Details/PersonalInlandMarine/CoverageInfo

Upserts a coverage info for an existing Personal Inland Marine type policy.

DELETE v1/Policies/Details/PersonalInlandMarine/CoverageInfo/{coverageInfoID}

Removes a coverage info for Personal Inland Marine type policies

PersonalInlandMarineGeneralInfo

Allows to retrieve General Info Section data for Inland Marine type policies

APIDescription
GET v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/GeneralInfo

Get the General Info Section data for Inland Marine type policies

POST v1/Policies/Details/PersonalInlandMarine/GeneralInfo

Upsert the General Info Section data for Inland Marine type policies

PersonalInlandMarineSafeVaults

Allows to retrieve, upsert and remove safe/vault

APIDescription
GET v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/SafeVault

Get all of the safe/vault infos for the specified Personal Inland Marine type policies

GET v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/SafeVault/{safeVaultID}

Get all of the details for a specific safe/vault for Personal Inland Marine type policies

POST v1/Policies/Details/PersonalInlandMarine/SafeVault

Upserts a safe/vault for an existing Personal Inland Marine type policy.

DELETE v1/Policies/Details/PersonalInlandMarine/SafeVault/{safeVaultID}

Removes a safe/vault for Personal Inland Marine type policies.

PersonalInlandMarineScheduleOfProperties

Allows to retrieve, upsert and remove schedules of properties

APIDescription
GET v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/ScheduleOfProperty

Get all of the schedule of properties for the specified Personal Inland Marine type policies

GET v1/Policies/Details/{policyDetailID}/PersonalInlandMarine/ScheduleOfProperty/{propertyID}

Get all of the details for a specific schedule of property for Personal Inland Marine type policies

POST v1/Policies/Details/PersonalInlandMarine/ScheduleOfProperty

Upserts a schedule of property for an existing Personal Inland Marine type policy.

DELETE v1/Policies/Details/PersonalInlandMarine/ScheduleOfProperty/{propertyID}

Removes a schedule of property for Personal Inland Marine type policies.

PhoneNumbers

Allows to retrieve/update phone numbers for contacts

APIDescription
GET v1/Contacts/{contactID}/PhoneNumbers

Get the phone numbers for a contact

POST v1/Contacts/{contactID}/PhoneNumbers

Update the phone numbers for a contact.

Policies

Allows to retrieve, insert and search policies

APIDescription
PUT v1/Policies

Insert a pending policy into Catalyst

GET v1/Policies/ByCustomer/{customerId}?keyword={keyword}&page={page}&rowCount={rowCount}

Get a list of policies for a customer ID

GET v1/Policies/ImportPolicy/GetList?contactId={contactId}&activeOnly={activeOnly}&excludePrs={excludePrs}

Get a list of policies for the import list popup

GET v1/Policies/LastModifiedCreated?startDate={startDate}&endDate={endDate}&pageNumber={pageNumber}&pageSize={pageSize}

Get a list of modified policies given a date range with paging

POST v1/Policies/SearchByPolicyNumbers

Search for Policies based on a list of Policy Numbers

GET v1/PolicySummaryForApi?policyID={policyID}

Get policy information summary detail information for a policy (for 3rd party devs)

PoliciesInfo

Allows to retrieve basic policy info including agent and CSR

APIDescription
GET v1/Policies/{policyID}/PolicyInfo

Retrieves the basic policy info including agent and CSR

PolicyACORDForms

Allows to retrieve and rename ACORD forms, retrieve drivers and vehicles on policy

APIDescription
GET v1/PolicyACORDForms/{policyId}/AcordSelectorDriverList?policyDetailsId={policyDetailsId}&lobInternalCode={lobInternalCode}

Get List of Drivers on Policy and format for ACORD Selector List

GET v1/PolicyACORDForms/{policyId}/AcordSelectorVehicleList?policyDetailsId={policyDetailsId}&lobInternalCode={lobInternalCode}

Get List of Vehicles on Policy and format for ACORD Selector List

GET v1/PolicyACORDForms/AcordAutoIdCardTemplateList

Get List of ACORD Templates for Auto ID Cards

GET v1/PolicyACORDForms/AcordSelectListAutoIdTemplates

Get Simple List of ACORD Templates for Auto ID Cards

GET v1/PolicyACORDForms/GetACORDWithData/{acordFormID}?policyID={policyID}

Get the ACORD form with data object

GET v1/PolicyACORDForms/GetList?policyID={policyID}

Get a list of ACORD Forms for a specific policy ID

POST v1/PolicyACORDForms/Rename?policyID={policyID}&acordFormID={acordFormID}&newDescription={newDescription}

Rename an ACORD form

PolicyACORDFormTemplates

Allows to get an ACORD form template descriptions

APIDescription
GET v1/Policies/AcordFormTemplate/{acordFormTemplateId}

Get an acord form template descriptions by acord form template id

PolicyAdjustments

This endpoint returns a list of adjustments for a policy.

APIDescription
GET v1/Policies/{policyId}/Adjustments

Gets the List of Adjustments for a policy

PolicyBilling

These endpoints return a list of billing information for a policy.

APIDescription
GET v1/Policies/{policyId}/Contacts/{contactId}/Billing/CompanyCommission?numDaysPrior={numDaysPrior}

Gets Company Commission Billing Information for a policy

GET v1/Policies/{policyId}/Contacts/{contactId}/Billing/CompanyPremium?numDaysPrior={numDaysPrior}

Gets Company Premium Billing Information for a policy

GET v1/Policies/{policyId}/Contacts/{contactId}/Billing/Customer?numDaysPrior={numDaysPrior}

Gets Customer Billing Information for a policy

GET v1/Policies/{policyId}/Contacts/{contactId}/Billing/FinancePremium?numDaysPrior={numDaysPrior}

Gets Finance Premium Billing Information for a policy

GET v1/Policies/{policyId}/Contacts/{contactId}/Billing/ProducerCommission?numDaysPrior={numDaysPrior}

Gets Producer Commission Billing Information for a policy

PolicyCarriers

Allows to retrieve the policy carrier information by carrier id

APIDescription
GET v1/PolicyCarriers?carrierID={carrierID}

Get the Policy Carrier Display Information by Carrier ID

PolicyCommissions

Allows to default the commission for the given quote/policy object

APIDescription
POST v1/PolicyCommissions/DefaultCommission

Default the commission information for the given quote/policy object

PolicyDetailsFarmAdditionalInterests

Additional Interest Controller for farm policies

APIDescription
GET v1/Policies/Details/{policyDetailID}/FarmAdditionalInterests

Get a list of farm additional interests for a specified policy detail

GET v1/Policies/Details/{policyDetailID}/FarmAdditionalInterests/{id}?isAnimalAdditionalInterest={isAnimalAdditionalInterest}

Get farm additional interests for a specified policy detail by ID

GET v1/Policies/Details/{policyDetailID}/FarmAdditionalInterests/AnimalsPropertiesDropdown

Get a dropdown list for animals and properties

PolicyDetailsFarmAnimals

Animals Controller for farm policies

APIDescription
GET v1/Policies/Details/{policyDetailID}/FarmAnimals

Get a list of farm animals for a specified policy detail

GET v1/Policies/Details/{policyDetailID}/FarmAnimals/{id}

Get a farm animal for a specified policy detail by Id

PolicyDetailsFarmPersonalProperties

Personal Properties Controller for farm policies

APIDescription
GET v1/Policies/Details/{policyDetailID}/FarmPersonalPropertyCoverages

Get a list of personal property coverage details for a given policy detail

GET v1/Policies/Details/{policyDetailID}/FarmPersonalPropertyCoverages/{id}

Get personal property coverage detail for a given policy detail by id

GET v1/Policies/Details/{policyDetailID}/FarmPersonalPropertyCoverages/Detail?personalPropertyCoverageId={personalPropertyCoverageId}

Get personal property coverage detail for a given policy detail by id

PolicyDetailsFarmPremises

Premises Controller for farm policies

APIDescription
GET v1/Policies/Details/{policyDetailID}/FarmPremises

Get a list of farm premises details for a specified policy detail

GET v1/Policies/Details/{policyDetailID}/FarmPremises/{id}

Get farm premises details for a specified policy detail by Id

GET v1/Policies/Details/{policyDetailID}/FarmPremises/PremiseDetail?premisId={premisId}

Get farm premises details for a specified policy detail by premis Id

PolicyDetailsFarmScheduledProperties

Scheduled Properties Controller for farm policies

APIDescription
GET v1/Policies/Details/{policyDetailID}/FarmScheduledProperties

Get a list of farm scheduled properties for specified policy detail

GET v1/Policies/Details/{policyDetailID}/FarmScheduledProperties/{id}

Get farm scheduled properties for specified policy detail by Id

PolicyDetailsFarmUnscheduledProperties

Unscheduled Properties Controller for farm policies

APIDescription
GET v1/Policies/Details/{policyDetailID}/FarmUnscheduledProperties

Get a list of farm unscheduled properties

GET v1/Policies/Details/{policyDetailID}/FarmUnscheduledProperties/{id}

Get farm unscheduled properties by Id

GET v1/Policies/Details/FarmUnscheduledProperties/Classes

Get a list of all classes of farm unscheduled properties

GET v1/Policies/Details/FarmUnscheduledProperties/SubClasses?classID={classID}

Get a list of all subclasses of farm unscheduled properties by class Id

PolicyDetailsGaragePremises

Premises Controller for farm policies

APIDescription
GET v1/Policies/Details/{policyDetailId}/GaragePremises

Get a list of the garage premises policy details

GET v1/Policies/Details/{policyDetailID}/GaragePremises/{id}?policyDetailsId={policyDetailsId}&premisesId={premisesId}

Get garage premises policy details by ID

GET v1/Policies/Details/{policyDetailId}/GaragePremises/PremiseDetail?premisId={premisId}

Get garage premises policy details by ID

PolicyDetailsGeneralLocations

Allows to retrieve a list of locations for a policy

APIDescription
GET v1/Policies/{policyID}/GeneralLocations?pageNumber={pageNumber}&pageSize={pageSize}

Get a list of locations for a policy

PolicyDownPayment

Allows to retrieve down payment information

APIDescription
GET v1/Policies/{policyId}/DownPayment

Returns the down payment information for a policy

PolicyLines

Allows to get the policy line summaries

APIDescription
GET v1/Policies/{policyID}/PolicyLines

Get the policy line summaries for lines under a Policy ID

PolicyNotes

Allows to get policy notes

APIDescription
GET v1/Policies/{policyID}/Notes?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}

Get notes for a Policy ID

PolicyProposal

Allows to generate a policy proposal

APIDescription
POST v1/PolicyProposal

Generate a policy proposal for the given list of quote IDs

PolicySources

Allows to perform CRUD operations for policy sources

APIDescription
PUT v1/Locations/{locationID}/Policies/PolicySources/{policySourceID}

Update a policy source

DELETE v1/Locations/{locationID}/Policies/PolicySources/{policySourceID}

Delete a policy source

GET v1/PolicySources/GetList?locationID={locationID}

Get a list of policy sources

POST v1/PolicySources/Post?locationID={locationID}

Insert a policy source

PolicySummary

Allows to generate a policy summary

APIDescription
POST v1/PolicySummary

Generate a Policy Summary for the given list of policy IDs

PolicyTransformationStation

Allows to get all products/products that are assigned to the carrier assigned to the policy, get setup indicator, sync all active users, sumbit the real time inquiry

APIDescription
GET v1/Policies/TransformationStation/AllProducts

Get a list of all products from TransformationStation

GET v1/Policies/TransformationStation/Products?policyID={policyID}

Get products that are assigned to the carrier assigned to the policy

POST v1/Policies/TransformationStation/SubmitProgressiveRTI

Submit the Real Time Inquiry using Progressive

POST v1/Policies/TransformationStation/SubmitRTI

Submit the Real Time Inquiry

GET v1/Policies/TransformationStation/SyncUsers

Sync all active Agency Users with TransformationStation

GET v1/PolicyTransformationStation/GetTransformationStationSetupCompleteIndicator

Get transformation station setup complete indicator

ProducerCommissionRules

Allows to retrieve/add Producer Commissions rules

APIDescription
POST v1/Commissions/ProducerRules/Get

Gets the list of Producer Commissions rules based on the filter

POST v1/Commissions/ProducerRules/Update

Adds or updates a commission rule for the producer

ProfLiabAddlCoverages

Allows to create and retrieve prof liab addl coverages

APIDescription
GET v1/Policies/Details/{policyDetailId}/ProfessionalLiability/AddlCoverages

Retrieves prof liab addl coverages

POST v1/Policies/Details/ProfessionalLiability/AddlCoverages

Creates new prof liab addl coverages

ProfLiabCoverages

Allows to create and retrieve prof liab coverages

APIDescription
GET v1/Policies/Details/{policyDetailId}/ProfessionalLiability/Coverages

Retrieves prof liab coverages

POST v1/Policies/Details/ProfessionalLiability/Coverages

Creates new prof liab coverages

ProfLiabGrossSales

Allows to create and retrieve prof liab gross sales

APIDescription
GET v1/Policies/Details/{policyDetailId}/ProfessionalLiability/GrossSales

Retrieves prof liab gross sales

POST v1/Policies/Details/ProfessionalLiability/GrossSales

Creates new prof liab gross sales

ProfLiabProductsServices

Allows to create and retrieve prof liab product services

APIDescription
GET v1/Policies/Details/{policyDetailId}/ProfessionalLiability/ProductsServices

Retrieves prof liab product services

POST v1/Policies/Details/ProfessionalLiability/ProductsServices

Creates new prof liab product service

QBAccounts

Allows to get a list of accounts from the QuickBooks API

APIDescription
GET v1/QuickBooks/Accounts?addTrustAccount={addTrustAccount}

Get a list of accounts from the QuickBooks API

QBActions

Allows to get the data driven list of QB Actions

APIDescription
GET v1/QuickBooks/Actions/{accountType}

Get the data driven list of QB Actions

QBAuthentication

Allows to get the current status of QuickBooks integration with Catalyst

APIDescription
GET v1/QuickBooks/OAuth/Status

Gets the current status of QuickBooks integration with Catalyst

QBSyncStatus

Allows to retrieve sync status event for QuickBooks

APIDescription
GET v1/QuickBooks/SyncStatus

Retrieves the latest sync status event for QuickBooks

GET v1/QuickBooks/SyncStatus/{id}

Retrieves the latest sync status event for QuickBooks

Allows to get, upsert, remove linked locations and trust accounts for QuickBooks

APIDescription
GET v1/QuickBooks/TrustAccountLinks

Get the list of linked locations and trust accounts for QuickBooks

PUT v1/QuickBooks/TrustAccountLinks

Upserts a list of linked locations and trust accounts for QuickBooks

Quotes

Allows to perform CRUD operations with Quotes

APIDescription
GET v1/Policies/{policyId}/Quotes

Get all of the quotes for the specified policy

POST v1/Policies/{policyId}/Quotes

Upserts a quote for an existing policy.

GET v1/Policies/Quotes/{quoteId}

Get all of the details for a specific quote

DELETE v1/Policies/Quotes/{quoteId}

Removes a quote

Ratings

Allows to send proposal email, create customer letter, save MvrReport, get rating states

APIDescription
GET v1/Rating/{locationId}/AllRatingStates

Get Rating States including which states are being used and which is default

POST v1/Rating/AutoSave

Performs autosave operation

POST v1/Rating/GetQuoteCustomerLetter

Create Customer Letter from Rating Breakdown

POST v1/Rating/SaveMvrReport

Save the MvrReport

POST v1/Rating/SendProposalEmail

Send proposal email

ReceiptNumbers

Allows to retrieve/update receipt number settings

APIDescription
GET v1/Locations/{locationID}/Finance/ReceiptNumbers

Get the Receipt number settings

POST v1/Locations/{locationID}/Finance/ReceiptNumbers

Update the Receipt Number Settings

Allows to perform search operations with different parameters

APIDescription
POST v1/Search

Perform an Advanced Search

GET v1/Search/Businesses/BasicSearch?keyword={keyword}&type={type}&locationID={locationID}&pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}

Perform a basic search against the Business contact types

GET v1/Search/Customers/BasicSearch?keyword={keyword}&type={type}&locationID={locationID}&pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}&status={status}&name={name}&customerNumber={customerNumber}&email={email}&phone={phone}&zipCode={zipCode}

Perform a basic Search against the customer contact types

GET v1/Search/Employees/BasicSearch?keyword={keyword}&locationID={locationID}&pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}&status={status}&name={name}&email={email}&phone={phone}&zipCode={zipCode}

Perform a basic search against the employee contact type

GET v1/Search/LastAccessed

Get a list of last accessed Contacts for the user

POST v1/Search/Policies

An Advanced search against policies

POST v1/Search/PoliciesWithDates

An advanced version of search that allows searching by effective and exipration date ranges

GET v1/Search/PolicyQuoteList/{customerId}?polWithoutQuotes={polWithoutQuotes}&voidedPolicyIdToInclude={voidedPolicyIdToInclude}

Returns the basic information needed when issuing a policy

GET v1/Search/Prospects/BasicSearch?keyword={keyword}&type={type}&locationID={locationID}&pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}&status={status}&name={name}&prospectNumber={prospectNumber}&email={email}&phone={phone}&zipCode={zipCode}

Perform a basic search against the prospect contact type

GET v1/Search/ReconcilableCommEntities

Returns a list of entities that are reconcilable for commission

GET v1/Search?searchString={searchString}&locationID={locationID}

Perform a basic search

Signatures

Allows to perform CRUD operations for signatures

APIDescription
GET v1/Locations/{locationID}/Policies/Signatures

Get a list of signatures

POST v1/Locations/{locationID}/Policies/Signatures

Insert a signature

DELETE v1/Locations/{locationID}/Policies/Signatures/signatureBlobID?blobInfoID={blobInfoID}

Delete a signature

PUT v1/Locations/{locationID}/Policies/Signatures/signatureBlobID?signatureBlobID={signatureBlobID}

Update a signature

SocialMedia

Allows to retrieve websites in social media sections

APIDescription
GET v1/Contacts/{contactId}/SocialMedia

Get the list of websites in social media sections

Statistics

Allows to get the number of statistics records

APIDescription
POST v1/Statistics/CountByCategory

Gets the number of records for each main entity type

Sublines

Allows to perform CRUD operations for sublines

APIDescription
POST v1/Sublines

Insert or Update a Subline

GET v1/Sublines/{id}

Get a single Subline

DELETE v1/Sublines/{id}

Delete a subline

GET v1/Sublines?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&sortDirection={sortDirection}

Get all not deleted Sublines

Tasks

Allows to retrieve/create/update tasks

APIDescription
GET v1/Contacts/{contactID}/Tasks?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}

Gets the tasks associated to a contact

GET v1/Employees/{employeeID}/Tasks?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}

Gets the tasks assigned to an employee

POST v1/Tasks

Insert a task

POST v1/Tasks/{taskId}/MarkComplete

Updates task to completed status

POST v1/Tasks/UpdateProgress

Updates task to specified percent complete.

TextMessages

Handles work with text messages

APIDescription
GET v1/Contacts/{contactID}/TextMessages?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&sortDirection={sortDirection}

Get the list of text messages for a contact ID

TransactionConcepts

Allows to retrieve transaction concepts

APIDescription
GET v1/TransactionConcepts

Get the list of Financial Transaction Concepts

TransformationStation

Allows to retrieve products from the IVANS TransformationStation Server, check if an agency is configured to use the server

APIDescription
GET v1/Preferences/TransformationStation/AllProducts

Get a list of all products from the IVANS TransformationStation Server

GET v1/Preferences/TransformationStation/IsSetup

Check to see if Agency is configured to use IVANS TransformationStation Server

TwilioSettings

Allows to retrieve text message signature

APIDescription
GET v1/Locations/{locationID}/TwilioSettings/TextSignature?customerID={customerID}

Get the text message signature.

UserInformation

Allows to retrieve employee's user information

APIDescription
GET v1/Employees/{id}/UserInfo

Get the Employee's User Information

UserPreferences

Allows to retrieve/update employee's user preferences

APIDescription
GET v1/Employees/{id}/UserPreferences

Get employee's user preferences

POST v1/Employees/{id}/UserPreferences

update the employees user preferences

UserSettings

Allows to retrieve/update user settings

APIDescription
GET v1/Locations/{locationID}/UserSettings

Get the user settings

POST v1/Locations/{locationID}/UserSettings

Update the User settings

Websites

Allows to retrieve/update websites for a contact

APIDescription
GET v1/Contacts/{contactID}/Websites

Get the websites for a contact

POST v1/Contacts/{contactID}/Websites

Update the websites for a contact.