Fund

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

Example Request

curl https://api.planningcenteronline.com/giving/v2/funds

View in API Explorer →

Example Object

{
  "type": "Fund",
  "id": "1",
  "attributes": {
    "color": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "default": true,
    "deletable": true,
    "description": "string",
    "ledger_code": "string",
    "name": "string",
    "slug": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "visibility": "value"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`color`	`string`	The hex color code that is used to help differentiate the fund from others in Giving, as determined by `color_identifier`.
`created_at`	`date_time`	The date and time at which a fund was created. Example: `2000-01-01T12:00:00Z`
`default`	`boolean`	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://pcogiving.zendesk.com/hc/en-us/articles/205197070-Funds
`deletable`	`boolean`	Boolean that tells if you if the fund can be deleted or not. Read more in our product documentation: https://pcogiving.zendesk.com/hc/en-us/articles/205197070-Managing-Funds#DeleteaFund
`description`	`string`	A short description that describes how the money given to the fund will be used. 255 characters maximum.
`id`	`primary_key`	The unique identifier for a fund.
`ledger_code`	`string`	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`	Required. The name for a fund. Must be unique within the associated organization.
`slug`	`string`	A URL-friendly identifier for a fund, derived from the fund name.
`updated_at`	`date_time`	The date and time at which a fund was last updated. Example: `2000-01-01T12:00:00Z`
`visibility`	`string`	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`

Query By

Name	Parameter	Type	Description	Example
default	`where[default]`	boolean	Query on a specific default	`?where[default]=true`
id	`where[id]`	primary_key	Query on a specific id	`?where[id]=primary_key`
name	`where[name]`	string	Query on a specific name	`?where[name]=string`
visibility	`where[visibility]`	string	Query on a specific visibility Possible values: `everywhere`, `admin_only`, `nowhere`, or `hidden`	`?where[visibility]=value`

Pagination

Name	Parameter	Type	Description
per_page	per_page	integer	how many records to return per page (min=1, max=100, default=25)
offset	offset	integer	get results from given offset

Endpoints

Listing

HTTP Method	Endpoint
GET	`/giving/v2/funds`

Reading

HTTP Method	Endpoint
GET	`/giving/v2/funds/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/giving/v2/funds`	name ledger_code description visibility

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/giving/v2/funds/{id}`	name ledger_code description visibility

Deleting

HTTP Method	Endpoint
DELETE	`/giving/v2/funds/{id}`

Belongs To

HTTP Method	Endpoint	Association
GET	`https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/designations/{designation_id}/fund`	Designation
GET	`https://api.planningcenteronline.com/giving/v2/in_kind_donations/{in_kind_donation_id}/fund`	InKindDonation
GET	`https://api.planningcenteronline.com/giving/v2/funds`	Organization
GET	`https://api.planningcenteronline.com/giving/v2/people/{person_id}/pledges/{pledge_id}/pledge_campaign/{pledge_campaign_id}/fund`	PledgeCampaign
GET	`https://api.planningcenteronline.com/giving/v2/recurring_donations/{recurring_donation_id}/designations/{recurring_donation_designation_id}/fund`	RecurringDonationDesignation