From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Tue, 5 May 2015 03:57:46 +0000 (+1200)
Subject: CRM-16543 add finanical item api
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=e117e295b2aeaa255ab4dbf41e15e6cb61998d65;p=civicrm-core.git

CRM-16543 add finanical item api
---

diff --git a/api/v3/FinancialItem.php b/api/v3/FinancialItem.php
new file mode 100644
index 0000000000..4fbb63bbc9
--- /dev/null
+++ b/api/v3/FinancialItem.php
@@ -0,0 +1,67 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.6                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * This api exposes CiviCRM FinancialItem.
+ *
+ * @package CiviCRM_APIv3
+ */
+
+/**
+ * Save a Financial Item.
+ *
+ * @param array $params
+ *
+ * @return array
+ */
+function civicrm_api3_financial_item_create($params) {
+  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
+
+/**
+ * Get a FinancialItem.
+ *
+ * @param array $params
+ *
+ * @return array
+ *   Array of retrieved Financial Item property values.
+ */
+function civicrm_api3_financial_item_get($params) {
+  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
+
+/**
+ * Delete a Financial Item.
+ *
+ * @param array $params
+ *
+ * @return array
+ *   Array of deleted values.
+ */
+function civicrm_api3_financial_item_delete($params) {
+  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
diff --git a/xml/schema/Financial/FinancialItem.xml b/xml/schema/Financial/FinancialItem.xml
index 39ea7b3b60..0af6ec7f19 100644
--- a/xml/schema/Financial/FinancialItem.xml
+++ b/xml/schema/Financial/FinancialItem.xml
@@ -10,6 +10,7 @@
   <field>
     <name>id</name>
     <type>int unsigned</type>
+    <title>Financial Item ID</title>
     <length>10</length>
     <required>true</required>
     <comment></comment>
@@ -22,6 +23,7 @@
   <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>
@@ -30,6 +32,7 @@
   <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>
@@ -37,6 +40,7 @@
   <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>
@@ -52,6 +56,7 @@
   <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>
@@ -71,6 +76,7 @@
     <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>
@@ -87,6 +93,7 @@
   <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>
@@ -107,6 +114,7 @@
   <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>
@@ -120,12 +128,14 @@
   <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>