Skip to content

Giving reference

Planning Center Giving in Planning Center Kit: Donations, funds, batches, pledges, payment sources, and recurring donations.

Donations, funds, batches, pledges, payment sources, and recurring donations.

Property Value
Client property pco.giving
Subpath import import { createGivingClient } from '@mackenly/planningcenterkit/giving'
Types namespace Giving
Base path /giving/v2
Pinned API version 2019-10-18
Resource types 20
Planning Center docs Planning Center Giving API

Each product client sends X-PCO-API-Version: 2019-10-18, the version these types were generated from. Override it with new PlanningCenter({ auth, versions: { giving: '...' } }); the types won’t follow. See Products.

import { createGivingClient } from '@mackenly/planningcenterkit/giving';

const giving = createGivingClient({ auth: { applicationId: process.env.PCO_APP_ID!, secret: process.env.PCO_SECRET! } });
const { data: root } = await giving.get(); // /giving/v2

Root collections

Properties on pco.giving, named after their URL. pco.giving.get() fetches the product root (/giving/v2), and pco.giving.edge(name) follows any root edge by name.

Client path Resource Returns Filters Create
pco.giving.batch_groups BatchGroup Collection committed, in_progress Yes
pco.giving.batches Batch Collection committed, in_progress Yes
pco.giving.campuses Campus Collection No
pco.giving.donations Donation Collection succeeded No
pco.giving.donor_summaries DonorSummary Collection has_joint_giver No
pco.giving.funds Fund Collection Yes
pco.giving.in_kind_donations InKindDonation Collection Yes
pco.giving.labels Label Collection Yes
pco.giving.payment_sources PaymentSource Collection Yes
pco.giving.people Person Collection has_donated No
pco.giving.pledge_campaigns PledgeCampaign Collection Yes
pco.giving.recurring_donations RecurringDonation Collection No

Resources

Resource TypeScript Description
Batch Giving.Batch A Batch is a collection of Donations.
BatchGroup Giving.BatchGroup A BatchGroup is a collection of Batches.
Campus Giving.Campus A Campus that has been added to your Organization.
Designation Giving.Designation A Designation conveys how much of a Donation goes to a particular Fund.
DesignationRefund Giving.DesignationRefund A record that links a Refund with a Designation
Donation Giving.Donation A Donation record corresponds to a gift given to an Organization at a particular point in time.
DonorSummary Giving.DonorSummary A donor and their aggregate giving to an Organization (name, donor number, total received, donation count, and first gift date), summed over a requested date range, defaulting to the last 30 days.
Fund Giving.Fund A Fund is a way of tracking the intent of Donation.
InKindDonation Giving.InKindDonation An InKindDonation record represents a non-cash gift given to an Organization at a specific time.
Label Giving.Label A Label is a way for Admins to manage and categorize Donations.
Note Giving.Note A Note is a way for Giving Admins and Bookkeepers to communicate internally about a donation.
Organization Giving.Organization The root level Organization record which serves as a link to Donations, People, Funds, etc.
PaymentMethod Giving.PaymentMethod Stored PaymentMethod information (card or bankaccount) used by donors to make online Donations.
PaymentSource Giving.PaymentSource A donation’s PaymentSource refers to the platform it originated from.
Person Giving.Person A Planning Center Person record that has been added to Giving.
Pledge Giving.Pledge A Pledge made by a Person toward a particular PledgeCampaign.
PledgeCampaign Giving.PledgeCampaign A PledgeCampaign is a way to request and track long-terms commitments to a particular goal or project.
RecurringDonation Giving.RecurringDonation A RecurringDonation is represents a Donation that repeats on a set schedule (weekly, monthly, etc.) Data for RecurringDonations is read-only; they can not be created or edited through the API.
RecurringDonationDesignation Giving.RecurringDonationDesignation Much like a Designation, A RecurringDonationDesignation conveys how much of a RecurringDonation goes to a particular Fund.
Refund Giving.Refund A Refund record holds information pertaining to a refunded Donation.

Type to search…

↑↓ navigate↵ selectEsc close