A Label is a way for Admins to manage and categorize Donations.
Multiple Labels can be added for each Donation, and these will only be displayed in the Giving admin interface, so donors never see them.
| Property | Value |
|---|---|
| Product | Giving (pco.giving, API version 2019-10-18) |
| Resource type | Label |
| TypeScript | Giving.Label, attributes Giving.LabelAttributes, schema Giving.LabelSchema |
| Planning Center path | /giving/v2/labels |
| Planning Center docs | Label |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.giving.labels |
Collection | Yes | |
pco.giving.donations.id(donationId).labels |
Collection | No |
From a collection, .id(labelId) addresses one Label: pco.giving.labels.id(labelId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Giving.LabelAttributes. Every resource also has id and type ('Label') next to its attributes.
| Name | Type | Description |
|---|---|---|
slug |
string | null |
The label text itself. Made up solely of lowercase letters, numbers, and dashes. When creating or updating a label, the string you provide will be formatted automatically. For example: My awesome label! will be saved as my-awesome-label |
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
slug |
string |
Equality only |
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on pco.giving.labels |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as Giving.LabelSchema['create'].
| Attribute | Type |
|---|---|
slug |
string | null |
Update attributes
Typed as Giving.LabelSchema['update'].
| Attribute | Type |
|---|---|
slug |
string | null |
See Writing data.
Example
import type { Giving } from '@mackenly/planningcenterkit';
const page = await pco.giving.labels.perPage(25).list();
const items: Giving.Label[] = page.data;