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.
| Property | Value |
|---|---|
| Product | Giving (pco.giving, API version 2019-10-18) |
| Resource type | Note |
| TypeScript | Giving.Note, attributes Giving.NoteAttributes, schema Giving.NoteSchema |
| Planning Center path | /giving/v2/donations/{donation_id}/note |
| Planning Center docs | Note |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.giving.donations.id(donationId).note |
Single resource | Yes |
Collections support where, include, order, and pagination; single resources have get().
Attributes
On Giving.NoteAttributes. Every resource also has id and type ('Note') next to its attributes.
| Name | Type | Description |
|---|---|---|
body |
string | null |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on note on Donation |
| Update | No |
| Delete | No |
Create attributes
Typed as Giving.NoteSchema['create'].
| Attribute | Type |
|---|---|
body |
string | null |
See Writing data.
Example
import type { Giving } from '@mackenly/planningcenterkit';
function describe(resource: Giving.Note): string {
return `${resource.type} ${resource.id}`;
}