Skip to content

DonorSummary (Giving)

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.

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.

Property Value
Product Giving (pco.giving, API version 2019-10-18)
Resource type DonorSummary
TypeScript Giving.DonorSummary, attributes Giving.DonorSummaryAttributes, schema Giving.DonorSummarySchema
Planning Center path /giving/v2/donor_summaries
Planning Center docs DonorSummary

How to reach it

Client path Returns Filters Create
pco.giving.donor_summaries Collection has_joint_giver No

From a collection, .id(donorSummaryId) addresses one DonorSummary: pco.giving.donor_summaries.id(donorSummaryId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Giving.DonorSummaryAttributes. Every resource also has id and type ('DonorSummary') next to its attributes.

Name Type Description
donation_count number | null The number of donations this donor made over the requested date range, including refunded and failed donations.
donor_number string | null The donor number for the person, if donor numbers are visible for this organization.
first_donated string | null Timestamp of the donor’s first donation ever (lifetime, not scoped to the requested date range).
name string | null The donor’s full name.
total_received_donation_amount_cents number | null The total received donation amount (in the currency’s smallest unit) for this donor over the requested date range.
total_received_donation_amount_currency string | null The ISO currency code for the total (the organization’s currency).

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): joint_giver.

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
campus_id string Equality only
person_id string Equality only
received_at string | Date gt, gte, lt, lte

Order

order(...) accepts these fields, ascending, or descending with a - prefix: donation_count, first_donated, name, total_received_donation_amount_cents.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
pco.giving.donor_summaries has_joint_giver

Edges

Follow these from one DonorSummary, ref = pco.giving.donor_summaries.id(donorSummaryId):

Edge Leads to Returns Filters Create
ref.joint_giver Person Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

import type { Giving } from '@mackenly/planningcenterkit';

const page = await pco.giving.donor_summaries.order('donation_count').perPage(25).list();
const items: Giving.DonorSummary[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close