Note
A Note is a way for Giving Admins and Bookkeepers to communicate internally about a donation.
Notes are only visible in the Giving admin interface, not shown to donors. Each Donation can only
have a single note associated with it.
To record notes from donors, consider using the Memo Line feature instead.
Example Request
curl https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/note
Example Object
{
"type": "Note",
"id": "1",
"attributes": {
"body": "string"
},
"relationships": {}
}
Attributes
| Name | Type | Description |
|---|---|---|
body |
string |
|
id |
primary_key |
Pagination
| Name | Parameter | Type | Description |
|---|---|---|---|
| per_page | per_page | integer | how many records to return per page (min=1, max=100, default=25) |
| offset | offset | integer | get results from given offset |
Endpoints
Listing
| HTTP Method | Endpoint |
|---|---|
| GET | /giving/v2/donations/{donation_id}/note |
Reading
| HTTP Method | Endpoint |
|---|---|
| GET | /giving/v2/donations/{donation_id}/note/{id} |
Creating
| HTTP Method | Endpoint | Assignable Attributes |
|---|---|---|
| POST | /giving/v2/donations/{donation_id}/note |
|
Notes:
Each donation can only have one note associated with it. If you send another POST request for a donation that already has a note, the existing note will be overwritten.
JSON payload for adding a note:
json
{
"data": {
"type": "Note",
"attributes": { "body": "This is an internal, admin-only note about this donation" }
}
}
Belongs To
| HTTP Method | Endpoint | Association | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/note |
Donation |