api_thirdparties.class.php

<?php
/* Copyright (C) 2015     Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2018     Pierre Chéné            <pierre.chene44@gmail.com>
 * Copyright (C) 2019     Cedric Ancelin          <icedo.anc@gmail.com>
 * Copyright (C) 2020-2024  Frédéric France       <frederic.france@free.fr>
 * Copyright (C) 2023       Alexandre Janniaux    <alexandre.janniaux@gmail.com>
 * Copyright (C) 2024   MDW           <mdeweerd@users.noreply.github.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;
 
class Thirdparties extends DolibarrApi
{
  public static $FIELDS = array(
    'name'
  );
 
  public $company;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
 
    require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
    require_once DOL_DOCUMENT_ROOT.'/societe/class/societeaccount.class.php';
    require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
    require_once DOL_DOCUMENT_ROOT.'/societe/class/companybankaccount.class.php';
 
    $this->company = new Societe($this->db);
 
    if (getDolGlobalString('SOCIETE_EMAIL_MANDATORY')) {
      static::$FIELDS[] = 'email';
    }
  }
 
  public function get($id)
  {
    return $this->_fetch($id);
  }
 
  public function getByEmail($email)
  {
    return $this->_fetch('', '', '', '', '', '', '', '', '', '', $email);
  }
 
  public function getByBarcode($barcode)
  {
    return $this->_fetch('', '', '', $barcode);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $mode = 0, $category = 0, $sqlfilters = '', $properties = '')
  {
    $obj_ret = array();
 
    if (!DolibarrApiAccess::$user->hasRight('societe', 'lire')) {
      throw new RestException(401);
    }
 
    // case of external user, we force socids
    $socids = DolibarrApiAccess::$user->socid ? DolibarrApiAccess::$user->socid : '';
 
    // If the internal user must only see his customers, force searching by him
    $search_sale = 0;
    if (!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) {
      $search_sale = DolibarrApiAccess::$user->id;
    }
 
    $sql = "SELECT t.rowid";
    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) {
      $sql .= ", sc.fk_soc, sc.fk_user"; // We need these fields in order to filter by sale (including the case where the user can only see his prospects)
    }
    $sql .= " FROM ".MAIN_DB_PREFIX."societe as t";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe_extrafields AS ef ON ef.fk_object = t.rowid"; // So we will be able to filter on extrafields
    if ($category > 0) {
      if ($mode != 4) {
        $sql .= ", ".MAIN_DB_PREFIX."categorie_societe as c";
      }
      if (!in_array($mode, array(1, 2, 3))) {
        $sql .= ", ".MAIN_DB_PREFIX."categorie_fournisseur as cc";
      }
    }
    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) {
      $sql .= ", ".MAIN_DB_PREFIX."societe_commerciaux as sc"; // We need this table joined to the select in order to filter by sale
    }
    $sql .= ", ".MAIN_DB_PREFIX."c_stcomm as st";
    $sql .= " WHERE t.entity IN (".getEntity('societe').")";
    $sql .= " AND t.fk_stcomm = st.id";
 
    if ($mode == 1) {
      $sql .= " AND t.client IN (1, 3)";
    } elseif ($mode == 2) {
      $sql .= " AND t.client IN (2, 3)";
    } elseif ($mode == 3) {
      $sql .= " AND t.client IN (0)";
    } elseif ($mode == 4) {
      $sql .= " AND t.fournisseur IN (1)";
    }
 
    // Select thirdparties of given category
    if ($category > 0) {
      if (!empty($mode) && $mode != 4) {
        $sql .= " AND c.fk_categorie = ".((int) $category)." AND c.fk_soc = t.rowid";
      } elseif (!empty($mode) && $mode == 4) {
        $sql .= " AND cc.fk_categorie = ".((int) $category)." AND cc.fk_soc = t.rowid";
      } else {
        $sql .= " AND ((c.fk_categorie = ".((int) $category)." AND c.fk_soc = t.rowid) OR (cc.fk_categorie = ".((int) $category)." AND cc.fk_soc = t.rowid))";
      }
    }
 
    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) {
      $sql .= " AND t.rowid = sc.fk_soc";
    }
    //if ($email != NULL) $sql.= " AND s.email = \"".$email."\"";
    if ($socids) {
      $sql .= " AND t.rowid IN (".$this->db->sanitize($socids).")";
    }
    if ($search_sale > 0) {
      $sql .= " AND t.rowid = sc.fk_soc"; // Join for the needed table to filter by sale
    }
    // Insert sale filter
    if ($search_sale > 0) {
      $sql .= " AND sc.fk_user = ".((int) $search_sale);
    }
    // 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);
    }
 
    $result = $this->db->query($sql);
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      $i = 0;
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $soc_static = new Societe($this->db);
        if ($soc_static->fetch($obj->rowid)) {
          if (isModEnabled('mailing')) {
            $soc_static->getNoEmail();
          }
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($soc_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve thirdparties : '.$this->db->lasterror());
    }
    if (!count($obj_ret)) {
      throw new RestException(404, 'Thirdparties not found');
    }
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
    // Check mandatory fields
    $result = $this->_validate($request_data);
 
    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 whith the caller
        $this->company->context['caller'] = $request_data['caller'];
        continue;
      }
 
      $this->company->$field = $this->_checkValForAPI($field, $value, $this->company);
    }
 
    if ($this->company->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error creating thirdparty', array_merge(array($this->company->error), $this->company->errors));
    }
    if (isModEnabled('mailing') && !empty($this->company->email) && isset($this->company->no_email)) {
      $this->company->setNoEmail($this->company->no_email);
    }
 
    return $this->company->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $this->company->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    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 whith the caller
        $this->company->context['caller'] = $request_data['caller'];
        continue;
      }
 
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $this->company->array_options[$index] = $this->_checkValForAPI($field, $val, $this->company);
        }
        continue;
      }
      $this->company->$field = $this->_checkValForAPI($field, $value, $this->company);
    }
 
    if (isModEnabled('mailing') && !empty($this->company->email) && isset($this->company->no_email)) {
      $this->company->setNoEmail($this->company->no_email);
    }
 
    if ($this->company->update($id, DolibarrApiAccess::$user, 1, '', '', 'update', 1) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->company->error);
    }
  }
 
  public function merge($id, $idtodelete)
  {
    global $user;
 
    $error = 0;
 
    if ($id == $idtodelete) {
      throw new RestException(400, 'Try to merge a thirdparty into itself');
    }
 
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $result = $this->company->fetch($id); // include the fetch of extra fields
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $this->company->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $companytoremove = new Societe($this->db);
    $result = $companytoremove->fetch($idtodelete); // include the fetch of extra fields
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $companytoremove->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $user = DolibarrApiAccess::$user;
    $result = $this->company->mergeCompany($companytoremove->id);
    if ($result < 0) {
      throw new RestException(500, 'Error failed to merged thirdparty '.$companytoremove->id.' into '.$id.'. Enable and read log file for more information.');
    }
 
    return $this->get($id);
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('societe', 'supprimer')) {
      throw new RestException(401);
    }
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
    if (!DolibarrApi::_checkAccessToResource('societe', $this->company->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $this->company->oldcopy = clone $this->company;
 
    $res = $this->company->delete($id);
    if ($res < 0) {
      throw new RestException(500, "Can't delete, error occurs");
    } elseif ($res == 0) {
      throw new RestException(409, "Can't delete, that product is probably used");
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Object deleted'
      )
    );
  }
 
  public function setThirdpartyPriceLevel($id, $priceLevel)
  {
    global $conf;
 
    if (!isModEnabled('societe')) {
      throw new RestException(501, 'Module "Thirdparties" needed for this request');
    }
 
    if (!isModEnabled("product")) {
      throw new RestException(501, 'Module "Products" needed for this request');
    }
 
    if (!getDolGlobalString('PRODUIT_MULTIPRICES')) {
      throw new RestException(501, 'Multiprices features activation needed for this request');
    }
 
    if ($priceLevel < 1 || $priceLevel > $conf->global->PRODUIT_MULTIPRICES_LIMIT) {
      throw new RestException(400, 'Price level must be between 1 and ' . getDolGlobalString('PRODUIT_MULTIPRICES_LIMIT'));
    }
 
    if (empty(DolibarrApiAccess::$user->rights->societe->creer)) {
      throw new RestException(401, 'Access to thirdparty '.$id.' not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->company->fetch($id);
    if ($result < 0) {
      throw new RestException(404, 'Thirdparty '.$id.' not found');
    }
 
    if (empty($result)) {
      throw new RestException(500, 'Error fetching thirdparty '.$id, array_merge(array($this->company->error), $this->company->errors));
    }
 
    if (empty(DolibarrApi::_checkAccessToResource('societe', $this->company->id))) {
      throw new RestException(401, 'Access to thirdparty '.$id.' not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->company->setPriceLevel($priceLevel, DolibarrApiAccess::$user);
    if ($result <= 0) {
      throw new RestException(500, 'Error setting new price level for thirdparty '.$id, array($this->company->db->lasterror()));
    }
 
    return $this->_cleanObjectDatas($this->company);
  }
 
  public function getCategories($id, $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0)
  {
    if (!DolibarrApiAccess::$user->rights->categorie->lire) {
      throw new RestException(401);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    $categories = new Categorie($this->db);
 
    $arrayofcateg = $categories->getListForItem($id, 'customer', $sortfield, $sortorder, $limit, $page);
 
    if (is_numeric($arrayofcateg) && $arrayofcateg < 0) {
      throw new RestException(503, 'Error when retrieve category list : '.$categories->error);
    }
 
    if (is_numeric($arrayofcateg) && $arrayofcateg >= 0) {  // To fix a return of 0 instead of empty array of method getListForItem
      return array();
    }
 
    return $arrayofcateg;
  }
 
  public function addCategory($id, $category_id)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
    $category = new Categorie($this->db);
    $result = $category->fetch($category_id);
    if (!$result) {
      throw new RestException(404, 'category not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $this->company->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    if (!DolibarrApi::_checkAccessToResource('category', $category->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $category->add_type($this->company, 'customer');
 
    return $this->_cleanObjectDatas($this->company);
  }
 
  public function deleteCategory($id, $category_id)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
    $category = new Categorie($this->db);
    $result = $category->fetch($category_id);
    if (!$result) {
      throw new RestException(404, 'category not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $this->company->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    if (!DolibarrApi::_checkAccessToResource('category', $category->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $category->del_type($this->company, 'customer');
 
    return $this->_cleanObjectDatas($this->company);
  }
 
  public function getSupplierCategories($id, $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0)
  {
    if (!DolibarrApiAccess::$user->rights->categorie->lire) {
      throw new RestException(401);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    $categories = new Categorie($this->db);
 
    $result = $categories->getListForItem($id, 'supplier', $sortfield, $sortorder, $limit, $page);
 
    if (is_numeric($result) && $result < 0) {
      throw new RestException(503, 'Error when retrieve category list : '.$categories->error);
    }
 
    if (is_numeric($result) && $result == 0) {  // To fix a return of 0 instead of empty array of method getListForItem
      return array();
    }
 
    return $result;
  }
 
  public function addSupplierCategory($id, $category_id)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
    $category = new Categorie($this->db);
    $result = $category->fetch($category_id);
    if (!$result) {
      throw new RestException(404, 'category not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $this->company->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    if (!DolibarrApi::_checkAccessToResource('category', $category->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $category->add_type($this->company, 'supplier');
 
    return $this->_cleanObjectDatas($this->company);
  }
 
  public function deleteSupplierCategory($id, $category_id)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
    $category = new Categorie($this->db);
    $result = $category->fetch($category_id);
    if (!$result) {
      throw new RestException(404, 'category not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $this->company->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    if (!DolibarrApi::_checkAccessToResource('category', $category->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $category->del_type($this->company, 'supplier');
 
    return $this->_cleanObjectDatas($this->company);
  }
 
 
  public function getOutStandingProposals($id, $mode = 'customer')
  {
    if (!DolibarrApiAccess::$user->hasRight('societe', 'lire')) {
      throw new RestException(401);
    }
 
    if (empty($id)) {
      throw new RestException(400, 'Thirdparty ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    $result = $this->company->getOutstandingProposals($mode);
 
    unset($result['total_ht']);
    unset($result['total_ttc']);
 
    return $result;
  }
 
 
  public function getOutStandingOrder($id, $mode = 'customer')
  {
    if (!DolibarrApiAccess::$user->hasRight('societe', 'lire')) {
      throw new RestException(401);
    }
 
    if (empty($id)) {
      throw new RestException(400, 'Thirdparty ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    $result = $this->company->getOutstandingOrders($mode);
 
    unset($result['total_ht']);
    unset($result['total_ttc']);
 
    return $result;
  }
 
  public function getOutStandingInvoices($id, $mode = 'customer')
  {
    if (!DolibarrApiAccess::$user->hasRight('societe', 'lire')) {
      throw new RestException(401);
    }
 
    if (empty($id)) {
      throw new RestException(400, 'Thirdparty ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    $result = $this->company->getOutstandingBills($mode);
 
    unset($result['total_ht']);
    unset($result['total_ttc']);
 
    return $result;
  }
 
  public function getSalesRepresentatives($id, $mode = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('societe', 'lire')) {
      throw new RestException(401);
    }
 
    if (empty($id)) {
      throw new RestException(400, 'Thirdparty ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    $result = $this->company->getSalesRepresentatives(DolibarrApiAccess::$user, $mode);
 
    return $result;
  }
 
  public function getFixedAmountDiscounts($id, $filter = "none", $sortfield = "f.type", $sortorder = 'ASC')
  {
    $obj_ret = array();
 
    if (!DolibarrApiAccess::$user->hasRight('societe', 'lire')) {
      throw new RestException(401);
    }
 
    if (empty($id)) {
      throw new RestException(400, 'Thirdparty ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->company->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
 
    $sql = "SELECT f.ref, f.type as factype, re.fk_facture_source, re.rowid, re.amount_ht, re.amount_tva, re.amount_ttc, re.description, re.fk_facture, re.fk_facture_line";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe_remise_except as re, ".MAIN_DB_PREFIX."facture as f";
    $sql .= " WHERE f.rowid = re.fk_facture_source AND re.fk_soc = ".((int) $id);
    if ($filter == "available") {
      $sql .= " AND re.fk_facture IS NULL AND re.fk_facture_line IS NULL";
    }
    if ($filter == "used") {
      $sql .= " AND (re.fk_facture IS NOT NULL OR re.fk_facture_line IS NOT NULL)";
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    $result = $this->db->query($sql);
    if (!$result) {
      throw new RestException(503, $this->db->lasterror());
    } else {
      $num = $this->db->num_rows($result);
      while ($obj = $this->db->fetch_object($result)) {
        $obj_ret[] = $obj;
      }
    }
 
    return $obj_ret;
  }
 
 
 
  public function getInvoicesQualifiedForReplacement($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(401);
    }
    if (empty($id)) {
      throw new RestException(400, 'Thirdparty ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    /*$result = $this->thirdparty->fetch($id);
     if( ! $result ) {
     throw new RestException(404, 'Thirdparty not found');
     }*/
 
    $invoice = new Facture($this->db);
    $result = $invoice->list_replacable_invoices($id);
    if ($result < 0) {
      throw new RestException(405, $invoice->error);
    }
 
    return $result;
  }
 
  public function getInvoicesQualifiedForCreditNote($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(401);
    }
    if (empty($id)) {
      throw new RestException(400, 'Thirdparty ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    /*$result = $this->thirdparty->fetch($id);
     if( ! $result ) {
     throw new RestException(404, 'Thirdparty not found');
     }*/
 
    $invoice = new Facture($this->db);
    $result = $invoice->list_qualified_avoir_invoices($id);
    if ($result < 0) {
      throw new RestException(405, $invoice->error);
    }
 
    return $result;
  }
 
  public function getCompanyBankAccount($id)
  {
    if (!DolibarrApiAccess::$user->rights->societe->lire) {
      throw new RestException(401);
    }
    if (empty($id)) {
      throw new RestException(400, 'Thirdparty ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $sql = "SELECT rowid, fk_soc, bank, number, code_banque, code_guichet, cle_rib, bic, iban_prefix as iban, domiciliation, proprio,";
    $sql .= " owner_address, default_rib, label, datec, tms as datem, rum, frstrecur";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe_rib";
    if ($id) {
      $sql .= " WHERE fk_soc  = ".((int) $id);
    }
 
    $result = $this->db->query($sql);
 
    if ($this->db->num_rows($result) == 0) {
      throw new RestException(404, 'Account not found');
    }
 
    $i = 0;
 
    $accounts = array();
 
    if ($result) {
      $num = $this->db->num_rows($result);
      while ($i < $num) {
        $obj = $this->db->fetch_object($result);
        $account = new CompanyBankAccount($this->db);
        if ($account->fetch($obj->rowid)) {
          $accounts[] = $account;
        }
        $i++;
      }
    } else {
      throw new RestException(404, 'Account not found');
    }
 
 
    $fields = array('socid', 'default_rib', 'frstrecur', '1000110000001', 'datec', 'datem', 'label', 'bank', 'bic', 'iban', 'id', 'rum');
 
    $returnAccounts = array();
 
    foreach ($accounts as $account) {
      $object = array();
      foreach ($account as $key => $value) {
        if (in_array($key, $fields)) {
          $object[$key] = $value;
        }
      }
      $returnAccounts[] = $object;
    }
 
    return $returnAccounts;
  }
 
  public function createCompanyBankAccount($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
    if ($this->company->fetch($id) <= 0) {
      throw new RestException(404, 'Error creating Company Bank account, Company doesn\'t exists');
    }
    $account = new CompanyBankAccount($this->db);
 
    $account->socid = $id;
 
    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 whith the caller
        $this->company->context['caller'] = $request_data['caller'];
        continue;
      }
 
      $account->$field = $value;
    }
 
    if ($account->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error creating Company Bank account');
    }
 
    if (empty($account->rum)) {
      require_once DOL_DOCUMENT_ROOT.'/compta/prelevement/class/bonprelevement.class.php';
      $prelevement = new BonPrelevement($this->db);
      $account->rum = $prelevement->buildRumNumber($this->company->code_client, $account->datec, $account->id);
      $account->date_rum = dol_now();
    }
 
    if ($account->update(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error updating values');
    }
 
    return $this->_cleanObjectDatas($account);
  }
 
  public function updateCompanyBankAccount($id, $bankaccount_id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
    if ($this->company->fetch($id) <= 0) {
      throw new RestException(404, 'Error creating Company Bank account, Company doesn\'t exists');
    }
    $account = new CompanyBankAccount($this->db);
 
    $account->fetch($bankaccount_id, $id, -1, '');
 
    if ($account->socid != $id) {
      throw new RestException(401);
    }
 
 
    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 whith the caller
        $account->context['caller'] = $request_data['caller'];
        continue;
      }
 
      $account->$field = $value;
    }
 
    if (empty($account->rum)) {
      require_once DOL_DOCUMENT_ROOT.'/compta/prelevement/class/bonprelevement.class.php';
      $prelevement = new BonPrelevement($this->db);
      $account->rum = $prelevement->buildRumNumber($this->company->code_client, $account->datec, $account->id);
      $account->date_rum = dol_now();
    }
 
    if ($account->update(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error updating values');
    }
 
    return $this->_cleanObjectDatas($account);
  }
 
  public function deleteCompanyBankAccount($id, $bankaccount_id)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $account = new CompanyBankAccount($this->db);
 
    $account->fetch($bankaccount_id);
 
    if (!$account->socid == $id) {
      throw new RestException(401);
    }
 
    return $account->delete(DolibarrApiAccess::$user);
  }
 
  public function generateBankAccountDocument($id, $companybankid = null, $model = 'sepamandate')
  {
    global $conf, $langs;
 
    $langs->loadLangs(array("main", "dict", "commercial", "products", "companies", "banks", "bills", "withdrawals"));
 
    if ($this->company->fetch($id) <= 0) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $this->company->setDocModel(DolibarrApiAccess::$user, $model);
 
    $this->company->fk_bank = $this->company->fk_account;
    $this->company->fk_account = $this->company->fk_account;
 
    $outputlangs = $langs;
    $newlang = '';
 
    //if (getDolGlobalInt('MAIN_MULTILANGS') && empty($newlang) && GETPOST('lang_id', 'aZ09')) $newlang = GETPOST('lang_id', 'aZ09');
    if (getDolGlobalInt('MAIN_MULTILANGS') && empty($newlang)) {
      if (isset($this->company->thirdparty->default_lang)) {
        $newlang = $this->company->thirdparty->default_lang; // for proposal, order, invoice, ...
      } elseif (isset($this->company->default_lang)) {
        $newlang = $this->company->default_lang; // for thirdparty
      }
    }
    if (!empty($newlang)) {
      $outputlangs = new Translate("", $conf);
      $outputlangs->setDefaultLang($newlang);
    }
 
    $sql = "SELECT rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe_rib";
    if ($id) {
      $sql .= " WHERE fk_soc = ".((int) $id);
    }
    if ($companybankid) {
      $sql .= " AND rowid = ".((int) $companybankid);
    }
 
    $i = 0;
    $accounts = array();
 
    $result = $this->db->query($sql);
    if ($result) {
      if ($this->db->num_rows($result) == 0) {
        throw new RestException(404, 'Bank account not found');
      }
 
      $num = $this->db->num_rows($result);
      while ($i < $num) {
        $obj = $this->db->fetch_object($result);
 
        $account = new CompanyBankAccount($this->db);
        if ($account->fetch($obj->rowid)) {
          $accounts[] = $account;
        }
        $i++;
      }
    } else {
      throw new RestException(500, 'Sql error '.$this->db->lasterror());
    }
 
    $moreparams = array(
      'use_companybankid' => $accounts[0]->id,
      'force_dir_output' => $conf->societe->multidir_output[$this->company->entity].'/'.dol_sanitizeFileName($this->company->id)
    );
 
    $result = $this->company->generateDocument($model, $outputlangs, 0, 0, 0, $moreparams);
 
    if ($result > 0) {
      return array("success" => $result);
    } else {
      throw new RestException(500, 'Error generating the document '.$this->company->error);
    }
  }
 
  public function getSocieteAccounts($id, $site = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('societe', 'lire')) {
      throw new RestException(401);
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $sql = "SELECT rowid, fk_soc, key_account, site, date_creation, tms FROM ".MAIN_DB_PREFIX."societe_account";
    $sql .= " WHERE fk_soc = ".((int) $id);
    if ($site) {
      $sql .= " AND site ='".$this->db->escape($site)."'";
    }
 
    $result = $this->db->query($sql);
 
    if ($result && $this->db->num_rows($result) == 0) {
      throw new RestException(404, 'This thirdparty does not have any gateway attached or does not exist.');
    }
 
    $i = 0;
 
    $accounts = array();
 
    $num = $this->db->num_rows($result);
    while ($i < $num) {
      $obj = $this->db->fetch_object($result);
      $account = new SocieteAccount($this->db);
 
      if ($account->fetch($obj->rowid)) {
        $accounts[] = $account;
      }
      $i++;
    }
 
    $fields = array('id', 'fk_soc', 'key_account', 'site', 'date_creation', 'tms');
 
    $returnAccounts = array();
 
    foreach ($accounts as $account) {
      $object = array();
      foreach ($account as $key => $value) {
        if (in_array($key, $fields)) {
          $object[$key] = $value;
        }
      }
      $returnAccounts[] = $object;
    }
 
    return $returnAccounts;
  }
 
  public function createSocieteAccount($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    if (!isset($request_data['site'])) {
      throw new RestException(422, 'Unprocessable Entity: You must pass the site attribute in your request data !');
    }
 
    $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."societe_account WHERE fk_soc  = ".((int) $id)." AND site = '".$this->db->escape($request_data['site'])."'";
    $result = $this->db->query($sql);
 
    if ($result && $this->db->num_rows($result) == 0) {
      $account = new SocieteAccount($this->db);
      if (!isset($request_data['login'])) {
        $account->login = "";
      }
      $account->fk_soc = $id;
 
      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 whith the caller
          $account->context['caller'] = $request_data['caller'];
          continue;
        }
 
        $account->$field = $value;
      }
 
      if ($account->create(DolibarrApiAccess::$user) < 0) {
        throw new RestException(500, 'Error creating SocieteAccount entity. Ensure that the ID of thirdparty provided does exist!');
      }
 
      $this->_cleanObjectDatas($account);
 
      return $account;
    } else {
      throw new RestException(409, 'A SocieteAccount entity already exists for this company and site.');
    }
  }
 
  public function putSocieteAccount($id, $site, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $sql = "SELECT rowid, fk_user_creat, date_creation FROM ".MAIN_DB_PREFIX."societe_account WHERE fk_soc = $id AND site = '".$this->db->escape($site)."'";
    $result = $this->db->query($sql);
 
    // We do not found an existing SocieteAccount entity for this fk_soc and site ; we then create a new one.
    if ($result && $this->db->num_rows == 0) {
      if (!isset($request_data['key_account'])) {
        throw new RestException(422, 'Unprocessable Entity: You must pass the key_account attribute in your request data !');
      }
      $account = new SocieteAccount($this->db);
      if (!isset($request_data['login'])) {
        $account->login = "";
      }
 
      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 whith the caller
          $account->context['caller'] = $request_data['caller'];
          continue;
        }
 
        $account->$field = $value;
      }
 
      $account->fk_soc = $id;
      $account->site = $site;
 
      if ($account->create(DolibarrApiAccess::$user) < 0) {
        throw new RestException(500, 'Error creating SocieteAccount entity.');
      }
      // We found an existing SocieteAccount entity, we are replacing it
    } else {
      if (isset($request_data['site']) && $request_data['site'] !== $site) {
        $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."societe_account WHERE fk_soc  = ".((int) $id)." AND site = '".$this->db->escape($request_data['site'])."' ";
        $result = $this->db->query($sql);
 
        if ($result && $this->db->num_rows($result) !== 0) {
          throw new RestException(409, "You are trying to update this thirdparty SocieteAccount (gateway record) from $site to ".$request_data['site']." but another SocieteAccount entity already exists with this site key.");
        }
      }
 
      $obj = $this->db->fetch_object($result);
 
      $account = new SocieteAccount($this->db);
      $account->id = $obj->rowid;
      $account->fk_soc = $id;
      $account->site = $site;
      if (!isset($request_data['login'])) {
        $account->login = "";
      }
      $account->fk_user_creat = $obj->fk_user_creat;
      $account->date_creation = $obj->date_creation;
 
      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 whith the caller
          $account->context['caller'] = $request_data['caller'];
          continue;
        }
 
        $account->$field = $value;
      }
 
      if ($account->update(DolibarrApiAccess::$user) < 0) {
        throw new RestException(500, 'Error updating SocieteAccount entity.');
      }
    }
 
    $this->_cleanObjectDatas($account);
 
    return $account;
  }
 
  public function patchSocieteAccount($id, $site, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."societe_account WHERE fk_soc = ".((int) $id)." AND site = '".$this->db->escape($site)."'";
    $result = $this->db->query($sql);
 
    if ($result && $this->db->num_rows($result) == 0) {
      throw new RestException(404, "This thirdparty does not have $site gateway attached or does not exist.");
    } else {
      // If the user tries to edit the site member, we check first if
      if (isset($request_data['site']) && $request_data['site'] !== $site) {
        $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."societe_account WHERE fk_soc  = ".((int) $id)." AND site = '".$this->db->escape($request_data['site'])."' ";
        $result = $this->db->query($sql);
 
        if ($result && $this->db->num_rows($result) !== 0) {
          throw new RestException(409, "You are trying to update this thirdparty SocieteAccount (gateway record) site member from ".$site." to ".$request_data['site']." but another SocieteAccount entity already exists for this thirdparty with this site key.");
        }
      }
 
      $obj = $this->db->fetch_object($result);
      $account = new SocieteAccount($this->db);
      $account->fetch($obj->rowid);
 
      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 whith the caller
          $account->context['caller'] = $request_data['caller'];
          continue;
        }
 
        $account->$field = $value;
      }
 
      if ($account->update(DolibarrApiAccess::$user) < 0) {
        throw new RestException(500, 'Error updating SocieteAccount account');
      }
 
      $this->_cleanObjectDatas($account);
 
      return $account;
    }
  }
 
  public function deleteSocieteAccount($id, $site)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."societe_account WHERE fk_soc  = $id AND site = '".$this->db->escape($site)."'";
    $result = $this->db->query($sql);
 
    if ($result && $this->db->num_rows($result) == 0) {
      throw new RestException(404);
    } else {
      $obj = $this->db->fetch_object($result);
      $account = new SocieteAccount($this->db);
      $account->fetch($obj->rowid);
 
      if ($account->delete(DolibarrApiAccess::$user) < 0) {
        throw new RestException(500, "Error while deleting $site gateway attached to this third party");
      }
    }
  }
 
  public function deleteSocieteAccounts($id)
  {
    if (!DolibarrApiAccess::$user->rights->societe->creer) {
      throw new RestException(401);
    }
 
    $sql = "SELECT rowid, fk_soc, key_account, site, date_creation, tms";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe_account WHERE fk_soc = ".((int) $id);
 
    $result = $this->db->query($sql);
 
    if ($result && $this->db->num_rows($result) == 0) {
      throw new RestException(404, 'This third party does not have any gateway attached or does not exist.');
    } else {
      $i = 0;
 
      $num = $this->db->num_rows($result);
      while ($i < $num) {
        $obj = $this->db->fetch_object($result);
        $account = new SocieteAccount($this->db);
        $account->fetch($obj->rowid);
 
        if ($account->delete(DolibarrApiAccess::$user) < 0) {
          throw new RestException(500, 'Error while deleting gateways attached to this third party');
        }
        $i++;
      }
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->nom); // ->name already defined and nom deprecated
    unset($object->name_bis); // ->name_alias already defined
    unset($object->note); // ->note_private and note_public already defined
    unset($object->departement);
    unset($object->departement_code);
    unset($object->pays);
    unset($object->particulier);
    unset($object->prefix_comm);
 
    unset($object->siren);
    unset($object->siret);
    unset($object->ape);
 
    unset($object->commercial_id); // This property is used in create/update only. It does not exists in read mode because there is several sales representatives.
 
    unset($object->total_ht);
    unset($object->total_tva);
    unset($object->total_localtax1);
    unset($object->total_localtax2);
    unset($object->total_ttc);
 
    unset($object->lines);
    unset($object->thirdparty);
 
    unset($object->fk_delivery_address); // deprecated feature
 
    return $object;
  }
 
  private function _validate($data)
  {
    $thirdparty = array();
    foreach (Thirdparties::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $thirdparty[$field] = $data[$field];
    }
    return $thirdparty;
  }
 
  private function _fetch($rowid, $ref = '', $ref_ext = '', $barcode = '', $idprof1 = '', $idprof2 = '', $idprof3 = '', $idprof4 = '', $idprof5 = '', $idprof6 = '', $email = '', $ref_alias = '')
  {
    global $conf;
 
    if (!DolibarrApiAccess::$user->hasRight('societe', 'lire')) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login.'. No read permission on thirdparties.');
    }
 
    if ($rowid === 0) {
      $result = $this->company->initAsSpecimen();
    } else {
      $result = $this->company->fetch($rowid, $ref, $ref_ext, $barcode, $idprof1, $idprof2, $idprof3, $idprof4, $idprof5, $idprof6, $email, $ref_alias);
    }
    if (!$result) {
      throw new RestException(404, 'Thirdparty not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('societe', $this->company->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login.' on this thirdparty');
    }
    if (isModEnabled('mailing')) {
      $this->company->getNoEmail();
    }
 
    if (getDolGlobalString('FACTURE_DEPOSITS_ARE_JUST_PAYMENTS')) {
      $filterabsolutediscount = "fk_facture_source IS NULL"; // If we want deposit to be substracted to payments only and not to total of final invoice
      $filtercreditnote = "fk_facture_source IS NOT NULL"; // If we want deposit to be substracted to payments only and not to total of final invoice
    } else {
      $filterabsolutediscount = "fk_facture_source IS NULL OR (description LIKE '(DEPOSIT)%' AND description NOT LIKE '(EXCESS RECEIVED)%')";
      $filtercreditnote = "fk_facture_source IS NOT NULL AND (description NOT LIKE '(DEPOSIT)%' OR description LIKE '(EXCESS RECEIVED)%')";
    }
 
    $absolute_discount = $this->company->getAvailableDiscounts('', $filterabsolutediscount);
    $absolute_creditnote = $this->company->getAvailableDiscounts('', $filtercreditnote);
    $this->company->absolute_discount = price2num($absolute_discount, 'MT');
    $this->company->absolute_creditnote = price2num($absolute_creditnote, 'MT');
 
    return $this->_cleanObjectDatas($this->company);
  }
}