api_bankaccounts.class.php

<?php
/*
 * Copyright (C) 2016 Xebax Christy       <xebax@wanadoo.fr>
 * Copyright (C) 2024-2025  MDW         <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2025  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2025       Charlene Benke      <charlene@patas-monkey.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT . '/compta/bank/class/account.class.php';
 
class BankAccounts extends DolibarrApi
{
  public static $FIELDS = array(
    'ref',
    'label',
    'type',
    'currency_code',
    'country_id'
  );
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $category = 0, $sqlfilters = '', $properties = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('banque', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT t.rowid FROM ".MAIN_DB_PREFIX."bank_account AS t LEFT JOIN ".MAIN_DB_PREFIX."bank_account_extrafields AS ef ON (ef.fk_object = t.rowid)"; // Modification VMR Global Solutions to include extrafields as search parameters in the API GET call, so we will be able to filter on extrafields
    if ($category > 0) {
      $sql .= ", " . MAIN_DB_PREFIX . "categorie_account as c";
    }
    $sql .= ' WHERE t.entity IN (' . getEntity('bank_account') . ')';
    // Select accounts of given category
    if ($category > 0) {
      $sql .= " AND c.fk_categorie = " . ((int) $category) . " AND c.fk_account = t.rowid";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit + 1, $offset);
    }
 
    dol_syslog("API Rest request");
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $obj = $this->db->fetch_object($result);
        $account = new Account($this->db);
        if ($account->fetch($obj->rowid) > 0) {
          $account->balance = $account->solde(1);  // 1=Exclude future operation date
          $list[] = $this->_filterObjectProperties($this->_cleanObjectDatas($account), $properties);
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of accounts: ' . $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'lire')) {
      throw new RestException(403);
    }
 
    $account = new Account($this->db);
    $result = $account->fetch($id);
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    return $this->_cleanObjectDatas($account);
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'configurer')) {
      throw new RestException(403);
    }
    // Check mandatory fields
    $this->_validate($request_data);
 
    $account = new Account($this->db);
    // Date of the initial balance (required to create an account).
    $account->date_solde = time();
    foreach ($request_data as $field => $value) {
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $account->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $account->$field = $this->_checkValForAPI($field, $value, $account);
    }
 
    if ($account->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error creating bank account', array_merge(array($account->error), $account->errors));
    }
    return $account->id;
  }
 
  public function transfer($bankaccount_from_id = 0, $bankaccount_to_id = 0, $date = null, $description = "", $amount = 0.0, $amount_to = 0.0, $cheque_number = "")
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'configurer')) {
      throw new RestException(403);
    }
 
    require_once DOL_DOCUMENT_ROOT . '/compta/bank/class/account.class.php';
 
    $accountfrom = new Account($this->db);
    $resultAccountFrom = $accountfrom->fetch($bankaccount_from_id);
 
    if ($resultAccountFrom === 0) {
      throw new RestException(404, 'The BankAccount for bankaccount_from_id provided does not exist.');
    }
 
    $accountto = new Account($this->db);
    $resultAccountTo = $accountto->fetch($bankaccount_to_id);
 
    if ($resultAccountTo === 0) {
      throw new RestException(404, 'The BankAccount for bankaccount_to_id provided does not exist.');
    }
 
    if ($accountto->currency_code == $accountfrom->currency_code) {
      $amount_to = $amount;
    } else {
      if (!$amount_to || empty($amount_to)) {
        throw new RestException(422, 'You must provide amount_to value since bankaccount_from and bankaccount_to does not share the same currency.');
      }
    }
 
    if ($amount_to < 0) {
      throw new RestException(422, 'You must provide a positive value for amount.');
    }
 
    if ($accountto->id == $accountfrom->id) {
      throw new RestException(422, 'bankaccount_from_id and bankaccount_to_id must be different !');
    }
 
    $this->db->begin();
 
    $error = 0;
    $bank_line_id_from = 0;
    $bank_line_id_to = 0;
    $result = 0;
    $user = DolibarrApiAccess::$user;
 
    // By default, electronic transfer from bank to bank
    $typefrom = 'PRE';
    $typeto = 'VIR';
 
    if ($accountto->type == Account::TYPE_CASH || $accountfrom->type == Account::TYPE_CASH) {
      // This is transfer of change
      $typefrom = 'LIQ';
      $typeto = 'LIQ';
    }
 
    // Clean data
    $description = sanitizeVal($description, 'alphanohtml');
    $cheque_number = sanitizeVal($cheque_number, 'alphanohtml');
 
    if (!$error) {
      $bank_line_id_from = $accountfrom->addline((int) $date, $typefrom, $description, -1 * (float) price2num($amount), '', 0, $user, $cheque_number);
    }
    if (!($bank_line_id_from > 0)) {
      $error++;
    }
 
    if (!$error) {
      $bank_line_id_to = $accountto->addline((int) $date, $typeto, $description, (float) price2num($amount_to), '', 0, $user, $cheque_number);
    }
    if (!($bank_line_id_to > 0)) {
      $error++;
    }
 
    $url = DOL_URL_ROOT . '/compta/bank/line.php?rowid=';
    $label = '(banktransfert)';
    $type = 'banktransfert';
 
    if (!$error) {
      $result = $accountfrom->add_url_line($bank_line_id_from, $bank_line_id_to, $url, $label, $type);
    }
    if (!($result > 0)) {
      $error++;
    }
 
    if (!$error) {
      $result = $accountto->add_url_line($bank_line_id_to, $bank_line_id_from, $url, $label, $type);
    }
    if (!($result > 0)) {
      $error++;
    }
 
    if (!$error) {
      $this->db->commit();
 
      return array(
        'success' => array(
          'code' => 201,
          'message' => 'Internal wire transfer created successfully.',
          'bank_id_from' => $bank_line_id_from,
          'bank_id_to' => $bank_line_id_to,
        )
      );
    } else {
      $this->db->rollback();
      throw new RestException(500, $accountfrom->error . ' ' . $accountto->error);
    }
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'configurer')) {
      throw new RestException(403);
    }
 
    $account = new Account($this->db);
    $result = $account->fetch($id);
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $account->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $account->array_options[$index] = $this->_checkValExtrafieldsForAPI($index, $val, $account);
        }
        continue;
      }
      $account->$field = $this->_checkValForAPI($field, $value, $account);
    }
 
    if ($account->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $account->error);
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'configurer')) {
      throw new RestException(403);
    }
    $account = new Account($this->db);
    $result = $account->fetch($id);
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    if ($account->delete(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'error when deleting account');
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'account deleted'
      )
    );
  }
 
  private function _validate($data)
  {
    if ($data === null) {
      $data = array();
    }
    $account = array();
    foreach (BankAccounts::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $account[$field] = $data[$field];
    }
    return $account;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->rowid);
 
    return $object;
  }
 
  public function getLines($id, $sqlfilters = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('banque', 'lire')) {
      throw new RestException(403);
    }
 
    $account = new Account($this->db);
    $result = $account->fetch($id);
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    $sql = "SELECT rowid FROM " . MAIN_DB_PREFIX . "bank ";
    $sql .= " WHERE fk_account = " . ((int) $id);
 
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= " ORDER BY rowid";
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      //$min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $num; $i++) {
        $obj = $this->db->fetch_object($result);
        $accountLine = new AccountLine($this->db);
        if ($accountLine->fetch($obj->rowid) > 0) {
          $list[] = $this->_cleanObjectDatas($accountLine);
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of account lines: ' . $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function addLine($id, $date, $type, $label, $amount, $category = 0, $cheque_number = '', $cheque_writer = '', $cheque_bank = '', $accountancycode = '', $datev = null, $num_releve = '')
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'modifier')) {
      throw new RestException(403);
    }
 
    $account = new Account($this->db);
    $result = $account->fetch($id);
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    $type = sanitizeVal($type);
    $label = sanitizeVal($label);
    $cheque_number = sanitizeVal($cheque_number);
    $cheque_writer = sanitizeVal($cheque_writer);
    $cheque_bank = sanitizeVal($cheque_bank);
    $accountancycode = sanitizeVal($accountancycode);
    $num_releve = sanitizeVal($num_releve);
 
    $result = $account->addline(
      (int) $date,
      $type,
      $label,
      $amount,
      $cheque_number,
      $category,
      DolibarrApiAccess::$user,
      $cheque_writer,
      $cheque_bank,
      $accountancycode,
      (int) $datev,
      $num_releve
    );
    if ($result < 0) {
      throw new RestException(503, 'Error when adding line to account: ' . $account->error);
    }
    return $result;
  }
 
  public function addLink($id, $line_id, $url_id, $url, $label, $type)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'modifier')) {
      throw new RestException(403);
    }
 
    $account = new Account($this->db);
    $result = $account->fetch($id);
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    $accountLine = new AccountLine($this->db);
    $result = $accountLine->fetch($line_id);
    if (!$result) {
      throw new RestException(404, 'account line not found');
    }
 
    if ($accountLine->fk_account != $id) {
      throw new RestException(400, 'Line does not belong to this account');
    }
 
    $url = sanitizeVal($url);
    $label = sanitizeVal($label);
    $type = sanitizeVal($type);
 
    $result = $account->add_url_line($line_id, $url_id, $url, $label, $type);
    if ($result < 0) {
      throw new RestException(503, 'Error when adding link to account line: ' . $account->error);
    }
    return $result;
  }
 
  public function getLinks($id, $line_id)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'lire')) {
      throw new RestException(403);
    }
 
    $account = new Account($this->db);
    $result = $account->fetch($id);
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    $links = $account->get_url($line_id); // Get an array('url'=>, 'url_id'=>, 'label'=>, 'type'=> 'fk_bank'=> )
    foreach ($links as &$link) {
      unset($link[0], $link[1], $link[2], $link[3]); // Remove the numeric keys
    }
 
    return $links;
  }
 
  public function getDetailAccountLine($line_id)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'lire')) {
      throw new RestException(403);
    }
 
    $accountLine = new AccountLine($this->db);
    $result = $accountLine->fetch($line_id);
    if (!$result) {
      throw new RestException(404, 'account Line not found');
    }
 
    return $this->_cleanObjectDatas($accountLine);
  }
 
  public function updateLine($id, $line_id, $label)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'modifier')) {
      throw new RestException(403);
    }
 
    $account = new Account($this->db);
    $result = $account->fetch($id);
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    $accountLine = new AccountLine($this->db);
    $result = $accountLine->fetch($line_id);
    if (!$result) {
      throw new RestException(404, 'account line not found');
    }
 
    if ($accountLine->fk_account != $id) {
      throw new RestException(400, 'Line does not belong to this account');
    }
 
    $accountLine->label = sanitizeVal($label);
 
    $result = $accountLine->updateLabel();
    if ($result < 0) {
      throw new RestException(503, 'Error when updating link to account line: ' . $accountLine->error);
    }
    return $accountLine->id;
  }
 
  public function deleteLine($id, $line_id)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'modifier')) {
      throw new RestException(403);
    }
 
    $account = new Account($this->db);
    $result = $account->fetch($id);
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    $accountLine = new AccountLine($this->db);
    $result = $accountLine->fetch($line_id);
    if (!$result) {
      throw new RestException(404, 'account line not found');
    }
 
    if ($accountLine->fk_account != $id) {
      throw new RestException(400, 'Line does not belong to this account');
    }
 
    if ($accountLine->delete(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'error when deleting account line');
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => "account line $line_id deleted"
      )
    );
  }
 
  public function getBalance($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'lire')) {
      throw new RestException(403);
    }
 
    $account = new Account($this->db);
    $result = $account->fetch($id);
 
    if (!$result) {
      throw new RestException(404, 'account not found');
    }
 
    $balance = $account->solde(1);  //1=Exclude future operation date (this is to exclude input made in advance and have real account sold)
 
    return $balance;
  }
}