Merge pull request #6574 from eileenmcnaughton/CRM-17070

[civicrm-core.git] / api / v3 / FinancialTrxn.php

diff --git a/api/v3/FinancialTrxn.php b/api/v3/FinancialTrxn.php
index f20f9815fb4f2c2bbc255498db9ea35ca2f4c59b..84b76b6794e39f8c77ca570f3c8764b6bb070afa 100644 (file)
--- a/api/v3/FinancialTrxn.php
+++ b/api/v3/FinancialTrxn.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -24,80 +23,60 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 financial_transaction functions
+ * This api exposes CiviCRM FinancialItem.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_FinancialTransation
- *
- * @copyright CiviCRM LLC (c) 2004-2013
- * @version $Id: FinancialTransation.php 2011-02-16 ErikHommel $
  */
 
 /**
- * Add an FinancialTransation for a contact
- *
- * Allowed @params array keys are:
+ * Save a Financial Item.
  *
- * @example FinancialTransationCreate.php Standard Create Example
+ * @param array $params
  *
- * @return array API result array
- * {@getfields financial_transaction_create}
- * @access public
+ * @return array
  */
-function civicrm_api3_financial_transaction_create($params) {
+function civicrm_api3_financial_trxn_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
-
 /**
- * @param $params
+ * Get a Financialtrxn.
+ *
+ * @param array $params
+ *
+ * @return array
+ *   Array of retrieved Financial trxn property values.
  */
-function _civicrm_api3_financial_transaction_create_spec(&$params) {
-  $params['trxn_date']['api.default'] = 'now';
-  $params['payment_instrument_id']['api.required'] = TRUE;
-  $params['total_amount']['api.required'] = TRUE;
-  $params['contribution_id']['api.required'] = TRUE;
-  $params['created_id']['api.default'] = 'user_contact_id';
-  $params['contribution_status_id'] = array('title' => 'Optional over-ride for status id');
-  $params['participant_status_id'] = array('title' => 'Optional Over-ride for participant id');
-  $params['send_receipt'] = array('title' =>  'Send a receipt using built in template (possible future would be to specify the template)');
+function civicrm_api3_financial_trxn_get($params) {
+  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
-
 /**
- * Deletes an existing FinancialTransation
- *
- * @param  array  $params
+ * Delete a Financial trxn.
  *
- * @example FinancialTransationDelete.php Standard Delete Example
+ * @param array $params
  *
- * @return boolean | error  true if successfull, error otherwise
- * {@getfields financial_transaction_delete}
- * @access public
+ * @return array
+ *   Array of deleted values.
  */
-function civicrm_api3_financial_transaction_delete($params) {
-  //return 'go away - you can't delete transactions';
+function civicrm_api3_financial_trxn_delete($params) {
+  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Retrieve one or more financial_transactions
- *
- * @param  array input parameters
- *
+ * Adjust Metadata for Create action.
  *
- * @example FinancialTransationGet.php Standard Get Example
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * @param  array $params  an associative array of name/value pairs.
- *
- * @return  array api result array
- * {@getfields financial_transaction_get}
- * @access public
+ * @param array $params
+ * Array of parameters determined by getfields.
  */
-function civicrm_api3_financial_transaction_get($params) {
-
-  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+function _civicrm_api3_financial_trxn_create_spec(&$params) {
+  $params['to_financial_account_id']['api.required'] = 1;
+  $params['status_id']['api.required'] = 1;
+  $params['payment_instrument_id']['api.required'] = 1;
+  $params['total_amount']['api.required'] = 1;
 }
-