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