Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?xml version="1.0" encoding="iso-8859-1" ?> |
2 | <table> | |
3 | <base>CRM/Pledge</base> | |
4 | <class>Pledge</class> | |
5 | <name>civicrm_pledge</name> | |
6 | <add>2.1</add> | |
7 | <log>true</log> | |
8 | <field> | |
9 | <name>id</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> | |
15 | <import>true</import> | |
16 | <add>2.1</add> | |
17 | </field> | |
18 | <primaryKey> | |
19 | <name>id</name> | |
20 | <autoincrement>true</autoincrement> | |
21 | </primaryKey> | |
22 | <field> | |
23 | <name>contact_id</name> | |
24 | <uniqueName>pledge_contact_id</uniqueName> | |
25 | <title>Contact ID</title> | |
26 | <import>true</import> | |
27 | <type>int unsigned</type> | |
28 | <required>true</required> | |
29 | <comment>Foreign key to civicrm_contact.id .</comment> | |
30 | <add>2.1</add> | |
614d72ec | 31 | <html> |
916b6181 | 32 | <type>EntityRef</type> |
614d72ec | 33 | </html> |
6a488035 TO |
34 | </field> |
35 | <foreignKey> | |
36 | <name>contact_id</name> | |
37 | <table>civicrm_contact</table> | |
38 | <key>id</key> | |
39 | <add>2.1</add> | |
40 | <onDelete>CASCADE</onDelete> | |
41 | </foreignKey> | |
3c7d2158 | 42 | <field> |
43 | <name>contribution_type_id</name> | |
6a488035 TO |
44 | <uniqueName>pledge_contribution_type_id</uniqueName> |
45 | <export>false</export> | |
3c7d2158 | 46 | <type>int unsigned</type> |
6a488035 TO |
47 | <comment>FK to Contribution Type. This is propagated to contribution record when pledge payments are made.</comment> |
48 | <add>2.1</add> | |
3c7d2158 | 49 | <drop>4.3</drop> |
50 | </field> | |
51 | <foreignKey> | |
52 | <name>contribution_type_id</name> | |
53 | <table>civicrm_contribution_type</table> | |
54 | <key>id</key> | |
6a488035 | 55 | <add>2.1</add> |
3c7d2158 | 56 | <drop>4.3</drop> |
6a488035 TO |
57 | <onDelete>SET NULL</onDelete> |
58 | </foreignKey> | |
3c7d2158 | 59 | <field> |
60 | <name>financial_type_id</name> | |
6a488035 TO |
61 | <title>Type</title> |
62 | <uniqueName>pledge_financial_type_id</uniqueName> | |
3c7d2158 | 63 | <type>int unsigned</type> |
6a488035 | 64 | <comment>FK to Financial Type</comment> |
6cc0b7bd EM |
65 | <pseudoconstant> |
66 | <table>civicrm_financial_type</table> | |
67 | <keyColumn>id</keyColumn> | |
68 | <labelColumn>name</labelColumn> | |
69 | </pseudoconstant> | |
3c7d2158 | 70 | <add>4.3</add> |
614d72ec | 71 | <html> |
72 | <type>Select</type> | |
73 | </html> | |
3c7d2158 | 74 | </field> |
75 | <foreignKey> | |
76 | <name>financial_type_id</name> | |
77 | <table>civicrm_financial_type</table> | |
78 | <key>id</key> | |
79 | <add>4.3</add> | |
80 | </foreignKey> | |
81 | <field> | |
6a488035 TO |
82 | <name>contribution_page_id</name> |
83 | <uniqueName>pledge_contribution_page_id</uniqueName> | |
84 | <title>Pledge Contribution Page</title> | |
3c7d2158 | 85 | <type>int unsigned</type> |
86 | <comment>The Contribution Page which triggered this contribution</comment> | |
87 | <add>2.1</add> | |
88 | </field> | |
89 | <foreignKey> | |
90 | <name>contribution_page_id</name> | |
91 | <table>civicrm_contribution_page</table> | |
92 | <key>id</key> | |
6a488035 TO |
93 | <onDelete>SET NULL</onDelete> |
94 | </foreignKey> | |
95 | <field> | |
96 | <name>amount</name> | |
3c7d2158 | 97 | <uniqueName>pledge_amount</uniqueName> |
6a488035 TO |
98 | <title>Total Pledged</title> |
99 | <type>decimal</type> | |
100 | <required>true</required> | |
101 | <import>true</import> | |
102 | <comment>Total pledged amount.</comment> | |
103 | <add>2.1</add> | |
614d72ec | 104 | <html> |
105 | <type>Text</type> | |
106 | </html> | |
6a488035 TO |
107 | </field> |
108 | <field> | |
109 | <name>original_installment_amount</name> | |
3c7d2158 | 110 | <uniqueName>pledge_original_installment_amount</uniqueName> |
6a488035 TO |
111 | <title>Original Installment Amount</title> |
112 | <type>decimal</type> | |
113 | <required>true</required> | |
114 | <comment>Original amount for each of the installments.</comment> | |
115 | <add>3.2</add> | |
614d72ec | 116 | <html> |
117 | <type>Text</type> | |
118 | </html> | |
db517dfe | 119 | <export>true</export> |
6a488035 TO |
120 | </field> |
121 | <field> | |
122 | <name>currency</name> | |
123 | <type>varchar</type> | |
124 | <title>Pledge Currency</title> | |
125 | <length>3</length> | |
126 | <default>NULL</default> | |
127 | <comment>3 character string, value from config setting or input via user.</comment> | |
128 | <add>3.2</add> | |
bd44e0df AS |
129 | <pseudoconstant> |
130 | <table>civicrm_currency</table> | |
131 | <keyColumn>name</keyColumn> | |
a38a89fc | 132 | <labelColumn>full_name</labelColumn> |
c3de5c5a | 133 | <nameColumn>name</nameColumn> |
bd44e0df | 134 | </pseudoconstant> |
614d72ec | 135 | <html> |
e0991796 | 136 | <type>Select</type> |
614d72ec | 137 | </html> |
6a488035 TO |
138 | </field> |
139 | <field> | |
140 | <name>frequency_unit</name> | |
141 | <uniqueName>pledge_frequency_unit</uniqueName> | |
142 | <title>Pledge Frequency Unit</title> | |
be622aca | 143 | <type>varchar</type> |
144 | <length>8</length> | |
6a488035 TO |
145 | <default>'month'</default> |
146 | <comment>Time units for recurrence of pledge payments.</comment> | |
71a707c3 | 147 | <pseudoconstant> |
148 | <optionGroupName>recur_frequency_units</optionGroupName> | |
149 | <keyColumn>name</keyColumn> | |
150 | </pseudoconstant> | |
6a488035 | 151 | <add>2.1</add> |
614d72ec | 152 | <html> |
153 | <type>Select</type> | |
154 | </html> | |
6a488035 TO |
155 | </field> |
156 | <field> | |
157 | <name>frequency_interval</name> | |
158 | <uniqueName>pledge_frequency_interval</uniqueName> | |
159 | <title>Pledge Frequency Interval</title> | |
160 | <type>int unsigned</type> | |
161 | <required>true</required> | |
162 | <default>1</default> | |
163 | <comment>Number of time units for recurrence of pledge payments.</comment> | |
164 | <add>2.1</add> | |
614d72ec | 165 | <html> |
166 | <type>Text</type> | |
167 | </html> | |
6a488035 TO |
168 | </field> |
169 | <field> | |
170 | <name>frequency_day</name> | |
171 | <type>int unsigned</type> | |
172 | <title>Pledge day</title> | |
173 | <default>3</default> | |
174 | <required>true</required> | |
175 | <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> | |
176 | <add>2.1</add> | |
614d72ec | 177 | <html> |
178 | <type>Select</type> | |
179 | </html> | |
6a488035 TO |
180 | </field> |
181 | <field> | |
182 | <name>installments</name> | |
183 | <type>int unsigned</type> | |
184 | <title>Pledge Number of Installments</title> | |
185 | <default>1</default> | |
186 | <comment>Total number of payments to be made.</comment> | |
187 | <add>2.1</add> | |
614d72ec | 188 | <html> |
189 | <type>Text</type> | |
190 | </html> | |
db517dfe | 191 | <export>true</export> |
6a488035 TO |
192 | </field> |
193 | <field> | |
194 | <name>start_date</name> | |
195 | <type>datetime</type> | |
196 | <title>Pledge Start Date</title> | |
197 | <required>true</required> | |
198 | <comment>The date the first scheduled pledge occurs.</comment> | |
199 | <add>2.1</add> | |
614d72ec | 200 | <html> |
201 | <type>Select Date</type> | |
202 | </html> | |
6a488035 TO |
203 | </field> |
204 | <field> | |
205 | <name>create_date</name> | |
206 | <type>datetime</type> | |
207 | <uniqueName>pledge_create_date</uniqueName> | |
208 | <title>Pledge Made</title> | |
209 | <required>true</required> | |
210 | <import>true</import> | |
211 | <comment>When this pledge record was created.</comment> | |
212 | <add>2.1</add> | |
614d72ec | 213 | <html> |
214 | <type>Select Date</type> | |
215 | </html> | |
6a488035 TO |
216 | </field> |
217 | <field> | |
218 | <name>acknowledge_date</name> | |
219 | <type>datetime</type> | |
220 | <title>Pledge Acknowledged</title> | |
221 | <comment>When a pledge acknowledgement message was sent to the contributor.</comment> | |
222 | <add>2.1</add> | |
614d72ec | 223 | <html> |
224 | <type>Select Date</type> | |
225 | </html> | |
6a488035 TO |
226 | </field> |
227 | <field> | |
228 | <name>modified_date</name> | |
229 | <type>datetime</type> | |
230 | <title>Pledge Modified Date</title> | |
231 | <comment>Last updated date for this pledge record.</comment> | |
232 | <add>2.1</add> | |
233 | </field> | |
234 | <field> | |
235 | <name>cancel_date</name> | |
236 | <type>datetime</type> | |
237 | <title>Pledge Cancelled Date</title> | |
238 | <comment>Date this pledge was cancelled by contributor.</comment> | |
239 | <add>2.1</add> | |
614d72ec | 240 | <html> |
241 | <type>Select Date</type> | |
242 | </html> | |
6a488035 TO |
243 | </field> |
244 | <field> | |
245 | <name>end_date</name> | |
246 | <type>datetime</type> | |
247 | <title>Pledge End Date</title> | |
248 | <comment>Date this pledge finished successfully (total pledge payments equal to or greater than pledged amount).</comment> | |
249 | <add>2.1</add> | |
614d72ec | 250 | <html> |
251 | <type>Select Date</type> | |
252 | </html> | |
6a488035 | 253 | </field> |
6a488035 TO |
254 | <field> |
255 | <name>max_reminders</name> | |
256 | <title>Maximum Number of Reminders</title> | |
257 | <type>int unsigned</type> | |
258 | <default>1</default> | |
259 | <comment>The maximum number of payment reminders to send for any given payment.</comment> | |
614d72ec | 260 | <html> |
261 | <type>Text</type> | |
262 | </html> | |
6a488035 TO |
263 | <add>2.1</add> |
264 | </field> | |
265 | <field> | |
266 | <name>initial_reminder_day</name> | |
267 | <title>Initial Reminder Day</title> | |
268 | <type>int unsigned</type> | |
269 | <default>5</default> | |
270 | <comment>Send initial reminder this many days prior to the payment due date.</comment> | |
271 | <add>2.1</add> | |
614d72ec | 272 | <html> |
273 | <type>Select</type> | |
274 | </html> | |
6a488035 TO |
275 | </field> |
276 | <field> | |
277 | <name>additional_reminder_day</name> | |
278 | <title>Additional Reminder Days</title> | |
279 | <type>int unsigned</type> | |
280 | <default>5</default> | |
281 | <comment>Send additional reminder this many days after last one sent, up to maximum number of reminders.</comment> | |
282 | <add>2.1</add> | |
614d72ec | 283 | <html> |
284 | <type>Text</type> | |
285 | </html> | |
6a488035 TO |
286 | </field> |
287 | <field> | |
288 | <name>status_id</name> | |
289 | <title>Pledge Status Id</title> | |
290 | <uniqueName>pledge_status_id</uniqueName> | |
291 | <import>true</import> | |
292 | <export>false</export> | |
293 | <type>int unsigned</type> | |
52ddd94d | 294 | <html> |
295 | <type>Select</type> | |
296 | </html> | |
294cc627 | 297 | <pseudoconstant> |
01dac399 | 298 | <optionGroupName>pledge_status</optionGroupName> |
294cc627 | 299 | </pseudoconstant> |
01dac399 | 300 | <comment>Implicit foreign key to civicrm_option_values in the pledge_status option group.</comment> |
6a488035 TO |
301 | <add>2.1</add> |
302 | </field> | |
303 | <index> | |
304 | <name>index_status</name> | |
305 | <fieldName>status_id</fieldName> | |
306 | <add>2.1</add> | |
307 | </index> | |
3c7d2158 | 308 | <field> |
309 | <name>is_test</name> | |
310 | <uniqueName>pledge_is_test</uniqueName> | |
6a488035 TO |
311 | <import>true</import> |
312 | <title>Test</title> | |
313 | <type>boolean</type> | |
314 | <default>0</default> | |
614d72ec | 315 | <html> |
316 | <type>CheckBox</type> | |
317 | </html> | |
6a488035 | 318 | </field> |
3c7d2158 | 319 | <field> |
320 | <name>campaign_id</name> | |
6a488035 | 321 | <uniqueName>pledge_campaign_id</uniqueName> |
3c7d2158 | 322 | <type>int unsigned</type> |
e1ab2e91 | 323 | <title>Campaign</title> |
3c7d2158 | 324 | <import>true</import> |
325 | <comment>The campaign for which this pledge has been initiated.</comment> | |
3e3eacd0 CW |
326 | <pseudoconstant> |
327 | <table>civicrm_campaign</table> | |
328 | <keyColumn>id</keyColumn> | |
329 | <labelColumn>title</labelColumn> | |
3e3eacd0 | 330 | </pseudoconstant> |
3c7d2158 | 331 | <add>3.4</add> |
614d72ec | 332 | <html> |
333 | <type>Select</type> | |
334 | </html> | |
3c7d2158 | 335 | </field> |
336 | <foreignKey> | |
337 | <name>campaign_id</name> | |
338 | <table>civicrm_campaign</table> | |
339 | <key>id</key> | |
6a488035 TO |
340 | <onDelete>SET NULL</onDelete> |
341 | </foreignKey> | |
342 | </table> |