1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
3 <base>CRM/Pledge
</base>
5 <name>civicrm_pledge
</name>
6 <description>Promises to contribute at a future time, either in full, or at regular intervals until a total goal is reached.
</description>
9 <icon>fa-paper-plane
</icon>
10 <component>CiviPledge
</component>
13 <uniqueName>pledge_id
</uniqueName>
14 <title>Pledge ID
</title>
15 <type>int unsigned
</type>
16 <required>true
</required>
17 <comment>Pledge ID
</comment>
26 <autoincrement>true
</autoincrement>
29 <name>contact_id
</name>
30 <uniqueName>pledge_contact_id
</uniqueName>
31 <title>Contact ID
</title>
33 <type>int unsigned
</type>
34 <required>true
</required>
35 <comment>Foreign key to civicrm_contact.id .
</comment>
38 <type>EntityRef
</type>
39 <label>Contact
</label>
43 <name>contact_id
</name>
44 <table>civicrm_contact
</table>
47 <onDelete>CASCADE
</onDelete>
50 <name>financial_type_id
</name>
51 <title>Financial Type ID
</title>
52 <uniqueName>pledge_financial_type_id
</uniqueName>
53 <type>int unsigned
</type>
54 <comment>FK to Financial Type
</comment>
56 <table>civicrm_financial_type
</table>
57 <keyColumn>id
</keyColumn>
58 <labelColumn>name
</labelColumn>
63 <label>Financial Type
</label>
67 <name>financial_type_id
</name>
68 <table>civicrm_financial_type
</table>
73 <name>contribution_page_id
</name>
74 <uniqueName>pledge_contribution_page_id
</uniqueName>
75 <title>Contribution Page ID
</title>
76 <type>int unsigned
</type>
77 <comment>The Contribution Page which triggered this contribution
</comment>
79 <label>Contribution Page
</label>
84 <name>contribution_page_id
</name>
85 <table>civicrm_contribution_page
</table>
87 <onDelete>SET NULL
</onDelete>
91 <uniqueName>pledge_amount
</uniqueName>
92 <title>Total Pledged
</title>
94 <required>true
</required>
96 <comment>Total pledged amount.
</comment>
103 <name>original_installment_amount
</name>
104 <uniqueName>pledge_original_installment_amount
</uniqueName>
105 <title>Original Installment Amount
</title>
107 <required>true
</required>
108 <comment>Original amount for each of the installments.
</comment>
113 <export>true
</export>
116 <name>currency
</name>
118 <title>Pledge Currency
</title>
120 <default>NULL
</default>
121 <comment>3 character string, value from config setting or input via user.
</comment>
124 <table>civicrm_currency
</table>
125 <keyColumn>name
</keyColumn>
126 <labelColumn>full_name
</labelColumn>
127 <nameColumn>name
</nameColumn>
128 <abbrColumn>symbol
</abbrColumn>
135 <name>frequency_unit
</name>
136 <uniqueName>pledge_frequency_unit
</uniqueName>
137 <title>Pledge Frequency Unit
</title>
139 <required>true
</required>
141 <default>'month'
</default>
142 <comment>Time units for recurrence of pledge payments.
</comment>
144 <optionGroupName>recur_frequency_units
</optionGroupName>
145 <keyColumn>name
</keyColumn>
153 <name>frequency_interval
</name>
154 <uniqueName>pledge_frequency_interval
</uniqueName>
155 <title>Pledge Frequency Interval
</title>
156 <type>int unsigned
</type>
157 <required>true
</required>
159 <comment>Number of time units for recurrence of pledge payments.
</comment>
166 <name>frequency_day
</name>
167 <type>int unsigned
</type>
168 <title>Pledge day
</title>
170 <required>true
</required>
171 <comment>Day in the period when the pledge payment is due e.g.
1st of month,
15th etc. Use this to set the scheduled dates for pledge payments.
</comment>
178 <name>installments
</name>
179 <type>int unsigned
</type>
180 <title>Pledge Number of Installments
</title>
182 <required>true
</required>
183 <comment>Total number of payments to be made.
</comment>
188 <export>true
</export>
191 <name>start_date
</name>
192 <type>datetime
</type>
193 <title>Pledge Start Date
</title>
194 <required>true
</required>
195 <export>true
</export>
196 <comment>The date the first scheduled pledge occurs.
</comment>
199 <type>Select Date
</type>
200 <formatType>activityDate
</formatType>
202 <uniqueName>pledge_start_date
</uniqueName>
203 <uniqueTitle>Payments Start Date
</uniqueTitle>
206 <name>create_date
</name>
207 <type>datetime
</type>
208 <uniqueName>pledge_create_date
</uniqueName>
209 <title>Pledge Made
</title>
210 <required>true
</required>
211 <import>true
</import>
212 <export>true
</export>
213 <comment>When this pledge record was created.
</comment>
216 <type>Select Date
</type>
217 <formatType>activityDate
</formatType>
221 <name>acknowledge_date
</name>
222 <type>datetime
</type>
223 <title>Pledge Acknowledged
</title>
224 <comment>When a pledge acknowledgement message was sent to the contributor.
</comment>
227 <type>Select Date
</type>
228 <formatType>activityDate
</formatType>
232 <name>modified_date
</name>
233 <type>datetime
</type>
234 <title>Pledge Modified Date
</title>
235 <comment>Last updated date for this pledge record.
</comment>
236 <readonly>true
</readonly>
240 <name>cancel_date
</name>
241 <type>datetime
</type>
242 <title>Pledge Cancelled Date
</title>
243 <comment>Date this pledge was cancelled by contributor.
</comment>
246 <type>Select Date
</type>
247 <formatType>activityDate
</formatType>
251 <name>end_date
</name>
252 <type>datetime
</type>
253 <title>Pledge End Date
</title>
254 <export>true
</export>
255 <comment>Date this pledge finished successfully (total pledge payments equal to or greater than pledged amount).
</comment>
258 <type>Select Date
</type>
259 <formatType>activityDate
</formatType>
261 <uniqueName>pledge_end_date
</uniqueName>
262 <uniqueTitle>Payments Ended Date
</uniqueTitle>
265 <name>max_reminders
</name>
266 <title>Maximum Number of Reminders
</title>
267 <type>int unsigned
</type>
269 <comment>The maximum number of payment reminders to send for any given payment.
</comment>
276 <name>initial_reminder_day
</name>
277 <title>Initial Reminder Day
</title>
278 <type>int unsigned
</type>
280 <comment>Send initial reminder this many days prior to the payment due date.
</comment>
287 <name>additional_reminder_day
</name>
288 <title>Additional Reminder Days
</title>
289 <type>int unsigned
</type>
291 <comment>Send additional reminder this many days after last one sent, up to maximum number of reminders.
</comment>
298 <name>status_id
</name>
299 <title>Pledge Status ID
</title>
300 <uniqueName>pledge_status_id
</uniqueName>
301 <required>true
</required>
302 <import>true
</import>
303 <export>false
</export>
304 <type>int unsigned
</type>
309 <optionGroupName>pledge_status
</optionGroupName>
311 <comment>Implicit foreign key to civicrm_option_values in the pledge_status option group.
</comment>
315 <name>index_status
</name>
316 <fieldName>status_id
</fieldName>
321 <uniqueName>pledge_is_test
</uniqueName>
322 <import>true
</import>
326 <required>true
</required>
328 <type>CheckBox
</type>
332 <name>campaign_id
</name>
333 <component>CiviCampaign
</component>
334 <uniqueName>pledge_campaign_id
</uniqueName>
335 <type>int unsigned
</type>
336 <title>Campaign ID
</title>
337 <import>true
</import>
338 <comment>The campaign for which this pledge has been initiated.
</comment>
341 <type>EntityRef
</type>
342 <label>Campaign
</label>
346 <name>campaign_id
</name>
347 <table>civicrm_campaign
</table>
349 <onDelete>SET NULL
</onDelete>