From 3fa7fbd2500ed6ffa9569d2b2a6e8aea4c66322e Mon Sep 17 00:00:00 2001
From: eileen <emcnaughton@wikimedia.org>
Date: Tue, 29 Dec 2020 14:22:18 +1300
Subject: [PATCH] Add v4 api for financial type, financial account

---
 Civi/Api4/FinancialAccount.php                | 32 +++++++++++++++
 Civi/Api4/FinancialType.php                   | 32 +++++++++++++++
 .../Financial/BAO/FinancialAccountTest.php    | 40 ++++++++++---------
 3 files changed, 86 insertions(+), 18 deletions(-)
 create mode 100644 Civi/Api4/FinancialAccount.php
 create mode 100644 Civi/Api4/FinancialType.php

diff --git a/Civi/Api4/FinancialAccount.php b/Civi/Api4/FinancialAccount.php
new file mode 100644
index 0000000000..53bb3af33f
--- /dev/null
+++ b/Civi/Api4/FinancialAccount.php
@@ -0,0 +1,32 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+namespace Civi\Api4;
+
+/**
+ * Financial Account entity.
+ *
+ * Financial accounts are used for bookkeeping entries.
+ *
+ * @see https://docs.civicrm.org/user/en/latest/contributions/key-concepts-and-configurations/#financial-types-financial-accounts-and-accounting-codes
+ *
+ * @package Civi\Api4
+ */
+class FinancialAccount extends Generic\DAOEntity {
+
+}
diff --git a/Civi/Api4/FinancialType.php b/Civi/Api4/FinancialType.php
new file mode 100644
index 0000000000..1c6bbaac94
--- /dev/null
+++ b/Civi/Api4/FinancialType.php
@@ -0,0 +1,32 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+namespace Civi\Api4;
+
+/**
+ * Financial Type entity.
+ *
+ * Financial types are used both for categorisation and bookkeeping entries.
+ *
+ * @see https://docs.civicrm.org/user/en/latest/contributions/key-concepts-and-configurations/#financial-types-financial-accounts-and-accounting-codes
+ *
+ * @package Civi\Api4
+ */
+class FinancialType extends Generic\DAOEntity {
+
+}
diff --git a/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php b/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php
index c2f7195b5e..e673b00c0a 100644
--- a/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php
+++ b/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php
@@ -9,6 +9,9 @@
  +--------------------------------------------------------------------+
  */
 
+use Civi\Api4\FinancialAccount;
+use Civi\Api4\FinancialType;
+
 /**
  * Class CRM_Financial_BAO_FinancialAccountTest
  * @group headless
@@ -105,36 +108,37 @@ class CRM_Financial_BAO_FinancialAccountTest extends CiviUnitTestCase {
   }
 
   /**
-   * Check method del()
+   * Check delete fails if a related contribution exists.
+   *
+   * @throws \API_Exception
+   * @throws \CRM_Core_Exception
+   * @throws \CiviCRM_API3_Exception
    */
-  public function testdelIfHasContribution() {
-    $params = [
+  public function testDeleteIfHasContribution(): void {
+    $financialType = FinancialType::create(FALSE)->setValues([
       'name' => 'Donation Test',
-      'is_active' => 1,
-      'is_deductible' => 1,
       'is_reserved' => 1,
-    ];
-    $financialType = CRM_Financial_BAO_FinancialType::add($params);
-    $defaults = [];
-    $params = [
-      'name' => 'Donation Test',
-      'is_active' => 1,
-    ];
-    $result = CRM_Financial_BAO_FinancialAccount::retrieve($params, $defaults);
+    ])->execute()->first();
+
+    $financialAccount = FinancialAccount::get(FALSE)->setWhere([
+      ['name', '=', 'Donation Test'],
+      ['is_active', '=', TRUE],
+    ])->setSelect(['id'])->execute()->first();
 
     $contactId = $this->individualCreate();
     $contributionParams = [
       'total_amount' => 300,
       'currency' => 'USD',
       'contact_id' => $contactId,
-      'financial_type_id' => $financialType->id,
+      'financial_type_id' => $financialType['id'],
       'contribution_status_id' => 1,
     ];
     $this->callAPISuccess('Contribution', 'create', $contributionParams);
-    CRM_Financial_BAO_FinancialAccount::del($result->id);
-    $params = ['id' => $result->id];
-    $result = CRM_Financial_BAO_FinancialAccount::retrieve($params, $defaults);
-    $this->assertEquals(empty($result), FALSE, 'Verify financial account record deletion.');
+    CRM_Financial_BAO_FinancialAccount::del($financialAccount['id']);
+
+    $this->assertCount(1, FinancialAccount::get(FALSE)->setWhere([
+      ['id', '=', $financialAccount['id']],
+    ])->selectRowCount()->execute(), 'Financial account should not be deleted as it is in use.');
   }
 
   /**
-- 
2.25.1