[civicrm-core.git] / xml / schema / Contribute / Contribution.xml

<?xml version="1.0" encoding="iso-8859-1" ?>

<table>
  <base>CRM/Contribute</base>
  <class>Contribution</class>
  <name>civicrm_contribution</name>
  <add>1.3</add>
  <log>true</log>
  <field>
    <name>id</name>
    <uniqueName>contribution_id</uniqueName>
    <type>int unsigned</type>
    <required>true</required>
    <import>true</import>
    <title>Contribution ID</title>
    <comment>Contribution ID</comment>
    <add>1.3</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>contact_id</name>
    <uniqueName>contribution_contact_id</uniqueName>
    <title>Contact ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <import>true</import>
    <headerPattern>/contact(.?id)?/i</headerPattern>
    <dataPattern>/^\d+$/</dataPattern>
    <comment>FK to Contact ID</comment>
    <html>
       <type>EntityRef</type>
     </html>
    <add>1.3</add>
  </field>
  <foreignKey>
    <name>contact_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>1.3</add>
    <onDelete>CASCADE</onDelete>
  </foreignKey>
  <field>
    <name>solicitor_id</name>
    <title>Solicitor ID</title>
    <type>int unsigned</type>
    <comment>FK to Solicitor ID</comment>
    <add>1.4</add>
    <drop>2.2</drop>
  </field>
  <foreignKey>
    <name>solicitor_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>1.4</add>
    <drop>2.2</drop>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>contribution_type_id</name>
    <title>Contribution Type</title>
    <export>false</export>
    <type>int unsigned</type>
    <comment>FK to Contribution Type</comment>
    <add>1.3</add>
    <drop>4.3</drop>
  </field>
  <foreignKey>
    <name>contribution_type_id</name>
    <table>civicrm_contribution_type</table>
    <key>id</key>
    <add>1.3</add>
    <drop>4.3</drop>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>financial_type_id</name>
    <title>Financial Type</title>
    <type>int unsigned</type>
    <comment>FK to Financial Type for (total_amount - non_deductible_amount).</comment>
    <pseudoconstant>
      <table>civicrm_financial_type</table>
      <keyColumn>id</keyColumn>
      <labelColumn>name</labelColumn>
    </pseudoconstant>
    <export>true</export>
    <html>
      <type>Select</type>
    </html>
    <add>4.3</add>
  </field>
  <foreignKey>
    <name>financial_type_id</name>
    <table>civicrm_financial_type</table>
    <key>id</key>
    <add>4.3</add>
  </foreignKey>
  <field>
    <name>contribution_page_id</name>
    <title>Contribution Page ID</title>
    <type>int unsigned</type>
    <import>true</import>
    <comment>The Contribution Page which triggered this contribution</comment>
    <pseudoconstant>
      <table>civicrm_contribution_page</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
    <add>1.5</add>
  </field>
  <foreignKey>
    <name>contribution_page_id</name>
    <table>civicrm_contribution_page</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>payment_instrument_id</name>
    <uniqueName>payment_instrument_id</uniqueName>
    <title>Payment Method ID</title>
    <type>int unsigned</type>
    <comment>FK to Payment Instrument</comment>
    <export>true</export>
    <headerPattern>/^payment|(p(ayment\s)?instrument)$/i</headerPattern>
    <pseudoconstant>
      <optionGroupName>payment_instrument</optionGroupName>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
    <add>1.3</add>
  </field>
  <index>
    <name>UI_contrib_payment_instrument_id</name>
    <fieldName>payment_instrument_id</fieldName>
    <add>1.6</add>
  </index>
  <field>
    <name>receive_date</name>
    <title>Date Received</title>
    <type>datetime</type>
    <import>true</import>
    <headerPattern>/receive(.?date)?/i</headerPattern>
    <dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
    <comment>Date contribution was received - not necessarily the creation date of the record</comment>
    <add>1.3</add>
    <html>
     <type>Select Date</type>
     <formatType>activityDateTime</formatType>
   </html>
  </field>
  <field>
    <name>non_deductible_amount</name>
    <title>Non-deductible Amount</title>
    <type>decimal</type>
    <default>0</default>
    <import>true</import>
    <headerPattern>/non?.?deduct/i</headerPattern>
    <dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
    <comment>Portion of total amount which is NOT tax deductible. Equal to total_amount for non-deductible financial types.</comment>
    <add>1.3</add>
    <html>
     <type>Text</type>
   </html>
  </field>
  <field>
    <name>total_amount</name>
    <type>decimal</type>
    <required>true</required>
    <import>true</import>
    <headerPattern>/^total|(.?^am(ou)?nt)/i</headerPattern>
    <dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
    <comment>Total amount of this contribution. Use market value for non-monetary gifts.</comment>
    <add>1.3</add>
    <html>
     <type>Text</type>
   </html>
  </field>
  <index>
    <name>index_total_amount_receive_date</name>
    <fieldName>total_amount</fieldName>
    <fieldName>receive_date</fieldName>
    <add>4.7</add>
  </index>
  <field>
    <name>fee_amount</name>
    <type>decimal</type>
    <import>true</import>
    <headerPattern>/fee(.?am(ou)?nt)?/i</headerPattern>
    <dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
    <comment>actual processor fee if known - may be 0.</comment>
    <add>1.3</add>
    <html>
     <type>Text</type>
   </html>
  </field>
  <field>
    <name>net_amount</name>
    <type>decimal</type>
    <import>true</import>
    <headerPattern>/net(.?am(ou)?nt)?/i</headerPattern>
    <dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
    <comment>actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.</comment>
    <add>1.3</add>
    <html>
     <type>Text</type>
   </html>
  </field>
  <field>
    <name>trxn_id</name>
    <title>Transaction ID</title>
    <type>varchar</type>
    <length>255</length>
    <import>true</import>
    <headerPattern>/tr(ansactio|x)n(.?id)?/i</headerPattern>
    <comment>unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method</comment>
    <html>
     <type>Text</type>
   </html>
    <add>1.3</add>
  </field>
  <field>
    <name>invoice_id</name>
    <title>Invoice Reference</title>
    <type>varchar</type>
    <length>255</length>
    <import>true</import>
    <headerPattern>/invoice(.?id)?/i</headerPattern>
    <comment>unique invoice id, system generated or passed in</comment>
    <html>
      <type>Text</type>
    </html>
    <add>1.3</add>
  </field>
  <field>
    <name>invoice_number</name>
    <title>Invoice Number</title>
    <type>varchar</type>
    <length>255</length>
    <import>true</import>
    <headerPattern>/invoice(.?number)?/i</headerPattern>
    <comment>Human readable invoice number</comment>
    <html>
      <type>Text</type>
    </html>
    <add>4.7</add>
  </field>
  <field>
    <name>currency</name>
    <type>varchar</type>
    <length>3</length>
    <default>NULL</default>
    <import>true</import>
    <headerPattern>/cur(rency)?/i</headerPattern>
    <dataPattern>/^[A-Z]{3}$/i</dataPattern>
    <comment>3 character string, value from config setting or input via user.</comment>
    <add>1.3</add>
    <pseudoconstant>
      <table>civicrm_currency</table>
      <keyColumn>name</keyColumn>
      <labelColumn>full_name</labelColumn>
      <nameColumn>name</nameColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>cancel_date</name>
    <type>datetime</type>
    <import>true</import>
    <headerPattern>/cancel(.?date)?/i</headerPattern>
    <dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
    <comment>when was gift cancelled</comment>
    <add>1.3</add>
    <html>
      <type>Select Date</type>
      <formatType>activityDateTime</formatType>
    </html>
  </field>
  <field>
    <name>cancel_reason</name>
    <type>text</type>
    <import>true</import>
    <headerPattern>/(cancel.?)?reason/i</headerPattern>
    <html>
      <type>Text</type>
    </html>
    <add>1.3</add>
  </field>
  <field>
    <name>receipt_date</name>
    <type>datetime</type>
    <import>true</import>
    <headerPattern>/receipt(.?date)?/i</headerPattern>
    <dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
    <comment>when (if) receipt was sent. populated automatically for online donations w/ automatic receipting</comment>
    <html>
      <type>Select Date</type>
      <formatType>activityDateTime</formatType>
    </html>
    <add>1.3</add>
  </field>
  <field>
    <name>thankyou_date</name>
    <title>Thank-you Date</title>
    <type>datetime</type>
    <import>true</import>
    <headerPattern>/thank(s|(.?you))?(.?date)?/i</headerPattern>
    <dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
    <comment>when (if) was donor thanked</comment>
    <add>1.3</add>
    <html>
      <type>Select Date</type>
      <formatType>activityDateTime</formatType>
    </html>
  </field>
  <field>
    <name>source</name>
    <uniqueName>contribution_source</uniqueName>
    <title>Contribution Source</title>
    <type>varchar</type>
    <length>255</length>
    <import>true</import>
    <headerPattern>/source/i</headerPattern>
    <comment>Origin of this Contribution.</comment>
    <add>1.3</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <index>
    <name>index_source</name>
    <fieldName>source</fieldName>
    <add>4.7</add>
  </index>
  <field>
    <name>amount_level</name>
    <title>Amount Label</title>
    <type>text</type>
    <import>true</import>
    <add>1.7</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <field>
    <name>note</name>
    <type>text</type>
    <comment>Note and/or Comment.</comment>
    <import>true</import>
    <headerPattern>/Note|Comment/i</headerPattern>
    <dataPattern>//</dataPattern>
    <add>1.4</add>
    <drop>1.7</drop>
  </field>
  <index>
    <name>UI_contrib_trxn_id</name>
    <fieldName>trxn_id</fieldName>
    <unique>true</unique>
    <add>2.1</add>
  </index>
  <index>
    <name>UI_contrib_invoice_id</name>
    <fieldName>invoice_id</fieldName>
    <unique>true</unique>
    <add>2.1</add>
  </index>
  <field>
    <name>contribution_recur_id</name>
    <title>Recurring Contribution ID</title>
    <type>int unsigned</type>
    <comment>Conditional foreign key to civicrm_contribution_recur id. Each contribution made in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.</comment>
    <export>true</export>
    <add>1.4</add>
  </field>
  <foreignKey>
    <name>contribution_recur_id</name>
    <table>civicrm_contribution_recur</table>
    <key>id</key>
    <add>1.4</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>is_test</name>
    <title>Test</title>
    <type>boolean</type>
    <default>0</default>
    <import>true</import>
    <html>
      <type>CheckBox</type>
    </html>
  </field>
  <field>
    <name>is_pay_later</name>
    <title>Is Pay Later</title>
    <type>boolean</type>
    <default>0</default>
    <import>true</import>
    <add>2.1</add>
    <html>
      <type>CheckBox</type>
    </html>
  </field>
  <field>
    <name>contribution_status_id</name>
    <title>Contribution Status ID</title>
    <type>int unsigned</type>
    <default>1</default>
    <import>true</import>
    <export>true</export>
    <headerPattern>/status/i</headerPattern>
    <pseudoconstant>
      <optionGroupName>contribution_status</optionGroupName>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
    <add>1.6</add>
  </field>
  <index>
    <name>index_contribution_status</name>
    <fieldName>contribution_status_id</fieldName>
    <add>1.6</add>
  </index>
  <index>
    <name>received_date</name>
    <fieldName>receive_date</fieldName>
    <add>1.6</add>
  </index>
  <field>
    <name>address_id</name>
    <uniqueName>contribution_address_id</uniqueName>
    <title>Contribution Address</title>
    <type>int unsigned</type>
    <comment>Conditional foreign key to civicrm_address.id. We insert an address record for each contribution when we have associated billing name and address data.</comment>
    <add>2.2</add>
    <export>true</export>
  </field>
  <foreignKey>
    <name>address_id</name>
    <table>civicrm_address</table>
    <key>id</key>
    <add>2.2</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>check_number</name>
    <title>Check Number</title>
    <uniqueName>contribution_check_number</uniqueName>
    <headerPattern>/check(.?number)?/i</headerPattern>
    <type>varchar</type>
    <length>255</length>
    <html>
      <type>Text</type>
      <size>6</size>
    </html>
    <import>true</import>
    <add>2.2</add>
  </field>
  <index>
    <name>check_number</name>
    <fieldName>check_number</fieldName>
    <add>2.2</add>
  </index>
  <field>
    <name>campaign_id</name>
    <uniqueName>contribution_campaign_id</uniqueName>
    <type>int unsigned</type>
    <title>Campaign</title>
    <import>true</import>
    <comment>The campaign for which this contribution has been triggered.</comment>
    <pseudoconstant>
      <table>civicrm_campaign</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
    </pseudoconstant>
    <add>3.4</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>creditnote_id</name>
    <title>Credit Note ID</title>
    <type>varchar</type>
    <length>255</length>
    <import>true</import>
    <headerPattern>/creditnote(.?id)?/i</headerPattern>
    <comment>unique credit note id, system generated or passed in</comment>
    <add>4.6</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <index>
    <name>index_creditnote_id</name>
    <fieldName>creditnote_id</fieldName>
    <add>4.7</add>
  </index>
  <field>
    <name>tax_amount</name>
    <title>Tax Amount</title>
    <type>decimal</type>
    <import>true</import>
    <headerPattern>/tax(.?am(ou)?nt)?/i</headerPattern>
    <dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
    <comment>Total tax amount of this contribution.</comment>
    <add>4.6</add>
    <html>
     <type>Text</type>
   </html>
  </field>
  <foreignKey>
    <name>campaign_id</name>
    <table>civicrm_campaign</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>revenue_recognition_date</name>
    <type>datetime</type>
    <import>true</import>
    <headerPattern>/revenue(.?date)?/i</headerPattern>
    <dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
    <comment>Stores the date when revenue should be recognized.</comment>
    <html>
      <type>Select Date</type>
        <formatType>activityDateTime</formatType>
    </html>
    <add>4.7</add>
  </field>
</table>
Commit	Line	Data
6d68a4cb	1	<?xml version="1.0" encoding="iso-8859-1" ?>
6a488035	2
6d68a4cb CW	3	<table>
	4	<base>CRM/Contribute</base>
	5	<class>Contribution</class>
	6	<name>civicrm_contribution</name>
	7	<add>1.3</add>
6a488035	8	<log>true</log>
6d68a4cb CW	9	<field>
6d68a4cb CW	10	<name>id</name>
6a488035	11	<uniqueName>contribution_id</uniqueName>
6d68a4cb	12	<type>int unsigned</type>
6a488035	13	<required>true</required>
6d68a4cb	14	<import>true</import>
6a488035	15	<title>Contribution ID</title>
6d68a4cb CW	16	<comment>Contribution ID</comment>
	17	<add>1.3</add>
	18	</field>
	19	<primaryKey>
	20	<name>id</name>
	21	<autoincrement>true</autoincrement>
	22	</primaryKey>
	23	<field>
	24	<name>contact_id</name>
6a488035 TO	25	<uniqueName>contribution_contact_id</uniqueName>
6a488035 TO	26	<title>Contact ID</title>
6d68a4cb CW	27	<type>int unsigned</type>
6d68a4cb CW	28	<required>true</required>
6a488035 TO	29	<import>true</import>
	30	<headerPattern>/contact(.?id)?/i</headerPattern>
	31	<dataPattern>/^\d+$/</dataPattern>
6d68a4cb	32	<comment>FK to Contact ID</comment>
614d72ec	33	<html>
916b6181	34	<type>EntityRef</type>
614d72ec	35	</html>
6d68a4cb CW	36	<add>1.3</add>
	37	</field>
	38	<foreignKey>
	39	<name>contact_id</name>
	40	<table>civicrm_contact</table>
	41	<key>id</key>
	42	<add>1.3</add>
6a488035	43	<onDelete>CASCADE</onDelete>
6d68a4cb CW	44	</foreignKey>
	45	<field>
	46	<name>solicitor_id</name>
6a488035	47	<title>Solicitor ID</title>
6d68a4cb CW	48	<type>int unsigned</type>
	49	<comment>FK to Solicitor ID</comment>
	50	<add>1.4</add>
6a488035	51	<drop>2.2</drop>
6d68a4cb CW	52	</field>
	53	<foreignKey>
	54	<name>solicitor_id</name>
	55	<table>civicrm_contact</table>
	56	<key>id</key>
	57	<add>1.4</add>
6a488035 TO	58	<drop>2.2</drop>
6a488035 TO	59	<onDelete>SET NULL</onDelete>
6d68a4cb CW	60	</foreignKey>
	61	<field>
	62	<name>contribution_type_id</name>
6a488035 TO	63	<title>Contribution Type</title>
	64	<export>false</export>
	65	<type>int unsigned</type>
	66	<comment>FK to Contribution Type</comment>
6d68a4cb CW	67	<add>1.3</add>
	68	<drop>4.3</drop>
	69	</field>
	70	<foreignKey>
	71	<name>contribution_type_id</name>
	72	<table>civicrm_contribution_type</table>
	73	<key>id</key>
	74	<add>1.3</add>
	75	<drop>4.3</drop>
6a488035	76	<onDelete>SET NULL</onDelete>
6d68a4cb CW	77	</foreignKey>
6d68a4cb CW	78	<field>
6a488035	79	<name>financial_type_id</name>
bed339f2	80	<title>Financial Type</title>
6a488035 TO	81	<type>int unsigned</type>
6a488035 TO	82	<comment>FK to Financial Type for (total_amount - non_deductible_amount).</comment>
6d68a4cb CW	83	<pseudoconstant>
	84	<table>civicrm_financial_type</table>
	85	<keyColumn>id</keyColumn>
	86	<labelColumn>name</labelColumn>
	87	</pseudoconstant>
3123273f	88	<export>true</export>
614d72ec	89	<html>
e0991796	90	<type>Select</type>
614d72ec	91	</html>
6a488035	92	<add>4.3</add>
6d68a4cb CW	93	</field>
	94	<foreignKey>
	95	<name>financial_type_id</name>
	96	<table>civicrm_financial_type</table>
	97	<key>id</key>
	98	<add>4.3</add>
	99	</foreignKey>
	100	<field>
	101	<name>contribution_page_id</name>
3c151c70	102	<title>Contribution Page ID</title>
6a488035 TO	103	<type>int unsigned</type>
6a488035 TO	104	<import>true</import>
6d68a4cb CW	105	<comment>The Contribution Page which triggered this contribution</comment>
	106	<pseudoconstant>
	107	<table>civicrm_contribution_page</table>
	108	<keyColumn>id</keyColumn>
	109	<labelColumn>title</labelColumn>
	110	</pseudoconstant>
614d72ec	111	<html>
e0991796	112	<type>Select</type>
614d72ec	113	</html>
6d68a4cb CW	114	<add>1.5</add>
	115	</field>
	116	<foreignKey>
	117	<name>contribution_page_id</name>
	118	<table>civicrm_contribution_page</table>
	119	<key>id</key>
6a488035 TO	120	<onDelete>SET NULL</onDelete>
6a488035 TO	121	</foreignKey>
6d68a4cb	122	<field>
6a488035	123	<name>payment_instrument_id</name>
8fb22579	124	<uniqueName>payment_instrument_id</uniqueName>
9d5c7f14	125	<title>Payment Method ID</title>
6a488035 TO	126	<type>int unsigned</type>
6a488035 TO	127	<comment>FK to Payment Instrument</comment>
9d5c7f14	128	<export>true</export>
9d5c7f14	129	<headerPattern>/^payment\|(p(ayment\s)?instrument)$/i</headerPattern>
6a488035	130	<pseudoconstant>
6d68a4cb	131	<optionGroupName>payment_instrument</optionGroupName>
6a488035	132	</pseudoconstant>
614d72ec	133	<html>
e0991796	134	<type>Select</type>
614d72ec	135	</html>
6a488035	136	<add>1.3</add>
6d68a4cb	137	</field>
6a488035 TO	138	<index>
6a488035 TO	139	<name>UI_contrib_payment_instrument_id</name>
6d68a4cb	140	<fieldName>payment_instrument_id</fieldName>
6a488035	141	<add>1.6</add>
6d68a4cb CW	142	</index>
	143	<field>
	144	<name>receive_date</name>
7bc6b5bb	145	<title>Date Received</title>
6d68a4cb	146	<type>datetime</type>
6a488035 TO	147	<import>true</import>
	148	<headerPattern>/receive(.?date)?/i</headerPattern>
	149	<dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
7bc6b5bb	150	<comment>Date contribution was received - not necessarily the creation date of the record</comment>
6d68a4cb	151	<add>1.3</add>
614d72ec	152	<html>
614d72ec	153	<type>Select Date</type>
24317d89	154	<formatType>activityDateTime</formatType>
614d72ec	155	</html>
6d68a4cb CW	156	</field>
	157	<field>
	158	<name>non_deductible_amount</name>
6a488035 TO	159	<title>Non-deductible Amount</title>
	160	<type>decimal</type>
	161	<default>0</default>
	162	<import>true</import>
	163	<headerPattern>/non?.?deduct/i</headerPattern>
	164	<dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
6d68a4cb CW	165	<comment>Portion of total amount which is NOT tax deductible. Equal to total_amount for non-deductible financial types.</comment>
6d68a4cb CW	166	<add>1.3</add>
614d72ec	167	<html>
	168	<type>Text</type>
	169	</html>
6a488035	170	</field>
6d68a4cb CW	171	<field>
	172	<name>total_amount</name>
	173	<type>decimal</type>
6a488035 TO	174	<required>true</required>
	175	<import>true</import>
	176	<headerPattern>/^total\|(.?^am(ou)?nt)/i</headerPattern>
	177	<dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
6d68a4cb CW	178	<comment>Total amount of this contribution. Use market value for non-monetary gifts.</comment>
6d68a4cb CW	179	<add>1.3</add>
614d72ec	180	<html>
	181	<type>Text</type>
	182	</html>
6a488035	183	</field>
378bbe51	184	<index>
	185	<name>index_total_amount_receive_date</name>
	186	<fieldName>total_amount</fieldName>
	187	<fieldName>receive_date</fieldName>
	188	<add>4.7</add>
	189	</index>
6d68a4cb CW	190	<field>
	191	<name>fee_amount</name>
	192	<type>decimal</type>
6a488035 TO	193	<import>true</import>
	194	<headerPattern>/fee(.?am(ou)?nt)?/i</headerPattern>
	195	<dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
	196	<comment>actual processor fee if known - may be 0.</comment>
6d68a4cb	197	<add>1.3</add>
614d72ec	198	<html>
	199	<type>Text</type>
	200	</html>
6d68a4cb CW	201	</field>
	202	<field>
	203	<name>net_amount</name>
	204	<type>decimal</type>
6a488035 TO	205	<import>true</import>
	206	<headerPattern>/net(.?am(ou)?nt)?/i</headerPattern>
	207	<dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
	208	<comment>actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.</comment>
6d68a4cb	209	<add>1.3</add>
614d72ec	210	<html>
	211	<type>Text</type>
	212	</html>
6a488035	213	</field>
6d68a4cb CW	214	<field>
6d68a4cb CW	215	<name>trxn_id</name>
6a488035	216	<title>Transaction ID</title>
6d68a4cb CW	217	<type>varchar</type>
6d68a4cb CW	218	<length>255</length>
6a488035 TO	219	<import>true</import>
	220	<headerPattern>/tr(ansactio\|x)n(.?id)?/i</headerPattern>
	221	<comment>unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method</comment>
614d72ec	222	<html>
	223	<type>Text</type>
	224	</html>
6d68a4cb CW	225	<add>1.3</add>
	226	</field>
	227	<field>
	228	<name>invoice_id</name>
9cad3ff4	229	<title>Invoice Reference</title>
6d68a4cb CW	230	<type>varchar</type>
6d68a4cb CW	231	<length>255</length>
6a488035 TO	232	<import>true</import>
	233	<headerPattern>/invoice(.?id)?/i</headerPattern>
	234	<comment>unique invoice id, system generated or passed in</comment>
614d72ec	235	<html>
614d72ec	236	<type>Text</type>
b05e6d0d	237	</html>
6d68a4cb	238	<add>1.3</add>
9cad3ff4 CW	239	</field>
	240	<field>
	241	<name>invoice_number</name>
	242	<title>Invoice Number</title>
	243	<type>varchar</type>
	244	<length>255</length>
	245	<import>true</import>
	246	<headerPattern>/invoice(.?number)?/i</headerPattern>
	247	<comment>Human readable invoice number</comment>
	248	<html>
	249	<type>Text</type>
	250	</html>
	251	<add>4.7</add>
	252	</field>
6d68a4cb CW	253	<field>
	254	<name>currency</name>
	255	<type>varchar</type>
6a488035 TO	256	<length>3</length>
	257	<default>NULL</default>
	258	<import>true</import>
	259	<headerPattern>/cur(rency)?/i</headerPattern>
	260	<dataPattern>/^[A-Z]{3}$/i</dataPattern>
	261	<comment>3 character string, value from config setting or input via user.</comment>
bd44e0df AS	262	<add>1.3</add>
	263	<pseudoconstant>
	264	<table>civicrm_currency</table>
	265	<keyColumn>name</keyColumn>
a38a89fc	266	<labelColumn>full_name</labelColumn>
c3de5c5a	267	<nameColumn>name</nameColumn>
bd44e0df	268	</pseudoconstant>
614d72ec	269	<html>
e0991796	270	<type>Select</type>
614d72ec	271	</html>
6d68a4cb CW	272	</field>
	273	<field>
	274	<name>cancel_date</name>
	275	<type>datetime</type>
6a488035 TO	276	<import>true</import>
	277	<headerPattern>/cancel(.?date)?/i</headerPattern>
	278	<dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
6d68a4cb CW	279	<comment>when was gift cancelled</comment>
6d68a4cb CW	280	<add>1.3</add>
614d72ec	281	<html>
614d72ec	282	<type>Select Date</type>
24317d89	283	<formatType>activityDateTime</formatType>
614d72ec	284	</html>
6d68a4cb CW	285	</field>
	286	<field>
	287	<name>cancel_reason</name>
	288	<type>text</type>
6a488035 TO	289	<import>true</import>
6a488035 TO	290	<headerPattern>/(cancel.?)?reason/i</headerPattern>
614d72ec	291	<html>
	292	<type>Text</type>
	293	</html>
b05e6d0d	294	<add>1.3</add>
6d68a4cb CW	295	</field>
	296	<field>
	297	<name>receipt_date</name>
	298	<type>datetime</type>
6a488035 TO	299	<import>true</import>
	300	<headerPattern>/receipt(.?date)?/i</headerPattern>
	301	<dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
	302	<comment>when (if) receipt was sent. populated automatically for online donations w/ automatic receipting</comment>
614d72ec	303	<html>
614d72ec	304	<type>Select Date</type>
24317d89	305	<formatType>activityDateTime</formatType>
614d72ec	306	</html>
b05e6d0d	307	<add>1.3</add>
6d68a4cb CW	308	</field>
6d68a4cb CW	309	<field>
6a488035 TO	310	<name>thankyou_date</name>
6a488035 TO	311	<title>Thank-you Date</title>
6d68a4cb	312	<type>datetime</type>
6a488035 TO	313	<import>true</import>
	314	<headerPattern>/thank(s\|(.?you))?(.?date)?/i</headerPattern>
	315	<dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
6d68a4cb CW	316	<comment>when (if) was donor thanked</comment>
6d68a4cb CW	317	<add>1.3</add>
614d72ec	318	<html>
614d72ec	319	<type>Select Date</type>
24317d89	320	<formatType>activityDateTime</formatType>
614d72ec	321	</html>
6d68a4cb CW	322	</field>
6d68a4cb CW	323	<field>
6a488035 TO	324	<name>source</name>
	325	<uniqueName>contribution_source</uniqueName>
	326	<title>Contribution Source</title>
6d68a4cb	327	<type>varchar</type>
6a488035 TO	328	<length>255</length>
	329	<import>true</import>
	330	<headerPattern>/source/i</headerPattern>
6d68a4cb CW	331	<comment>Origin of this Contribution.</comment>
6d68a4cb CW	332	<add>1.3</add>
614d72ec	333	<html>
	334	<type>Text</type>
	335	</html>
6d68a4cb	336	</field>
3fe26f4c	337	<index>
	338	<name>index_source</name>
	339	<fieldName>source</fieldName>
	340	<add>4.7</add>
	341	</index>
6d68a4cb	342	<field>
6a488035 TO	343	<name>amount_level</name>
6a488035 TO	344	<title>Amount Label</title>
6d68a4cb	345	<type>text</type>
6a488035	346	<import>true</import>
6d68a4cb	347	<add>1.7</add>
614d72ec	348	<html>
	349	<type>Text</type>
	350	</html>
6d68a4cb	351	</field>
6a488035 TO	352	<field>
	353	<name>note</name>
	354	<type>text</type>
	355	<comment>Note and/or Comment.</comment>
6a488035 TO	356	<import>true</import>
	357	<headerPattern>/Note\|Comment/i</headerPattern>
	358	<dataPattern>//</dataPattern>
	359	<add>1.4</add>
	360	<drop>1.7</drop>
	361	</field>
	362	<index>
	363	<name>UI_contrib_trxn_id</name>
	364	<fieldName>trxn_id</fieldName>
	365	<unique>true</unique>
	366	<add>2.1</add>
	367	</index>
	368	<index>
	369	<name>UI_contrib_invoice_id</name>
	370	<fieldName>invoice_id</fieldName>
	371	<unique>true</unique>
	372	<add>2.1</add>
	373	</index>
6d68a4cb CW	374	<field>
6d68a4cb CW	375	<name>contribution_recur_id</name>
b05e6d0d	376	<title>Recurring Contribution ID</title>
6d68a4cb CW	377	<type>int unsigned</type>
6d68a4cb CW	378	<comment>Conditional foreign key to civicrm_contribution_recur id. Each contribution made in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.</comment>
3123273f	379	<export>true</export>
6d68a4cb CW	380	<add>1.4</add>
	381	</field>
	382	<foreignKey>
	383	<name>contribution_recur_id</name>
	384	<table>civicrm_contribution_recur</table>
	385	<key>id</key>
	386	<add>1.4</add>
6a488035 TO	387	<onDelete>SET NULL</onDelete>
6a488035 TO	388	</foreignKey>
6d68a4cb CW	389	<field>
6d68a4cb CW	390	<name>is_test</name>
6a488035 TO	391	<title>Test</title>
	392	<type>boolean</type>
	393	<default>0</default>
	394	<import>true</import>
614d72ec	395	<html>
	396	<type>CheckBox</type>
	397	</html>
6a488035	398	</field>
6d68a4cb CW	399	<field>
6d68a4cb CW	400	<name>is_pay_later</name>
6a488035 TO	401	<title>Is Pay Later</title>
	402	<type>boolean</type>
	403	<default>0</default>
	404	<import>true</import>
6d68a4cb	405	<add>2.1</add>
614d72ec	406	<html>
	407	<type>CheckBox</type>
	408	</html>
6a488035 TO	409	</field>
	410	<field>
	411	<name>contribution_status_id</name>
3c151c70	412	<title>Contribution Status ID</title>
6a488035 TO	413	<type>int unsigned</type>
	414	<default>1</default>
	415	<import>true</import>
	416	<export>true</export>
	417	<headerPattern>/status/i</headerPattern>
6d68a4cb CW	418	<pseudoconstant>
	419	<optionGroupName>contribution_status</optionGroupName>
	420	</pseudoconstant>
614d72ec	421	<html>
e0991796	422	<type>Select</type>
614d72ec	423	</html>
6a488035 TO	424	<add>1.6</add>
6a488035 TO	425	</field>
6a488035 TO	426	<index>
	427	<name>index_contribution_status</name>
	428	<fieldName>contribution_status_id</fieldName>
	429	<add>1.6</add>
	430	</index>
	431	<index>
	432	<name>received_date</name>
	433	<fieldName>receive_date</fieldName>
	434	<add>1.6</add>
	435	</index>
6d68a4cb CW	436	<field>
6d68a4cb CW	437	<name>address_id</name>
3123273f	438	<uniqueName>contribution_address_id</uniqueName>
455cfd16	439	<title>Contribution Address</title>
6d68a4cb CW	440	<type>int unsigned</type>
	441	<comment>Conditional foreign key to civicrm_address.id. We insert an address record for each contribution when we have associated billing name and address data.</comment>
	442	<add>2.2</add>
3123273f	443	<export>true</export>
6d68a4cb CW	444	</field>
	445	<foreignKey>
	446	<name>address_id</name>
	447	<table>civicrm_address</table>
	448	<key>id</key>
	449	<add>2.2</add>
6a488035 TO	450	<onDelete>SET NULL</onDelete>
6a488035 TO	451	</foreignKey>
6d68a4cb CW	452	<field>
6d68a4cb CW	453	<name>check_number</name>
6a488035	454	<title>Check Number</title>
7bc1d4da	455	<uniqueName>contribution_check_number</uniqueName>
6a488035	456	<headerPattern>/check(.?number)?/i</headerPattern>
6d68a4cb	457	<type>varchar</type>
6a488035	458	<length>255</length>
614d72ec	459	<html>
614d72ec	460	<type>Text</type>
54f5e87f	461	<size>6</size>
614d72ec	462	</html>
6a488035	463	<import>true</import>
6d68a4cb CW	464	<add>2.2</add>
6d68a4cb CW	465	</field>
6a488035 TO	466	<index>
	467	<name>check_number</name>
	468	<fieldName>check_number</fieldName>
	469	<add>2.2</add>
	470	</index>
6d68a4cb	471	<field>
6a488035 TO	472	<name>campaign_id</name>
	473	<uniqueName>contribution_campaign_id</uniqueName>
	474	<type>int unsigned</type>
e1ab2e91	475	<title>Campaign</title>
6d68a4cb CW	476	<import>true</import>
6d68a4cb CW	477	<comment>The campaign for which this contribution has been triggered.</comment>
3e3eacd0 CW	478	<pseudoconstant>
	479	<table>civicrm_campaign</table>
	480	<keyColumn>id</keyColumn>
	481	<labelColumn>title</labelColumn>
3e3eacd0	482	</pseudoconstant>
6d68a4cb	483	<add>3.4</add>
614d72ec	484	<html>
	485	<type>Select</type>
	486	</html>
6d68a4cb	487	</field>
933c5f44	488	<field>
	489	<name>creditnote_id</name>
	490	<title>Credit Note ID</title>
	491	<type>varchar</type>
	492	<length>255</length>
	493	<import>true</import>
	494	<headerPattern>/creditnote(.?id)?/i</headerPattern>
	495	<comment>unique credit note id, system generated or passed in</comment>
115fa278	496	<add>4.6</add>
933c5f44	497	<html>
	498	<type>Text</type>
	499	</html>
	500	</field>
8ca47f5c	501	<index>
d9fab10f	502	<name>index_creditnote_id</name>
8ca47f5c	503	<fieldName>creditnote_id</fieldName>
	504	<add>4.7</add>
	505	</index>
d91b8b33	506	<field>
d91b8b33	507	<name>tax_amount</name>
115fa278	508	<title>Tax Amount</title>
d91b8b33	509	<type>decimal</type>
	510	<import>true</import>
	511	<headerPattern>/tax(.?am(ou)?nt)?/i</headerPattern>
	512	<dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
	513	<comment>Total tax amount of this contribution.</comment>
115fa278	514	<add>4.6</add>
d91b8b33	515	<html>
	516	<type>Text</type>
	517	</html>
	518	</field>
6d68a4cb CW	519	<foreignKey>
	520	<name>campaign_id</name>
	521	<table>civicrm_campaign</table>
	522	<key>id</key>
6a488035 TO	523	<onDelete>SET NULL</onDelete>
6a488035 TO	524	</foreignKey>
fb89c341 PN	525	<field>
	526	<name>revenue_recognition_date</name>
	527	<type>datetime</type>
	528	<import>true</import>
	529	<headerPattern>/revenue(.?date)?/i</headerPattern>
	530	<dataPattern>/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/</dataPattern>
	531	<comment>Stores the date when revenue should be recognized.</comment>
	532	<html>
	533	<type>Select Date</type>
24317d89	534	<formatType>activityDateTime</formatType>
fb89c341 PN	535	</html>
	536	<add>4.7</add>
	537	</field>
6a488035	538	</table>