Merge pull request #814 from eileenmcnaughton/CRM-12642

[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>
    <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>
    <export>false</export>
    <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>
    <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</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>
    <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>contribution_payment_instrument_id</uniqueName>
    <title>Payment Instrument</title>
    <type>int unsigned</type>
    <comment>FK to Payment Instrument</comment>
    <pseudoconstant>
      <optionGroupName>payment_instrument</optionGroupName>
    </pseudoconstant>
    <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>
    <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>when was gift received</comment>
    <add>1.3</add>
  </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>
  </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>
  </field>
  <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>
  </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>
  </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>
    <add>1.3</add>
  </field>
  <field>
    <name>invoice_id</name>
    <title>Invoice ID</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>
    <add>1.3</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>symbol</labelColumn>
    </pseudoconstant>
  </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>
  </field>
  <field>
    <name>cancel_reason</name>
    <type>text</type>
    <import>true</import>
    <headerPattern>/(cancel.?)?reason/i</headerPattern>
    <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>
    <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>
  </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>
  </field>
  <field>
    <name>amount_level</name>
    <title>Amount Label</title>
    <type>text</type>
    <import>true</import>
    <add>1.7</add>
  </field>
  <field>
    <name>note</name>
    <type>text</type>
    <comment>Note and/or Comment.</comment>
    <htmlType>textarea</htmlType>
    <rows>4</rows>
    <cols>80</cols>
    <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>
    <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>
    <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>honor_contact_id</name>
    <title>Honor Contact</title>
    <type>int unsigned</type>
    <comment>FK to contact ID</comment>
    <add>1.3</add>
  </field>
  <foreignKey>
    <name>honor_contact_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>1.6</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>is_test</name>
    <title>Test</title>
    <type>boolean</type>
    <default>0</default>
    <import>true</import>
  </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>
  </field>
  <field>
    <name>contribution_status_id</name>
    <title>Contribution Status</title>
    <type>int unsigned</type>
    <default>1</default>
    <import>true</import>
    <export>true</export>
    <headerPattern>/status/i</headerPattern>
    <pseudoconstant>
      <optionGroupName>contribution_status</optionGroupName>
    </pseudoconstant>
    <add>1.6</add>
  </field>
  <field>
    <name>honor_type_id</name>
    <title>Honor Type</title>
    <type>int unsigned</type>
    <comment>Implicit FK to civicrm_option_value.</comment>
    <add>2.0</add>
    <onDelete>SET NULL</onDelete>
    <pseudoconstant>
      <optionGroupName>honor_type</optionGroupName>
    </pseudoconstant>
  </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>
    <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>
  </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>
    <headerPattern>/check(.?number)?/i</headerPattern>
    <type>varchar</type>
    <length>255</length>
    <size>SIX</size>
    <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 ID</title>
    <import>true</import>
    <comment>The campaign for which this contribution has been triggered.</comment>
    <add>3.4</add>
  </field>
  <foreignKey>
    <name>campaign_id</name>
    <table>civicrm_campaign</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
</table>