1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
4 <base>CRM/Financial
</base>
5 <class>FinancialTrxn
</class>
6 <name>civicrm_financial_trxn
</name>
9 <component>CiviContribute
</component>
12 <title>Financial Transaction ID
</title>
13 <type>int unsigned
</type>
14 <required>true
</required>
22 <autoincrement>true
</autoincrement>
25 <name>from_financial_account_id
</name>
26 <type>int unsigned
</type>
27 <title>From Account ID
</title>
28 <comment>FK to financial_account table.
</comment>
31 <table>civicrm_financial_account
</table>
32 <keyColumn>id
</keyColumn>
33 <labelColumn>name
</labelColumn>
37 <label>From Account
</label>
41 <name>from_financial_account_id
</name>
42 <table>civicrm_financial_account
</table>
47 <name>to_financial_account_id
</name>
48 <title>To Account ID
</title>
49 <type>int unsigned
</type>
50 <comment>FK to financial_financial_account table.
</comment>
53 <table>civicrm_financial_account
</table>
54 <keyColumn>id
</keyColumn>
55 <labelColumn>name
</labelColumn>
59 <label>To Account
</label>
63 <name>to_financial_account_id
</name>
64 <table>civicrm_financial_account
</table>
69 <name>trxn_date
</name>
70 <title>Financial Transaction Date
</title>
72 <default>NULL
</default>
73 <comment>date transaction occurred
</comment>
76 <type>Select Date
</type>
77 <formatType>activityDateTime
</formatType>
81 <name>total_amount
</name>
82 <title>Financial Total Amount
</title>
84 <required>true
</required>
85 <comment>amount of transaction
</comment>
89 <name>fee_amount
</name>
90 <title>Financial Fee Amount
</title>
92 <comment>actual processor fee if known - may be
0.
</comment>
96 <name>net_amount
</name>
97 <title>Financial Net Amount
</title>
99 <comment>actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.
</comment>
103 <name>currency
</name>
104 <title>Financial Currency
</title>
107 <default>NULL
</default>
108 <import>true
</import>
109 <headerPattern>/cur(rency)?/i
</headerPattern>
110 <dataPattern>/^[A-Z]{
3}$/
</dataPattern>
111 <comment>3 character string, value from config setting or input via user.
</comment>
114 <table>civicrm_currency
</table>
115 <keyColumn>name
</keyColumn>
116 <labelColumn>full_name
</labelColumn>
117 <nameColumn>name
</nameColumn>
118 <abbrColumn>symbol
</abbrColumn>
125 <name>is_payment
</name>
126 <title>Is Payment?
</title>
129 <import>true
</import>
130 <comment>Is this entry either a payment or a reversal of a payment?
</comment>
135 <title>Transaction ID
</title>
138 <comment>Transaction id supplied by external processor. This may not be unique.
</comment>
146 <name>UI_ftrxn_trxn_id
</name>
147 <fieldName>trxn_id
</fieldName>
151 <name>trxn_result_code
</name>
152 <title>Transaction Result Code
</title>
155 <comment>processor result code
</comment>
159 <name>status_id
</name>
160 <title>Financial Transaction Status ID
</title>
161 <type>int unsigned
</type>
162 <import>true
</import>
163 <export>true
</export>
165 <optionGroupName>contribution_status
</optionGroupName>
167 <comment>pseudo FK to civicrm_option_value of contribution_status_id option_group
</comment>
168 <headerPattern>/status/i
</headerPattern>
172 <name>payment_processor_id
</name>
173 <title>Payment Processor ID
</title>
174 <type>int unsigned
</type>
175 <comment>Payment Processor for this financial transaction
</comment>
177 <table>civicrm_payment_processor
</table>
178 <keyColumn>id
</keyColumn>
179 <labelColumn>name
</labelColumn>
183 <label>Payment Processor
</label>
188 <name>payment_processor_id
</name>
189 <table>civicrm_payment_processor
</table>
191 <onDelete>SET NULL
</onDelete>
195 <name>payment_instrument_id
</name>
196 <uniqueName>financial_trxn_payment_instrument_id
</uniqueName>
197 <title>Payment Method
</title>
198 <type>int unsigned
</type>
199 <comment>FK to payment_instrument option group values
</comment>
201 <optionGroupName>payment_instrument
</optionGroupName>
209 <name>UI_ftrxn_payment_instrument_id
</name>
210 <fieldName>payment_instrument_id
</fieldName>
214 <name>card_type_id
</name>
215 <uniqueName>financial_trxn_card_type_id
</uniqueName>
216 <title>Card Type ID
</title>
217 <type>int unsigned
</type>
218 <comment>FK to accept_creditcard option group values
</comment>
220 <optionGroupName>accept_creditcard
</optionGroupName>
228 <name>check_number
</name>
229 <uniqueName>financial_trxn_check_number
</uniqueName>
230 <title>Check Number
</title>
231 <comment>Check number
</comment>
241 <name>UI_ftrxn_check_number
</name>
242 <fieldName>check_number
</fieldName>
246 <name>pan_truncation
</name>
247 <uniqueName>financial_trxn_pan_truncation
</uniqueName>
248 <title>PAN Truncation
</title>
255 <comment>Last
4 digits of credit card
</comment>
259 <name>order_reference
</name>
260 <uniqueName>financial_trxn_order_reference
</uniqueName>
261 <title>Order Reference
</title>
268 <comment>Payment Processor external order reference
</comment>