AcordDescription

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

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

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

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

Get the default address information

AgencyCommissionRules

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

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

Get a list of Agency Fees

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

Upsert and agency fee

CampaignTemplateEditor

CampaignTemplateEditorController

APIDescription
POST v1/CampaignTemplateEditor/TemplateData

Save template data

CancellationReasons

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

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

APIDescription
GET v1/Carriers

Get a list of all carriers for a user.

CommercialAutoVehicles

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

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 a Additional Interests Item on the Policy Details

CommInlandMarineBasicInfo

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

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

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

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

Get the General Info Section data for Inland Marine type policiesS

POST v1/Policies/Details/InlandMarine/GeneralInfo

Upsert the General Info Section data for Inland Marine type policies

CommInlandMarineScheduleEquipment

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

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

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

delete a commission rule

ContactInformation

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

No documentation available.

Contacts

APIDescription
PUT v1/Contacts

Insert a contact into Catalyst with a simple contract

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

APIDescription
GET v1/Contacts/{contactID}/AccountInfo

Get the account information for a contact including Agent and CSR

ContactsAddresses

APIDescription
GET v1/Contacts/{contactID}/Addresses

Return a list of address for a contact.

ContactsEmails

APIDescription
GET v1/Contacts/{contactID}/Emails

Get the Emails for a contact

POST v1/Contacts/{contactID}/Emails

Update the Emails for a contact. This input list will replace the existing collection of Emails.

ContactsXDates

APIDescription
GET v1/Contacts/{contactID}/XDates

Return a list of xDates for a contact.

POST v1/XDates

GET v1/XDates/{id}

POST v1/XDates/{id}/AutoAdvance

CustomerEmployer

APIDescription
GET v1/Customers/{customerID}/Employers

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

CustomerNumbers

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

Update the location's customer number settings

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

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

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

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

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

APIDescription
GET v1/Employees/LoginStatus

Get the current logged in user's login status.

EmployeeShifts

APIDescription
GET v1/Employees/{id}/EmployeeShifts

Get the employee's shifts

EndorsementReasons

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

APIDescription
POST v1/Policies/Endorsements/UpdateApproved

No documentation available.

FileFolders

Methods to maintain File Folders

APIDescription
GET v1/FileFolders?entityId={entityId}

Get Folders by entity id

FileProperties

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, alternatively you can request the byte[] of the file with 'downloadAs': None, Thumbnail, Original

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. This requires a web header 'QQ-Upload-ContactID' you can also provide the header 'QQ-Upload-Filename'

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

Get a list of files associated to a Contact ID, alternatively you can request the byte[] of the file with 'downloadAs': None, Thumbnail, Original

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

Get a list of files associated to a Policy ID, alternatively you can request the byte[] of the file with 'downloadAs': None, Thumbnail, Original

GarageCoverages

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

POST v1/Policies/Details/Garage/Coverages

GarageOperations

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

POST v1/Policies/Details/Garage/Operations

HomeownersLocations

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

Get a list of locations on a Homeowners Policy Details

Industries

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

InvoiceNumbers

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

Get the Invoice number settings

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

Update the Invoice Number Settings

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

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, use the system coverage ID from the GetSystemCoveragesFoLine method and the OfficeLOBVM.ID from GetLinesOfBusinessVM

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

Assign a Line of Business to a Location, use the System Line of Business ID from the SystemLinesOfBusiness method

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

Get the available coverages that can be added to a Line Of Business, use the system line of business ID from the SystemLinesOfBusiness method

GET v1/Locations/Policies/SystemLines

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

LinkedAccount

APIDescription
GET v1/Customers/{customerID}/LinkedAccounts

Get Linked Accounts

Locations

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

A list of contact sub types

GET v1/Lookups/ContactTypes

A list of Contact Types

GET v1/Lookups/ContactTypesAndSubTypes

A list of Contact Types with their child sub types

GET v1/Lookups/Countries

Returns a list of Countries

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

This returns the states/provinces for the specified country

GET v1/Lookups/DownloadAsFileTypes

A list of download file types

GET v1/Lookups/FileRelations

"A list of file relations"

POST v1/Lookups/QQSolutionsStatus

Get The System Status for all of QQSolutions

GET v1/Lookups/States

This returns the states for The United States of America

GET v1/Lookups/States/{stateCode}

returns a specific state

NamedInsured

APIDescription
GET v1/Policies/{policyId}/NamedInsured

Gets the named insured for the specified policy

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

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

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

Get the payment information

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

Update the Payment information

PaymentPayableAddress

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

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

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

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

PersonalAutoPhysicalDamageCoverages

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

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

PersonalAutoVehicles

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

Get a list of vehicles on a Personal Auto Policy Details

PersonalInformation

APIDescription
GET v1/Customers/{customerID}/PersonalInformation

Get Personal Information section for a customer

PersonalInlandMarineAdditionalInterests

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 a Additional Interests Item on the Policy Details

PersonalInlandMarineCoverageInfo

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

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

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

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

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. This input list will replace the existing collection of phone numbers.

Policies

APIDescription
PUT v1/Policies

Insert a 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

APIDescription
GET v1/Policies/{policyID}/PolicyInfo

Provide a new method to get the Basic Policy Info including Agent and CSR

PolicyACORDForms

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

APIDescription
GET v1/Policies/AcordFormTemplate/{acordFormTemplateId}

Get an acord form template descriptions by acord form template id

PolicyCarriers

APIDescription
GET v1/PolicyCarriers?carrierID={carrierID}

Get the Policy Carrier Display Information by Carrier ID

PolicyCommissions

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 the list

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

Get by ID

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

No documentation available.

PolicyDetailsFarmAnimals

Animals Controller for farm policies

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

Get the list

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

Get by ID

PolicyDetailsFarmPersonalProperties

Personal Properties Controller for farm policies

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

Get the list

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

Get by ID

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

Get by ID

PolicyDetailsFarmPremises

Premises Controller for farm policies

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

Get the list

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

Get by ID

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

Get by ID

PolicyDetailsFarmScheduledProperties

Scheduled Properties Controller for farm policies

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

Get the list

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

Get by ID

PolicyDetailsFarmUnscheduledProperties

Unscheduled Properties Controller for farm policies

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

Get the list

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

Get by ID

GET v1/Policies/Details/FarmUnscheduledProperties/Classes

No documentation available.

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

No documentation available.

PolicyDetailsGaragePremises

Premises Controller for farm policies

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

Get the list

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

Get by ID

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

Get by ID

PolicyDetailsGeneralLocations

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

Get a list of locations for a policy

PolicyDownPayment

APIDescription
GET v1/Policies/{policyId}/DownPayment

Returns the down payment information for a policy

PolicyLines

APIDescription
GET v1/Policies/{policyID}/PolicyLines

Get the policy line summaries for lines under a Policy ID

PolicyNotes

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

Get notes for a Policy ID

PolicyProposal

APIDescription
POST v1/PolicyProposal

Generate a policy proposal for the given list of quote IDs

PolicySources

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

APIDescription
POST v1/PolicySummary

Generate a Policy Summary for the given list of policy IDs

PolicyTransformationStation

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

Sumbit the Real Time Inquiry using Progressive

POST v1/Policies/TransformationStation/SubmitRTI

Sumbit the Real Time Inquiry

GET v1/Policies/TransformationStation/SyncUsers

Sync all active Agency Users with TransformationStation

GET v1/PolicyTransformationStation/GetTransformationStationSetupCompleteIndicator

No documentation available.

ProducerCommissionRules

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

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

POST v1/Policies/Details/ProfessionalLiability/AddlCoverages

ProfLiabCoverages

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

POST v1/Policies/Details/ProfessionalLiability/Coverages

ProfLiabGrossSales

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

POST v1/Policies/Details/ProfessionalLiability/GrossSales

ProfLiabProductsServices

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

POST v1/Policies/Details/ProfessionalLiability/ProductsServices

QBAccounts

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

Get a list of accounts from the QuickBooks API

QBActions

APIDescription
GET v1/QuickBooks/Actions/{accountType}

Get the data driven list of QB Actions. Account Types: {Payable, Receivable}

QBAuthentication

APIDescription
GET v1/QuickBooks/OAuth/Status

Gets the current status of QuickBooks integration with Catalyst.

QBSyncStatus

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

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

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

APIDescription
GET v1/Rating/{locationId}/AllRatingStates

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

POST v1/Rating/AutoSave

No documentation available.

POST v1/Rating/GetQuoteCustomerLetter

Create Customer Letter from Rating Breakdown

POST v1/Rating/SaveMvrReport

Save the MvrReport

POST v1/Rating/SendProposalEmail

SendPropposalEmail

ReceiptNumbers

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

Get the Receipt number settings

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

Update the Receipt Number Settings

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 lsit 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

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

APIDescription
GET v1/Contacts/{contactId}/SocialMedia

Get the list of websites in social media sections

Statistics

APIDescription
POST v1/Statistics/CountByCategory

Gets the number of records for each main entity type

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

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. TaskDTO properties ID, Complete (percentage), Status and ReminderDate(Optional) should be filled. Status: Not Started, Waiting, In Progress, Deferred, Completed

TextMessages

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

APIDescription
GET v1/TransactionConcepts

Get the list of Financial Transaction Concepts

TransformationStation

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

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

Get the text message signature.

UserInformation

APIDescription
GET v1/Employees/{id}/UserInfo

Get the Employee's User Information

UserPreferences

APIDescription
GET v1/Employees/{id}/UserPreferences

Get employee's user preferences

POST v1/Employees/{id}/UserPreferences

update the employees user preferences

UserSettings

APIDescription
GET v1/Locations/{locationID}/UserSettings

Get the user settings

POST v1/Locations/{locationID}/UserSettings

Update the User settings

Websites

APIDescription
GET v1/Contacts/{contactID}/Websites

Get the websites for a contact

POST v1/Contacts/{contactID}/Websites

Update the websites for a contact. This input list will replace the existing collection of websites.