[civicrm-core.git] / xml / schema / Financial / FinancialItem.xml

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

<table>
  <base>CRM/Financial</base>
  <class>FinancialItem</class>
  <name>civicrm_financial_item</name>
  <add>4.3</add>
  <comment>Financial data for civicrm_line_item, etc.</comment>
  <log>true</log>
  <field>
    <name>id</name>
    <type>int unsigned</type>
    <title>Financial Item ID</title>
    <length>10</length>
    <required>true</required>
    <comment></comment>
    <add>4.3</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>created_date</name>
    <type>timestamp</type>
    <title>Financial Item Created Date</title>
    <required>true</required>
    <default>CURRENT_TIMESTAMP</default>
    <comment>Date and time the item was created</comment>
    <add>4.3</add>
  </field>
  <field>
    <name>transaction_date</name>
    <type>datetime</type>
    <title>Financial Item Transaction Date</title>
    <required>true</required>
    <comment>Date and time of the source transaction</comment>
    <add>4.3</add>
  </field>
  <field>
    <name>contact_id</name>
    <type>int unsigned</type>
    <title>Financial Item Contact ID</title>
    <required>true</required>
    <export>true</export>
    <comment>FK to Contact ID of contact the item is from</comment>
    <add>4.3</add>
  </field>
  <foreignKey>
    <name>contact_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <onDelete>CASCADE</onDelete>
    <add>4.3</add>
  </foreignKey>
  <field>
    <name>description</name>
    <type>varchar</type>
    <title>Financial Item Description</title>
    <length>255</length>
    <comment>Human readable description of this item, to ease display without lookup of source item.</comment>
    <add>4.3</add>
  </field>
  <field>
    <name>amount</name>
    <title>Amount</title>
    <type>decimal</type>
    <default>0</default>
    <required>true</required>
    <headerPattern>/unit?.?amoun/i</headerPattern>
    <dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
    <comment>Total amount of this item</comment>
    <add>4.3</add>
  </field>
  <field>
    <name>currency</name>
    <export>true</export>
    <type>varchar</type>
    <title>Financial Item Currency</title>
    <length>3</length>
    <comment>Currency for the amount</comment>
    <add>4.3</add>
    <pseudoconstant>
      <table>civicrm_currency</table>
      <keyColumn>name</keyColumn>
      <labelColumn>full_name</labelColumn>
      <nameColumn>name</nameColumn>
      <abbrColumn>symbol</abbrColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>financial_account_id</name>
    <type>int unsigned</type>
    <title>Financial Account ID</title>
    <comment>FK to civicrm_financial_account</comment>
    <add>4.3</add>
    <pseudoconstant>
      <table>civicrm_financial_account</table>
      <keyColumn>id</keyColumn>
      <labelColumn>name</labelColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <foreignKey>
    <name>financial_account_id</name>
    <table>civicrm_financial_account</table>
    <key>id</key>
    <add>4.3</add>
  </foreignKey>
  <field>
    <name>status_id</name>
    <export>true</export>
    <title>Financial Item Status ID</title>
    <type>int unsigned</type>
    <comment>Payment status: test, paid, part_paid, unpaid (if empty assume unpaid)</comment>
    <add>4.3</add>
    <pseudoconstant>
      <optionGroupName>financial_item_status</optionGroupName>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>entity_table</name>
    <type>varchar</type>
    <title>Entity Table</title>
    <length>64</length>
    <comment>The table providing the source of this item such as civicrm_line_item</comment>
    <add>4.3</add>
  </field>
  <field>
    <name>entity_id</name>
    <title>Entity ID</title>
    <type>int unsigned</type>
    <comment>The specific source item that is responsible for the creation of this financial_item</comment>
    <add>4.3</add>
  </field>
  <dynamicForeignKey>
    <idColumn>entity_id</idColumn>
    <typeColumn>entity_table</typeColumn>
    <add>4.3</add>
  </dynamicForeignKey>
  <index>
    <name>UI_id</name>
    <fieldName>id</fieldName>
    <unique>true</unique>
    <add>4.3</add>
    <drop>4.7</drop>
  </index>
  <index>
    <name>IX_created_date</name>
    <fieldName>created_date</fieldName>
    <add>4.3</add>
  </index>
  <index>
    <name>IX_transaction_date</name>
    <fieldName>transaction_date</fieldName>
    <add>4.3</add>
  </index>
  <index>
    <name>IX_entity</name>
    <fieldName>entity_table</fieldName>
    <fieldName>entity_id</fieldName>
    <add>4.3</add>
    <drop>4.7</drop>
  </index>
  <index>
    <name>index_entity_id_entity_table</name>
    <fieldName>entity_id</fieldName>
    <fieldName>entity_table</fieldName>
    <add>4.7</add>
  </index>
</table>
Commit	Line	Data
3c7d2158	1	<?xml version="1.0" encoding="iso-8859-1" ?>
6a488035	2
3c7d2158	3	<table>
	4	<base>CRM/Financial</base>
	5	<class>FinancialItem</class>
	6	<name>civicrm_financial_item</name>
	7	<add>4.3</add>
6a488035	8	<comment>Financial data for civicrm_line_item, etc.</comment>
3c7d2158	9	<log>true</log>
	10	<field>
	11	<name>id</name>
6a488035	12	<type>int unsigned</type>
e117e295	13	<title>Financial Item ID</title>
6a488035	14	<length>10</length>
3c7d2158	15	<required>true</required>
3c7d2158	16	<comment></comment>
6a488035	17	<add>4.3</add>
3c7d2158	18	</field>
	19	<primaryKey>
	20	<name>id</name>
	21	<autoincrement>true</autoincrement>
	22	</primaryKey>
6a488035 TO	23	<field>
	24	<name>created_date</name>
	25	<type>timestamp</type>
e117e295	26	<title>Financial Item Created Date</title>
3c7d2158	27	<required>true</required>
3c7d2158	28	<default>CURRENT_TIMESTAMP</default>
6a488035 TO	29	<comment>Date and time the item was created</comment>
6a488035 TO	30	<add>4.3</add>
3c7d2158	31	</field>
6a488035 TO	32	<field>
	33	<name>transaction_date</name>
	34	<type>datetime</type>
e117e295	35	<title>Financial Item Transaction Date</title>
3c7d2158	36	<required>true</required>
6a488035 TO	37	<comment>Date and time of the source transaction</comment>
6a488035 TO	38	<add>4.3</add>
3c7d2158	39	</field>
6a488035 TO	40	<field>
	41	<name>contact_id</name>
	42	<type>int unsigned</type>
e117e295	43	<title>Financial Item Contact ID</title>
3c7d2158	44	<required>true</required>
6a488035 TO	45	<export>true</export>
	46	<comment>FK to Contact ID of contact the item is from</comment>
	47	<add>4.3</add>
	48	</field>
	49	<foreignKey>
	50	<name>contact_id</name>
	51	<table>civicrm_contact</table>
	52	<key>id</key>
	53	<onDelete>CASCADE</onDelete>
	54	<add>4.3</add>
	55	</foreignKey>
	56	<field>
	57	<name>description</name>
	58	<type>varchar</type>
e117e295	59	<title>Financial Item Description</title>
6a488035 TO	60	<length>255</length>
	61	<comment>Human readable description of this item, to ease display without lookup of source item.</comment>
	62	<add>4.3</add>
	63	</field>
3c7d2158	64	<field>
3c7d2158	65	<name>amount</name>
6a488035 TO	66	<title>Amount</title>
	67	<type>decimal</type>
	68	<default>0</default>
3c7d2158	69	<required>true</required>
6a488035 TO	70	<headerPattern>/unit?.?amoun/i</headerPattern>
6a488035 TO	71	<dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
3c7d2158	72	<comment>Total amount of this item</comment>
3c7d2158	73	<add>4.3</add>
6a488035	74	</field>
3c7d2158	75	<field>
6a488035 TO	76	<name>currency</name>
	77	<export>true</export>
	78	<type>varchar</type>
e117e295	79	<title>Financial Item Currency</title>
6a488035 TO	80	<length>3</length>
	81	<comment>Currency for the amount</comment>
	82	<add>4.3</add>
bd44e0df AS	83	<pseudoconstant>
	84	<table>civicrm_currency</table>
	85	<keyColumn>name</keyColumn>
a38a89fc	86	<labelColumn>full_name</labelColumn>
c3de5c5a	87	<nameColumn>name</nameColumn>
a8fdb24e	88	<abbrColumn>symbol</abbrColumn>
bd44e0df	89	</pseudoconstant>
614d72ec	90	<html>
e0991796	91	<type>Select</type>
614d72ec	92	</html>
6a488035 TO	93	</field>
	94	<field>
	95	<name>financial_account_id</name>
	96	<type>int unsigned</type>
e117e295	97	<title>Financial Account ID</title>
6a488035 TO	98	<comment>FK to civicrm_financial_account</comment>
6a488035 TO	99	<add>4.3</add>
7611ae71 AS	100	<pseudoconstant>
	101	<table>civicrm_financial_account</table>
	102	<keyColumn>id</keyColumn>
	103	<labelColumn>name</labelColumn>
	104	</pseudoconstant>
614d72ec	105	<html>
e0991796	106	<type>Select</type>
614d72ec	107	</html>
6a488035 TO	108	</field>
	109	<foreignKey>
	110	<name>financial_account_id</name>
	111	<table>civicrm_financial_account</table>
	112	<key>id</key>
	113	<add>4.3</add>
	114	</foreignKey>
	115	<field>
	116	<name>status_id</name>
	117	<export>true</export>
e117e295	118	<title>Financial Item Status ID</title>
6a488035 TO	119	<type>int unsigned</type>
	120	<comment>Payment status: test, paid, part_paid, unpaid (if empty assume unpaid)</comment>
	121	<add>4.3</add>
7611ae71 AS	122	<pseudoconstant>
	123	<optionGroupName>financial_item_status</optionGroupName>
	124	</pseudoconstant>
614d72ec	125	<html>
e0991796	126	<type>Select</type>
614d72ec	127	</html>
6a488035 TO	128	</field>
	129	<field>
	130	<name>entity_table</name>
	131	<type>varchar</type>
e117e295	132	<title>Entity Table</title>
6a488035 TO	133	<length>64</length>
	134	<comment>The table providing the source of this item such as civicrm_line_item</comment>
	135	<add>4.3</add>
	136	</field>
	137	<field>
	138	<name>entity_id</name>
e117e295	139	<title>Entity ID</title>
6a488035 TO	140	<type>int unsigned</type>
	141	<comment>The specific source item that is responsible for the creation of this financial_item</comment>
	142	<add>4.3</add>
	143	</field>
71e5aa5c ARW	144	<dynamicForeignKey>
	145	<idColumn>entity_id</idColumn>
	146	<typeColumn>entity_table</typeColumn>
	147	<add>4.3</add>
	148	</dynamicForeignKey>
6a488035 TO	149	<index>
	150	<name>UI_id</name>
	151	<fieldName>id</fieldName>
	152	<unique>true</unique>
	153	<add>4.3</add>
2179c899	154	<drop>4.7</drop>
6a488035 TO	155	</index>
	156	<index>
	157	<name>IX_created_date</name>
	158	<fieldName>created_date</fieldName>
	159	<add>4.3</add>
	160	</index>
	161	<index>
	162	<name>IX_transaction_date</name>
	163	<fieldName>transaction_date</fieldName>
	164	<add>4.3</add>
	165	</index>
	166	<index>
	167	<name>IX_entity</name>
	168	<fieldName>entity_table</fieldName>
	169	<fieldName>entity_id</fieldName>
	170	<add>4.3</add>
2179c899	171	<drop>4.7</drop>
6a488035 TO	172	</index>
6a488035 TO	173	<index>
2179c899	174	<name>index_entity_id_entity_table</name>
6a488035	175	<fieldName>entity_id</fieldName>
2179c899	176	<fieldName>entity_table</fieldName>
2179c899	177	<add>4.7</add>
6a488035 TO	178	</index>
6a488035 TO	179	</table>