Querying for notes
Use the following endpoints to query for notes:
| Endpoint | Returns |
|---|---|
/common/v1/notes/{noteId} |
The note with the given ID (see below) |
/billing/v1/accounts/{accountId}/notes |
All notes associated with the given account |
/billing/v1/accounts/{accountId}/policies/{policyId}/notes |
All notes associated with the given policy |
/common/v1/activities/{activityId}/notes |
All notes associated with the given activity |
By default, the GET /notes/{noteId} endpoint returns the
body field, but the GET /notes endpoints do not. This is
because of the potentially large size of the body field. To prevent overly
large payloads, Guidewire recommends that you retrieve the body field only if
the body is needed. The body can be retrieved using the ?fields=body query
parameter.
The /common/v1/notes/{noteId} endpoint can be used to retrieve
any note in BillingCenter. This includes notes that are attached
to a parent object other than an account.