Creating account and policy notes

Notes must be created from an existing account, policy, or activity using the following endpoints:

  • POST /billing/v1/accounts/{accountId}/notes
  • POST /billing/v1/accounts/{accountId}/policies/{policyId}/notes
  • POST /common/v1/activities/{activityId}/notes

Be aware that BillingCenter supports notes attached to other objects as well, such as producers. However, as of the current release, Cloud API does not yet support the ability to create notes for parent objects beyond accounts and activities.

To create a note, you must specify the following fields:

Field Datatype Description
body string The note’s body
language Typekey (a value from the LanguageType typelist) The note's language
subject string The note's subject
Field Datatype Description
body string The note’s body
language Typekey (a value from the LanguageType typelist) The note's language
subject string The note's subject

You can optionally specify these fields:

Field Datatype Description Default
confidential Boolean Whether the note is confidential false
relatedTo Typekey (a value from the RelatedTo typelist) The business aspect the note is related to, such as Invoices or Delinquencies NULL
securityType Typekey (a value from the NoteSecurityType typelist) Whether the note is confidential NULL
topic Typekey (a value from the NoteTopicType typelist) The note's topic type general
Field Datatype Description Default
confidential Boolean Whether the note is confidential false
relatedTo Typekey (a value from the RelatedTo typelist) The business aspect the note is related to, such as Invoices or Delinquencies NULL
securityType Typekey (a value from the NoteSecurityType typelist) Whether the note is confidential NULL
topic Typekey (a value from the NoteTopicType typelist) The note's topic type general

Minimal notes

The following is an example of creating a note for account bc:10.

Command

POST /account/v1/accounts/bc:10/notes
Java

Request body

{
  "data": {
    "attributes": {
        "body": "The insured's last name, Cahill, is pronounced 'KAH-hill', not 'KAY-hill'.",
        "language": {
            "code": "en_US"
        },
        "subject": "Pronunciation note"
    }
  }
}
Java

Notes with additional details

The following is an example of creating a detailed note for policy bc:18 on account bc:10.

Command

POST /account/v1/accounts/bc:10/policies/bc:18/notes
Java

Request body

{
  "data": {
    "attributes": {
        "body": "One-time invoicedue date extension granted due to payment system error" ,
        "language": {
            "code": "en_US"
        },
        "subject": "Invoice extension",
        "confidential": false,
        "relatedTo": {
          "code": "account"
        },
        "securityType": {
          "code": "unrestricted"
        },
        "topic": {
          "code": "general"
        }
    }
  }
}
Java

Notes for an activity

The following is an example of creating a note for activity xc:22.

Command

POST /common/v1/activities/xc:22/notes
Java

Request body

{
  "data": {
    "attributes": {
        "body": "This activity was completed during a telephone call with the insured on 11/17." 
        "language": {
            "code": "en_US"
        },
        "subject": "Note on activity completion"
    }
  }
}
Java