Namespace Crews.PlanningCenter.Api.Giving.V2018_08_01

Classes

Batch: Attributes for the Batch resource.

BatchClient: Client for interacting with the Batch resource.

BatchCollectionResponse: Collection Response model for Batch resource.

BatchGroup: Attributes for the BatchGroup resource.

BatchGroupClient: Client for interacting with the BatchGroup resource.

BatchGroupCollectionResponse: Collection Response model for BatchGroup resource.

BatchGroupResource: A BatchGroup is a collection of Batches.

BatchGroups are an optional way of organizing your Batches into groups that share common characteristics. These are completely customizable and can be used in whatever way makes sense to your organization's workflow.

Similarly to Batches, you can commit (see more in the Actions section) a BatchGroup, and by doing so, all Batches and Donations contained in the BatchGroup will also be committed.

BatchGroupResponse: Response model for BatchGroup resource.

BatchRelationships: Relationships for the Batch resource.

BatchResource: A Batch is a collection of Donations. When creating Donation's via the API, you're required to put them in a Batch.

When a Batch is first created, it's in the in_progress or "uncommitted" state. You can freely add/remove/modify Donations in this Batch and they won't show up in a donor's donation history online, they won't appear in any donor statements issued by the Giving admin, and changes to these donations are not flagged in the system log. Think of it as a staging area for donations.

When a Batch is committed (see more in the Actions section), all of the Donations within it are also marked as "committed". At that point, they're visible to donors in their online history, and any further edits made to those Donations are logged and visible to Giving admins.

With all of that in mind, you can use Batches in one of two ways:

1. Create an uncommitted Batch, add Donations to it, then commit the Batch.
2. Create a Batch with a least one donation, commit it, then add more Donations to it.

In both cases, the end result is the same. The main difference is that option #2 does not provide you/other admins the opportunity to fix any mistakes before changes are logged and Donations are made visible to donors. Any Donations added to a committed Batch will automatically be committed as well. Note, batches can't be committed until they have at least one donation.

Whichever route you decide to take, it's helpful to make use of the Batch's description to help differentiate these groupings from each other and from other Batches that the Giving admins might be creating on their own.

BatchResponse: Response model for Batch resource.

Campus: Attributes for the Campus resource.

CampusClient: Client for interacting with the Campus resource.

CampusCollectionResponse: Collection Response model for Campus resource.

CampusResource: A Campus that has been added to your Organization.

Campuses can be especially useful in filtering Donations across the various locations of your Organization.

CampusResponse: Response model for Campus resource.

Designation: Attributes for the Designation resource.

DesignationClient: Client for interacting with the Designation resource.

DesignationCollectionResponse: Collection Response model for Designation resource.

DesignationRefund: Attributes for the DesignationRefund resource.

DesignationRefundClient: Client for interacting with the DesignationRefund resource.

DesignationRefundCollectionResponse: Collection Response model for DesignationRefund resource.

DesignationRefundRelationships: Relationships for the DesignationRefund resource.

DesignationRefundResource: A record that links a Refund with a Designation

DesignationRefundResponse: Response model for DesignationRefund resource.

DesignationRelationships: Relationships for the Designation resource.

DesignationResource: A Designation conveys how much of a Donation goes to a particular Fund.

Designation details are required when creating a Donation. If all of a Donation is going to a single Fund, it will only have one Designation. Similarly, to split a Donation between multiple Funds, you can use multiple Designations.

DesignationResponse: Response model for Designation resource.

Donation: Attributes for the Donation resource.

DonationClient: Client for interacting with the Donation resource.

DonationCollectionResponse: Collection Response model for Donation resource.

DonationRelationships: Relationships for the Donation resource.

DonationResource: A Donation record corresponds to a gift given to an Organization at a particular point in time.

Donations are added by first associating them to a Batch of donations, and then committing the Batch. When adding a Donation to an already-committed Batch, the Donation will automatically be committed as well, and immediately added to the donor's online history.

DonationResponse: Response model for Donation resource.

Fund: Attributes for the Fund resource.

FundClient: Client for interacting with the Fund resource.

FundCollectionResponse: Collection Response model for Fund resource.

FundResource: 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:
<code><br />GET https://api.planningcenteronline.com/giving/v2/funds?where[default]=true<br /></code>

FundResponse: Response model for Fund resource.

InKindDonation: Attributes for the InKindDonation resource.

InKindDonationClient: Client for interacting with the InKindDonation resource.

InKindDonationCollectionResponse: Collection Response model for InKindDonation resource.

InKindDonationRelationships: Relationships for the InKindDonation resource.

InKindDonationResource: An InKindDonation record represents a non-cash gift given to an Organization at a specific time.

These include items like furniture, vehicles, services, or stocks. InKindDonations do not trigger
acknowledgment letter emails via the API — these must be sent from the Giving Admin UI.

More info

InKindDonationResponse: Response model for InKindDonation resource.

Label: Attributes for the Label resource.

LabelClient: Client for interacting with the Label resource.

LabelCollectionResponse: Collection Response model for Label resource.

LabelResource: 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.

LabelResponse: Response model for Label resource.

Note: Attributes for the Note resource.

NoteClient: Client for interacting with the Note resource.

NoteCollectionResponse: Collection Response model for Note resource.

NoteResource: A Note is a way for Giving Admins and Bookkeepers to communicate internally about a donation.
Notes are only visible in the Giving admin interface, not shown to donors. Each Donation can only
have a single note associated with it.

To record notes from donors, consider using the Memo Line feature instead.

NoteResponse: Response model for Note resource.

Organization: Attributes for the Organization resource.

OrganizationClient: Client for interacting with the Organization resource.

OrganizationCollectionResponse: Collection Response model for Organization resource.

OrganizationResource: The root level Organization record which serves as a link to Donations, People, Funds, etc.

OrganizationResponse: Response model for Organization resource.

PaginatedBatchClient: Client for interacting with Batch collection resources.

PaginatedBatchGroupClient: Client for interacting with BatchGroup collection resources.

PaginatedCampusClient: Client for interacting with Campus collection resources.

PaginatedDesignationClient: Client for interacting with Designation collection resources.

PaginatedDesignationRefundClient: Client for interacting with DesignationRefund collection resources.

PaginatedDonationClient: Client for interacting with Donation collection resources.

PaginatedFundClient: Client for interacting with Fund collection resources.

PaginatedInKindDonationClient: Client for interacting with InKindDonation collection resources.

PaginatedLabelClient: Client for interacting with Label collection resources.

PaginatedNoteClient: Client for interacting with Note collection resources.

PaginatedOrganizationClient: Client for interacting with Organization collection resources.

PaginatedPaymentMethodClient: Client for interacting with PaymentMethod collection resources.

PaginatedPaymentSourceClient: Client for interacting with PaymentSource collection resources.

PaginatedPersonClient: Client for interacting with Person collection resources.

PaginatedRecurringDonationClient: Client for interacting with RecurringDonation collection resources.

PaginatedRecurringDonationDesignationClient: Client for interacting with RecurringDonationDesignation collection resources.

PaginatedRefundClient: Client for interacting with Refund collection resources.

PaymentMethod: Attributes for the PaymentMethod resource.

PaymentMethodClient: Client for interacting with the PaymentMethod resource.

PaymentMethodCollectionResponse: Collection Response model for PaymentMethod resource.

PaymentMethodResource: Stored PaymentMethod information (card or bank_account) used by donors to make online Donations.

PaymentMethod data is for informational purposes only and cannot be used to create charges through the API.

PaymentMethodResponse: Response model for PaymentMethod resource.

PaymentSource: Attributes for the PaymentSource resource.

PaymentSourceClient: Client for interacting with the PaymentSource resource.

PaymentSourceCollectionResponse: Collection Response model for PaymentSource resource.

PaymentSourceResource: A donation's PaymentSource refers to the platform it originated from.

Donations made through Giving will be assigned the built-in PaymentSource "Planning Center". Donations made through external platforms (Square, Pushpay, ect.) can be assigned a PaymentSource identifying them as such.

PaymentSourceResponse: Response model for PaymentSource resource.

Person: Attributes for the Person resource.

PersonClient: Client for interacting with the Person resource.

PersonCollectionResponse: Collection Response model for Person resource.

PersonRelationships: Relationships for the Person resource.

PersonResource: A Planning Center Person record that has been added to Giving.

The Person object in Planning Center is so crucial that we have an entire product dedicated to managing, keeping track of, editing, and creating these records and metadata around them. For additional info, take a look at the Planning Center People API Docs.

PersonResponse: Response model for Person resource.

RecurringDonation: Attributes for the RecurringDonation resource.

RecurringDonationClient: Client for interacting with the RecurringDonation resource.

RecurringDonationCollectionResponse: Collection Response model for RecurringDonation resource.

RecurringDonationDesignation: Attributes for the RecurringDonationDesignation resource.

RecurringDonationDesignationClient: Client for interacting with the RecurringDonationDesignation resource.

RecurringDonationDesignationCollectionResponse: Collection Response model for RecurringDonationDesignation resource.

RecurringDonationDesignationResource: Much like a Designation, A RecurringDonationDesignation conveys how much of a RecurringDonation goes to a particular Fund.

RecurringDonationDesignationResponse: Response model for RecurringDonationDesignation resource.

RecurringDonationRelationships: Relationships for the RecurringDonation resource.

RecurringDonationResource: 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.

RecurringDonationResponse: Response model for RecurringDonation resource.

Refund: Attributes for the Refund resource.

RefundClient: Client for interacting with the Refund resource.

RefundCollectionResponse: Collection Response model for Refund resource.

RefundResource: A Refund record holds information pertaining to a refunded Donation.

RefundResponse: Response model for Refund resource.

Table of Contents

Namespace Crews.PlanningCenter.Api.Giving.V2018_08_01

Classes