A Fund is a way of tracking the intent of Donation.
All Organizations have a default Fund (usually named “General”), and creating additional Funds allows donors to allocate their gift to a particular cause/effort.
You can query for the default Fund using the default param:
GET https://api.planningcenteronline.com/giving/v2/funds?where[default]=true| Property | Value |
|---|---|
| Product | Giving (pco.giving, API version 2019-10-18) |
| Resource type | Fund |
| TypeScript | Giving.Fund, attributes Giving.FundAttributes, schema Giving.FundSchema |
| Planning Center path | /giving/v2/funds |
| Planning Center docs | Fund |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.giving.funds |
Collection | Yes | |
pco.giving.donations.id(donationId).designations.id(designationId).fund |
Collection | No | |
pco.giving.in_kind_donations.id(inKindDonationId).fund |
Collection | No | |
pco.giving.pledge_campaigns.id(pledgeCampaignId).fund |
Collection | No | |
pco.giving.recurring_donations.id(recurringDonationId).designations.id(recurringDonationDesignationId).fund |
Collection | No |
From a collection, .id(fundId) addresses one Fund: pco.giving.funds.id(fundId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Giving.FundAttributes. Every resource also has id and type ('Fund') next to its attributes.
| Name | Type | Description |
|---|---|---|
color |
string | null |
The hex color code that is used to help differentiate the fund from others in Giving, as determined by color_identifier. |
created_at |
string | null |
The date and time at which a fund was created. Example: 2000-01-01T12:00:00Z |
default |
boolean | null |
This attribute is set to true if a fund is the associated organization’s default fund, or false if it isn’t. More information on default funds can be found in our product documentation: https://help.planningcenter.com/en/138385-create-and-manage-funds.html |
deletable |
boolean | null |
Boolean that tells if you if the fund can be deleted or not. Read more in our product documentation: https://help.planningcenter.com/en/138385-create-and-manage-funds.html |
description |
string | null |
A short description that describes how the money given to the fund will be used. 255 characters maximum. |
ledger_code |
string | null |
If an organization’s general ledger software tracks funds by code, this attribute can be used to store the fund’s code for reference. |
name |
string | null |
Required. The name for a fund. Must be unique within the associated organization. |
slug |
string | null |
A URL-friendly identifier for a fund, derived from the fund name. |
updated_at |
string | null |
The date and time at which a fund was last updated. Example: 2000-01-01T12:00:00Z |
visibility |
string | null |
See details. |
Attribute details
visibility
Required. Controls how a fund is visible on Church Center. everywhere will allow anyone to donate to the fund on Church Center. admin_only will hide the fund on Church Center, allowing only permitted Giving Users to designate donations to it. nowhere will prevent donations from being designated to the fund altogether, while still displaying fund data in historical reports. hidden will hide the fund from the list of funds in the default Church Center donation form, but allow donors to give to it via direct link, or through Text-to-Give.
Possible values: everywhere, admin_only, nowhere, or hidden
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
default |
boolean |
Equality only |
id |
string |
Equality only |
name |
string |
Equality only |
visibility |
string |
Equality only |
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on pco.giving.funds |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as Giving.FundSchema['create'].
| Attribute | Type |
|---|---|
color_identifier |
unknown |
description |
string | null |
ledger_code |
string | null |
name |
string | null |
visibility |
string | null |
Update attributes
Typed as Giving.FundSchema['update'].
| Attribute | Type |
|---|---|
color_identifier |
unknown |
description |
string | null |
ledger_code |
string | null |
name |
string | null |
visibility |
string | null |
See Writing data.
Example
import type { Giving } from '@mackenly/planningcenterkit';
const page = await pco.giving.funds.perPage(25).list();
const items: Giving.Fund[] = page.data;