1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
3 <base>CRM/Contribute
</base>
4 <class>ContributionRecur
</class>
5 <name>civicrm_contribution_recur
</name>
8 <title>Recurring Contribution
</title>
9 <component>CiviContribute
</component>
12 <uniqueName>contribution_recur_id
</uniqueName>
13 <title>Recurring Contribution ID
</title>
14 <type>int unsigned
</type>
15 <required>true
</required>
16 <comment>Contribution Recur ID
</comment>
24 <autoincrement>true
</autoincrement>
27 <name>contact_id
</name>
28 <title>Contact ID
</title>
29 <type>int unsigned
</type>
30 <required>true
</required>
31 <comment>Foreign key to civicrm_contact.id.
</comment>
34 <type>EntityRef
</type>
35 <label>Contact
</label>
39 <name>contact_id
</name>
40 <table>civicrm_contact
</table>
43 <onDelete>CASCADE
</onDelete>
49 <required>true
</required>
50 <comment>Amount to be collected (including any sales tax) by payment processor each recurrence.
</comment>
58 <title>Currency
</title>
61 <default>NULL
</default>
62 <comment>3 character string, value from config setting or input via user.
</comment>
65 <table>civicrm_currency
</table>
66 <keyColumn>name
</keyColumn>
67 <labelColumn>full_name
</labelColumn>
68 <nameColumn>name
</nameColumn>
69 <abbrColumn>symbol
</abbrColumn>
76 <name>frequency_unit
</name>
77 <title>Frequency Unit
</title>
80 <default>'month'
</default>
81 <comment>Time units for recurrence of payment.
</comment>
83 <optionGroupName>recur_frequency_units
</optionGroupName>
84 <keyColumn>name
</keyColumn>
92 <name>frequency_interval
</name>
93 <title>Interval (number of units)
</title>
94 <type>int unsigned
</type>
95 <required>true
</required>
97 <comment>Number of time units for recurrence of payment.
</comment>
104 <name>installments
</name>
105 <title>Number of Installments
</title>
106 <type>int unsigned
</type>
107 <comment>Total number of payments to be made. Set this to
0 if this is an open-ended commitment i.e. no set end date.
</comment>
114 <name>start_date
</name>
115 <title>Start Date
</title>
116 <type>datetime
</type>
117 <required>true
</required>
118 <default>CURRENT_TIMESTAMP
</default>
119 <comment>The date the first scheduled recurring contribution occurs.
</comment>
122 <type>Select Date
</type>
123 <formatType>activityDateTime
</formatType>
125 <uniqueName>contribution_recur_start_date
</uniqueName>
126 <uniqueTitle>Recurring Contribution Start Date
</uniqueTitle>
129 <name>create_date
</name>
130 <title>Created Date
</title>
131 <type>datetime
</type>
132 <required>true
</required>
133 <default>CURRENT_TIMESTAMP
</default>
134 <comment>When this recurring contribution record was created.
</comment>
137 <type>Select Date
</type>
138 <formatType>activityDateTime
</formatType>
140 <uniqueName>contribution_recur_create_date
</uniqueName>
141 <uniqueTitle>Recurring Contribution Create Date
</uniqueTitle>
144 <name>modified_date
</name>
145 <title>Modified Date
</title>
146 <type>timestamp
</type>
147 <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
</default>
148 <comment>Last updated date for this record. mostly the last time a payment was received
</comment>
151 <type>Select Date
</type>
152 <formatType>activityDateTime
</formatType>
154 <uniqueName>contribution_recur_modified_date
</uniqueName>
155 <uniqueTitle>Recurring Contribution Modified Date
</uniqueTitle>
156 <readonly>true
</readonly>
159 <name>cancel_date
</name>
160 <title>Cancel Date
</title>
161 <type>datetime
</type>
162 <comment>Date this recurring contribution was cancelled by contributor- if we can get access to it
</comment>
165 <type>Select Date
</type>
166 <formatType>activityDate
</formatType>
168 <uniqueName>contribution_recur_cancel_date
</uniqueName>
169 <uniqueTitle>Recurring Contribution Cancel Date
</uniqueTitle>
172 <name>cancel_reason
</name>
174 <title>Cancellation Reason
</title>
175 <uniqueName>contribution_recur_cancel_reason
</uniqueName>
176 <uniqueTitle>Recurring Contribution Cancel Reason
</uniqueTitle>
177 <comment>Free text field for a reason for cancelling
</comment>
185 <name>end_date
</name>
186 <title>Recurring Contribution End Date
</title>
187 <type>datetime
</type>
188 <comment>Date this recurring contribution finished successfully
</comment>
191 <type>Select Date
</type>
192 <formatType>activityDate
</formatType>
194 <uniqueName>contribution_recur_end_date
</uniqueName>
195 <uniqueTitle>Recurring Contribution End Date
</uniqueTitle>
198 <name>processor_id
</name>
199 <uniqueName>contribution_recur_processor_id
</uniqueName>
200 <title>Processor ID
</title>
203 <comment>Possibly needed to store a unique identifier for this recurring payment order - if this is available from the processor??
</comment>
210 <name>payment_token_id
</name>
211 <title>Payment Token ID
</title>
212 <type>int unsigned
</type>
213 <comment>Optionally used to store a link to a payment token used for this recurring contribution.
</comment>
215 <label>Payment Token
</label>
220 <name>payment_token_id
</name>
221 <table>civicrm_payment_token
</table>
224 <onDelete>SET NULL
</onDelete>
228 <uniqueName>contribution_recur_trxn_id
</uniqueName>
229 <title>Transaction ID
</title>
232 <comment>unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method
</comment>
239 <name>invoice_id
</name>
240 <title>Invoice ID
</title>
243 <comment>unique invoice id, system generated or passed in
</comment>
250 <name>UI_contrib_trxn_id
</name>
251 <fieldName>trxn_id
</fieldName>
252 <unique>true
</unique>
256 <name>UI_contrib_invoice_id
</name>
257 <fieldName>invoice_id
</fieldName>
258 <unique>true
</unique>
262 <name>contribution_status_id
</name>
263 <uniqueName>contribution_recur_contribution_status_id
</uniqueName>
264 <title>Status
</title>
265 <type>int unsigned
</type>
267 <import>true
</import>
270 <optionGroupName>contribution_recur_status
</optionGroupName>
277 <name>index_contribution_status
</name>
278 <fieldName>contribution_status_id
</fieldName>
286 <import>true
</import>
288 <type>CheckBox
</type>
292 <name>cycle_day
</name>
293 <title>Cycle Day
</title>
294 <type>int unsigned
</type>
296 <required>true
</required>
297 <comment>Day in the period when the payment should be charged e.g.
1st of month,
15th etc.
</comment>
304 <name>next_sched_contribution_date
</name>
305 <title>Next Scheduled Contribution Date
</title>
306 <type>datetime
</type>
307 <comment>Next scheduled date
</comment>
310 <type>Select Date
</type>
311 <formatType>activityDate
</formatType>
313 <uniqueName>contribution_recur_next_sched_contribution_date
</uniqueName>
314 <uniqueTitle>Next Scheduled Recurring Contribution
</uniqueTitle>
317 <name>failure_count
</name>
318 <title>Number of Failures
</title>
319 <type>int unsigned
</type>
321 <comment>Number of failed charge attempts since last success. Business rule could be set to deactivate on more than x failures.
</comment>
328 <name>failure_retry_date
</name>
329 <type>datetime
</type>
330 <title>Retry Failed Attempt Date
</title>
331 <comment>Date to retry failed attempt
</comment>
334 <type>Select Date
</type>
335 <formatType>activityDate
</formatType>
337 <uniqueName>contribution_recur_failure_retry_date
</uniqueName>
338 <uniqueTitle>Failed Recurring Contribution Retry Date
</uniqueTitle>
341 <name>auto_renew
</name>
342 <title>Auto Renew
</title>
344 <required>true
</required>
346 <comment>Some systems allow contributor to set a number of installments - but then auto-renew the subscription or commitment if they do not cancel.
</comment>
349 <type>CheckBox
</type>
353 <name>payment_processor_id
</name>
354 <title>Payment Processor ID
</title>
355 <uniqueName>contribution_recur_payment_processor_id
</uniqueName>
356 <type>int unsigned
</type>
357 <comment>Foreign key to civicrm_payment_processor.id
</comment>
360 <table>civicrm_payment_processor
</table>
361 <keyColumn>id
</keyColumn>
362 <labelColumn>name
</labelColumn>
366 <label>Payment Processor
</label>
370 <name>payment_processor_id
</name>
371 <table>civicrm_payment_processor
</table>
374 <onDelete>SET NULL
</onDelete>
377 <name>financial_type_id
</name>
378 <title>Financial Type ID
</title>
379 <export>false
</export>
380 <type>int unsigned
</type>
381 <comment>FK to Financial Type
</comment>
384 <table>civicrm_financial_type
</table>
385 <keyColumn>id
</keyColumn>
386 <labelColumn>name
</labelColumn>
390 <label>Financial Type
</label>
394 <name>financial_type_id
</name>
395 <table>civicrm_financial_type
</table>
398 <onDelete>SET NULL
</onDelete>
401 <name>payment_instrument_id
</name>
402 <title>Payment Method
</title>
403 <type>int unsigned
</type>
404 <comment>FK to Payment Instrument
</comment>
406 <optionGroupName>payment_instrument
</optionGroupName>
414 <name>UI_contribution_recur_payment_instrument_id
</name>
415 <fieldName>payment_instrument_id
</fieldName>
419 <name>campaign_id
</name>
420 <component>CiviCampaign
</component>
421 <uniqueName>contribution_campaign_id
</uniqueName>
422 <type>int unsigned
</type>
423 <title>Campaign ID
</title>
424 <import>true
</import>
425 <comment>The campaign for which this contribution has been triggered.
</comment>
428 <type>EntityRef
</type>
429 <label>Campaign
</label>
432 <table>civicrm_campaign
</table>
433 <keyColumn>id
</keyColumn>
434 <labelColumn>title
</labelColumn>
435 <prefetch>FALSE
</prefetch>
439 <name>campaign_id
</name>
440 <table>civicrm_campaign
</table>
442 <onDelete>SET NULL
</onDelete>
445 <name>is_email_receipt
</name>
446 <title>Send email Receipt?
</title>
448 <comment>if true, receipt is automatically emailed to contact on each successful payment
</comment>
452 <type>CheckBox
</type>