Notes

A note is a free-form record of the actions or thinking of a user or process. Notes are typically used to capture information that cannot be easily captured in some other way on some other business object. Notes are typically created by users, but they can be created by batch processes or other system behavior within InsuranceSuite. They can also be created by caller applications using Cloud API.

Through Cloud API, a note can be attached to the following objects in the different InsuranceSuite applications:
  • ClaimCenter: A note can be attached to a claim. It can also optionally be attached to an exposure, a ClaimContact, or a service request on that claim. Notes can also be attached to activities.
  • PolicyCenter: A note can be attached to an account, a job, or a policy. Notes can also be attached to activities.
  • BillingCenter: A note can be attached to an account. Notes can also be attached to activities.

For a complete description of the functionality of notes in an InsuranceSuite application, see the documentation for the application itself.

Notes exist in all core InsuranceSuite applications. To ensure that notes behave in a common way across all applications, some note endpoints, such as the endpoint for querying for a note with a given ID, are declared in the Common API. However, because notes can also belong to unique parent objects that don't exist in all InsuranceSuite applications, this means that there are other notes endpoints declared in other API. For example, the endpoint for creating a note for a claim is declared in the Claim API. This topic always identifies the API where each endpoint is declared.

Note: ContactManager for Cloud API includes the Common API and its endpoints for working with notes. However, in the base configuration of the ContactManager application, there is no user interface or business rule support for notes. The notes endpoints have been included in Cloud API for ContactManager primarily for the sake of consistency, and also to support any insurer who wishes to configure ContactManager so that it can work with notes.