Policy notes

Use the following endpoint to retrieve all of the notes associated with a policy:

  • GET /billing/v1/accounts/{accountId}/policies/{policyId}/notes

For example, the following request retrieves policy notes for policy bc:127732, which is owned by account bc:606.

Command

GET /billing/v1/accounts/bc:606/policies/bc:127732/notes
Response
{
    "count": 2,
    "data": [
        {
            "attributes": {
                "author": {
                    "displayName": "Aaron Applegate",
                    "id": "default_data:1",
                    "type": "User",
                    "uri": "/admin/v1/users/default_data:1"
                },
                "bodySummary": "Underwriting forgot to apply a multi-policy discount. Customer is waiting for this to be corrected a...",
                "confidential": false,
                "createdDate": "2024-01-09T21:26:32.731Z",
                "id": "bc:S2AkggI3W-g6xGvcwmEVy",
                "language": {
                    "code": "en_US",
                    "name": "English (US)"
                },
                "securityType": {
                    "code": "unrestricted",
                    "name": "Unrestricted"
                },
                "subject": "Discount not applied",
                "topic": {
                    "code": "general",
                    "name": "General"
                },
                "updateTime": "2024-01-09T21:27:29.148Z"
            },
            ...
        },
        {
            "attributes": {
                "author": {
                    "displayName": "Aaron Applegate",
                    "id": "default_data:1",
                    "type": "User",
                    "uri": "/admin/v1/users/default_data:1"
                },
                "bodySummary": "Customer believes they are being overcharged for the policy. Underwriting is confirming premium was ...",
                "confidential": false,
                "createdDate": "2024-01-08T21:25:00.302Z",
                "id": "bc:St6t0Eqg3V_rikhZiQKs7",
                "language": {
                    "code": "en_US",
                    "name": "English (US)"
                },
                "securityType": {
                    "code": "unrestricted",
                    "name": "Unrestricted"
                },
                "subject": "Billing amount is in error",
                "topic": {
                    "code": "dispute",
                    "name": "Dispute"
                },
                "updateTime": "2024-01-08T21:26:27.139Z"
            },
            ...
        }
    ],
    ...

Use the following endpoint to create a new note associated with a policy:

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

The following fields are required for a note:

  • body - a String value
  • language - a typecode from the LanguageType typelist (such as "en_US")
  • subject - String value

For example, the following request create a new policy notes for policy bc:127732, which is owned by account bc:606.

Command

GET /billing/v1/accounts/bc:606/policies/bc:127732/notes
Response
{
  "data": {
    "attributes": {
        "body": "Customer has the new invoice and reports everything looks good.",
        "language": {
            "code": "en_US"
        },
        "subject": "Issue resolved"
    }
  }
}