Designation
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.
Example Request
curl https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/designations
View in API Explorer →
Example Object
{
"type": "Designation",
"id": "1",
"attributes": {
"amount_cents": 1,
"amount_currency": "string",
"fee_cents": 1
},
"relationships": {
"fund": {
"data": {
"type": "Fund",
"id": "1"
}
}
}
}
Attributes
| Name |
Type |
Description |
amount_cents |
integer |
Required. The number of cents being donated to a designation's associated fund. |
amount_currency |
string |
The currency of `amount_cents`. Set to the currency of the associated organization. |
fee_cents |
integer |
The fee amount distributed to a donation's designation in proportion to the amount of the designation. This should either be 0 or a negative integer. |
id |
primary_key |
The unique identifier for a designation. |
Relationships
| Name |
Type |
Association Type |
Note |
| fund |
Fund |
to_one |
|
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/donations/{donation_id}/designations |
Reading
| HTTP Method |
Endpoint |
| GET |
/giving/v2/donations/{donation_id}/designations/{id} |
Associations
| HTTP Method |
Endpoint |
Returns |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/designations/{designation_id}/fund |
Fund
|
|
|
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/refund/designation_refunds/{designation_refund_id}/designation |
DesignationRefund
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/designations |
Donation
|
|
|