1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
3 <base>CRM/Pledge
</base>
5 <name>civicrm_pledge
</name>
10 <uniqueName>pledge_id
</uniqueName>
11 <title>Pledge ID
</title>
12 <type>int unsigned
</type>
13 <required>true
</required>
14 <comment>Pledge ID
</comment>
20 <autoincrement>true
</autoincrement>
23 <name>contact_id
</name>
24 <uniqueName>pledge_contact_id
</uniqueName>
25 <title>Contact ID
</title>
27 <type>int unsigned
</type>
28 <required>true
</required>
29 <comment>Foreign key to civicrm_contact.id .
</comment>
33 <name>contact_id
</name>
34 <table>civicrm_contact
</table>
37 <onDelete>CASCADE
</onDelete>
40 <name>contribution_type_id
</name>
41 <uniqueName>pledge_contribution_type_id
</uniqueName>
42 <export>false
</export>
43 <type>int unsigned
</type>
44 <comment>FK to Contribution Type. This is propagated to contribution record when pledge payments are made.
</comment>
49 <name>contribution_type_id
</name>
50 <table>civicrm_contribution_type
</table>
54 <onDelete>SET NULL
</onDelete>
57 <name>financial_type_id
</name>
59 <uniqueName>pledge_financial_type_id
</uniqueName>
60 <type>int unsigned
</type>
61 <comment>FK to Financial Type
</comment>
65 <name>financial_type_id
</name>
66 <table>civicrm_financial_type
</table>
71 <name>contribution_page_id
</name>
72 <uniqueName>pledge_contribution_page_id
</uniqueName>
73 <title>Pledge Contribution Page
</title>
74 <type>int unsigned
</type>
75 <comment>The Contribution Page which triggered this contribution
</comment>
79 <name>contribution_page_id
</name>
80 <table>civicrm_contribution_page
</table>
82 <onDelete>SET NULL
</onDelete>
86 <uniqueName>pledge_amount
</uniqueName>
87 <title>Total Pledged
</title>
89 <required>true
</required>
91 <comment>Total pledged amount.
</comment>
95 <name>original_installment_amount
</name>
96 <uniqueName>pledge_original_installment_amount
</uniqueName>
97 <title>Original Installment Amount
</title>
99 <required>true
</required>
100 <comment>Original amount for each of the installments.
</comment>
104 <name>currency
</name>
106 <title>Pledge Currency
</title>
108 <default>NULL
</default>
109 <comment>3 character string, value from config setting or input via user.
</comment>
112 <table>civicrm_currency
</table>
113 <keyColumn>name
</keyColumn>
114 <labelColumn>full_name
</labelColumn>
115 <nameColumn>numeric_code
</nameColumn>
119 <name>frequency_unit
</name>
120 <uniqueName>pledge_frequency_unit
</uniqueName>
121 <title>Pledge Frequency Unit
</title>
123 <values>day,week,month,year
</values>
124 <default>'month'
</default>
125 <comment>Time units for recurrence of pledge payments.
</comment>
129 <name>frequency_interval
</name>
130 <uniqueName>pledge_frequency_interval
</uniqueName>
131 <title>Pledge Frequency Interval
</title>
132 <type>int unsigned
</type>
133 <required>true
</required>
135 <comment>Number of time units for recurrence of pledge payments.
</comment>
139 <name>frequency_day
</name>
140 <type>int unsigned
</type>
141 <title>Pledge day
</title>
143 <required>true
</required>
144 <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>
148 <name>installments
</name>
149 <type>int unsigned
</type>
150 <title>Pledge Number of Installments
</title>
152 <comment>Total number of payments to be made.
</comment>
156 <name>start_date
</name>
157 <type>datetime
</type>
158 <title>Pledge Start Date
</title>
159 <required>true
</required>
160 <comment>The date the first scheduled pledge occurs.
</comment>
164 <name>create_date
</name>
165 <type>datetime
</type>
166 <uniqueName>pledge_create_date
</uniqueName>
167 <title>Pledge Made
</title>
168 <required>true
</required>
169 <import>true
</import>
170 <comment>When this pledge record was created.
</comment>
174 <name>acknowledge_date
</name>
175 <type>datetime
</type>
176 <title>Pledge Acknowledged
</title>
177 <comment>When a pledge acknowledgement message was sent to the contributor.
</comment>
181 <name>modified_date
</name>
182 <type>datetime
</type>
183 <title>Pledge Modified Date
</title>
184 <comment>Last updated date for this pledge record.
</comment>
188 <name>cancel_date
</name>
189 <type>datetime
</type>
190 <title>Pledge Cancelled Date
</title>
191 <comment>Date this pledge was cancelled by contributor.
</comment>
195 <name>end_date
</name>
196 <type>datetime
</type>
197 <title>Pledge End Date
</title>
198 <comment>Date this pledge finished successfully (total pledge payments equal to or greater than pledged amount).
</comment>
202 <name>honor_contact_id
</name>
203 <type>int unsigned
</type>
204 <title>Pledge Honor Contact
</title>
205 <comment>FK to contact ID. Used when pledge is made in honor of another contact. This is propagated to contribution records when pledge payments are made.
</comment>
209 <name>honor_contact_id
</name>
210 <table>civicrm_contact
</table>
213 <onDelete>SET NULL
</onDelete>
216 <name>honor_type_id
</name>
217 <title>Honor Type
</title>
218 <type>int unsigned
</type>
219 <comment>Implicit FK to civicrm_option_value.
</comment>
221 <onDelete>SET NULL
</onDelete>
223 <optionGroupName>honor_type
</optionGroupName>
227 <name>max_reminders
</name>
228 <title>Maximum Number of Reminders
</title>
229 <type>int unsigned
</type>
231 <comment>The maximum number of payment reminders to send for any given payment.
</comment>
235 <name>initial_reminder_day
</name>
236 <title>Initial Reminder Day
</title>
237 <type>int unsigned
</type>
239 <comment>Send initial reminder this many days prior to the payment due date.
</comment>
243 <name>additional_reminder_day
</name>
244 <title>Additional Reminder Days
</title>
245 <type>int unsigned
</type>
247 <comment>Send additional reminder this many days after last one sent, up to maximum number of reminders.
</comment>
251 <name>status_id
</name>
252 <title>Pledge Status Id
</title>
253 <uniqueName>pledge_status_id
</uniqueName>
254 <import>true
</import>
255 <export>false
</export>
256 <type>int unsigned
</type>
257 <comment>Implicit foreign key to civicrm_option_values in the contribution_status option group.
</comment>
261 <name>index_status
</name>
262 <fieldName>status_id
</fieldName>
267 <uniqueName>pledge_is_test
</uniqueName>
268 <import>true
</import>
274 <name>campaign_id
</name>
275 <uniqueName>pledge_campaign_id
</uniqueName>
276 <type>int unsigned
</type>
277 <title>Campaign ID
</title>
278 <import>true
</import>
279 <comment>The campaign for which this pledge has been initiated.
</comment>
281 <table>civicrm_campaign
</table>
282 <keyColumn>id
</keyColumn>
283 <labelColumn>title
</labelColumn>
284 <condition>(end_date IS NULL OR end_date
> NOW())
</condition>
289 <name>campaign_id
</name>
290 <table>civicrm_campaign
</table>
292 <onDelete>SET NULL
</onDelete>