xml/schema/Financial/FinancialTrxn.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Financial</base>
   5   <class>FinancialTrxn</class>
   6   <name>civicrm_financial_trxn</name>
   7   <add>1.3</add>
   8   <log>true</log>
   9   <field>
  10     <name>id</name>
  11     <title>Financial Transaction ID</title>
  12     <type>int unsigned</type>
  13     <required>true</required>
  14     <add>1.3</add>
  15   </field>
  16   <primaryKey>
  17     <name>id</name>
  18     <autoincrement>true</autoincrement>
  19   </primaryKey>
  20   <field>
  21     <name>from_account_id</name>
  22     <type>int unsigned</type>
  23     <comment>FK to financial_account table.</comment>
  24     <add>3.2</add>
  25     <drop>4.3</drop>
  26   </field>
  27   <foreignKey>
  28     <name>from_account_id</name>
  29     <table>civicrm_financial_account</table>
  30     <key>id</key>
  31     <add>3.2</add>
  32     <drop>4.3</drop>
  33   </foreignKey>
  34   <field>
  35     <name>to_account_id</name>
  36     <type>int unsigned</type>
  37     <comment>FK to financial_account table.</comment>
  38     <add>3.2</add>
  39     <drop>4.3</drop>
  40   </field>
  41   <foreignKey>
  42     <name>to_account_id</name>
  43     <table>civicrm_financial_account</table>
  44     <key>id</key>
  45     <add>3.2</add>
  46     <drop>4.3</drop>
  47   </foreignKey>
  48   <field>
  49     <name>from_financial_account_id</name>
  50     <type>int unsigned</type>
  51     <title>Financial Transaction From Account</title>
  52     <comment>FK to financial_account table.</comment>
  53     <add>4.3</add>
  54     <pseudoconstant>
  55       <table>civicrm_financial_account</table>
  56       <keyColumn>id</keyColumn>
  57       <labelColumn>name</labelColumn>
  58     </pseudoconstant>
  59     <html>
  60       <type>Select</type>
  61     </html>
  62   </field>
  63   <foreignKey>
  64     <name>from_financial_account_id</name>
  65     <table>civicrm_financial_account</table>
  66     <key>id</key>
  67     <add>4.3</add>
  68   </foreignKey>
  69   <field>
  70     <name>to_financial_account_id</name>
  71     <title>Financial Transaction To Account</title>
  72     <type>int unsigned</type>
  73     <comment>FK to financial_financial_account table.</comment>
  74     <add>4.3</add>
  75     <pseudoconstant>
  76       <table>civicrm_financial_account</table>
  77       <keyColumn>id</keyColumn>
  78       <labelColumn>name</labelColumn>
  79     </pseudoconstant>
  80     <html>
  81       <type>Select</type>
  82     </html>
  83   </field>
  84   <foreignKey>
  85     <name>to_financial_account_id</name>
  86     <table>civicrm_financial_account</table>
  87     <key>id</key>
  88     <add>4.3</add>
  89   </foreignKey>
  90   <field>
  91     <name>trxn_date</name>
  92     <title>Financial Transaction Date</title>
  93     <type>datetime</type>
  94     <default>NULL</default>
  95     <comment>date transaction occurred</comment>
  96     <add>1.3</add>
  97     <html>
  98       <type>Select Date</type>
  99       <formatType>activityDateTime</formatType>
 100     </html>
 101   </field>
 102   <field>
 103     <name>trxn_type</name>
 104     <title>Financial Transaction Type</title>
 105     <type>enum</type>
 106     <values>Debit,Credit</values>
 107     <required>true</required>
 108     <add>1.3</add>
 109     <drop>4.3</drop>
 110   </field>
 111   <field>
 112     <name>total_amount</name>
 113     <title>Financial Total Amount</title>
 114     <type>decimal</type>
 115     <required>true</required>
 116     <comment>amount of transaction</comment>
 117     <add>1.3</add>
 118   </field>
 119   <field>
 120     <name>fee_amount</name>
 121     <title>Financial Fee Amount</title>
 122     <type>decimal</type>
 123     <comment>actual processor fee if known - may be 0.</comment>
 124     <add>1.3</add>
 125   </field>
 126   <field>
 127     <name>net_amount</name>
 128     <title>Financial Net Amount</title>
 129     <type>decimal</type>
 130     <comment>actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.</comment>
 131     <add>1.3</add>
 132   </field>
 133   <field>
 134     <name>currency</name>
 135     <title>Financial Currency</title>
 136     <type>varchar</type>
 137     <length>3</length>
 138     <default>NULL</default>
 139     <import>true</import>
 140     <headerPattern>/cur(rency)?/i</headerPattern>
 141     <dataPattern>/^[A-Z]{3}$/</dataPattern>
 142     <comment>3 character string, value from config setting or input via user.</comment>
 143     <add>1.3</add>
 144     <pseudoconstant>
 145       <table>civicrm_currency</table>
 146       <keyColumn>name</keyColumn>
 147       <labelColumn>full_name</labelColumn>
 148       <nameColumn>name</nameColumn>
 149       <abbrColumn>symbol</abbrColumn>
 150     </pseudoconstant>
 151     <html>
 152       <type>Select</type>
 153     </html>
 154   </field>
 155   <field>
 156     <name>is_payment</name>
 157     <title>Is Payment?</title>
 158     <type>boolean</type>
 159     <default>0</default>
 160     <import>true</import>
 161     <comment>Is this entry either a payment or a reversal of a payment?</comment>
 162     <add>4.7</add>
 163   </field>
 164   <field>
 165     <name>payment_processor</name>
 166     <type>varchar</type>
 167     <length>64</length>
 168     <required>true</required>
 169     <comment>derived from Processor setting in civicrm.settings.php.</comment>
 170     <add>1.3</add>
 171     <drop>4.3</drop>
 172   </field>
 173   <field>
 174     <name>trxn_id</name>
 175     <title>Transaction ID</title>
 176     <type>varchar</type>
 177     <length>255</length>
 178     <comment>Transaction id supplied by external processor. This may not be unique.</comment>
 179     <html>
 180       <type>Text</type>
 181       <size>10</size>
 182     </html>
 183     <add>1.3</add>
 184   </field>
 185   <index>
 186     <name>UI_ftrxn_trxn_id</name>
 187     <fieldName>trxn_id</fieldName>
 188     <add>4.7</add>
 189   </index>
 190   <field>
 191     <name>trxn_result_code</name>
 192     <title>Transaction Result Code</title>
 193     <type>varchar</type>
 194     <length>255</length>
 195     <comment>processor result code</comment>
 196     <add>1.3</add>
 197   </field>
 198   <field>
 199     <name>status_id</name>
 200     <title>Financial Transaction Status Id</title>
 201     <type>int unsigned</type>
 202     <import>true</import>
 203     <export>true</export>
 204     <pseudoconstant>
 205       <optionGroupName>contribution_status</optionGroupName>
 206     </pseudoconstant>
 207     <comment>pseudo FK to civicrm_option_value of contribution_status_id option_group</comment>
 208     <headerPattern>/status/i</headerPattern>
 209     <add>4.3</add>
 210   </field>
 211   <field>
 212     <name>payment_processor_id</name>
 213     <title>Payment Processor</title>
 214     <type>int unsigned</type>
 215     <comment>Payment Processor for this financial transaction</comment>
 216     <add>4.3</add>
 217   </field>
 218   <foreignKey>
 219     <name>payment_processor_id</name>
 220     <table>civicrm_payment_processor</table>
 221     <key>id</key>
 222     <onDelete>SET NULL</onDelete>
 223     <add>4.3</add>
 224   </foreignKey>
 225   <field>
 226     <name>payment_instrument_id</name>
 227     <uniqueName>financial_trxn_payment_instrument_id</uniqueName>
 228     <title>Payment Method</title>
 229     <type>int unsigned</type>
 230     <comment>FK to payment_instrument option group values</comment>
 231     <pseudoconstant>
 232       <optionGroupName>payment_instrument</optionGroupName>
 233     </pseudoconstant>
 234     <html>
 235       <type>Select</type>
 236     </html>
 237     <add>4.3</add>
 238   </field>
 239   <index>
 240     <name>UI_ftrxn_payment_instrument_id</name>
 241     <fieldName>payment_instrument_id</fieldName>
 242     <add>4.3</add>
 243   </index>
 244   <field>
 245     <name>card_type_id</name>
 246     <uniqueName>financial_trxn_card_type_id</uniqueName>
 247     <title>Card Type ID</title>
 248     <type>int unsigned</type>
 249     <comment>FK to accept_creditcard option group values</comment>
 250     <pseudoconstant>
 251       <optionGroupName>accept_creditcard</optionGroupName>
 252     </pseudoconstant>
 253     <html>
 254       <type>Select</type>
 255     </html>
 256     <add>4.7</add>
 257   </field>
 258   <field>
 259     <name>check_number</name>
 260     <uniqueName>financial_trxn_check_number</uniqueName>
 261     <title>Check Number</title>
 262     <comment>Check number</comment>
 263     <type>varchar</type>
 264     <length>255</length>
 265     <html>
 266       <type>Text</type>
 267       <size>6</size>
 268     </html>
 269     <add>4.3</add>
 270   </field>
 271   <index>
 272     <name>UI_ftrxn_check_number</name>
 273     <fieldName>check_number</fieldName>
 274     <add>4.3</add>
 275   </index>
 276   <field>
 277     <name>pan_truncation</name>
 278     <uniqueName>financial_trxn_pan_truncation</uniqueName>
 279     <title>Pan Truncation</title>
 280     <type>varchar</type>
 281     <length>4</length>
 282     <html>
 283       <type>Text</type>
 284       <size>4</size>
 285     </html>
 286     <comment>Last 4 digits of credit card</comment>
 287     <add>4.7</add>
 288   </field>
 289 </table>