Skip to content

DesignationRefund (Giving)

A record that links a Refund with a Designation

A record that links a Refund with a Designation

Property Value
Product Giving (pco.giving, API version 2019-10-18)
Resource type DesignationRefund
TypeScript Giving.DesignationRefund, attributes Giving.DesignationRefundAttributes, schema Giving.DesignationRefundSchema
Planning Center path /giving/v2/donations/{donation_id}/refund/designation_refunds
Planning Center docs DesignationRefund

How to reach it

No documented path leads to this resource. It may appear in included or as a relationship of other resources; use pco.request() for undocumented endpoints.

Attributes

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

Name Type Description
amount_cents number | null The number of cents being refunded.
amount_currency string | null The currency of amount_cents.
fee_cents number | null

Relationships and includes

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

Relationship Type To Includable
designation To one Designation Yes
fund To one Fund No

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one DesignationRefund, ref = …id(designationRefundId):

Edge Leads to Returns Filters Create
ref.designation Designation Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

function describe(resource: Giving.DesignationRefund): string {
    return `${resource.type} ${resource.id}`;
}

Type to search…

↑↓ navigate↵ selectEsc close