api_invoices.class.php

<?php
/* Copyright (C) 2015     Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2020     Thibault FOUCART    <support@ptibogxiv.net>
 * Copyright (C) 2023   Joachim Kueter      <git-jk@bloxera.com>
 * Copyright (C) 2024-2025  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2024-2026  MDW           <mdeweerd@users.noreply.github.com>
 * 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/facture/class/facture.class.php';
require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture-rec.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
 
 
class Invoices extends DolibarrApi
{
  public static $FIELDS = array(
    'socid',
  );
 
  private $invoice;
 
  private $template_invoice;
 
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
    $this->invoice = new Facture($this->db);
    $this->template_invoice = new FactureRec($this->db);
  }
 
  public function get($id, $contact_list = 1, $properties = '', $withLines = true)
  {
    $invoice = $this->_fetch($id, '', '', $contact_list);
 
    if (!$withLines) {
      unset($invoice->lines);
    }
 
    return $this->_filterObjectProperties($invoice, $properties);
  }
 
  public function getByRef($ref, $contact_list = 1)
  {
    return $this->_fetch(0, $ref, '', $contact_list);
  }
 
  public function getByRefExt($ref_ext, $contact_list = 1)
  {
    return $this->_fetch(0, '', $ref_ext, $contact_list);
  }
 
  private function _fetch($id, $ref = '', $ref_ext = '', $contact_list = 1)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
    if (empty($id) && empty($ref) && empty($ref_ext)) {
      throw new RestException(400, 'No invoice can be found with no criteria');
    }
    $result = $this->invoice->fetch($id, $ref, $ref_ext);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    // Get payment details
    $this->invoice->totalpaid = $this->invoice->getSommePaiement();
    $this->invoice->totalcreditnotes = $this->invoice->getSumCreditNotesUsed();
    $this->invoice->totaldeposits = $this->invoice->getSumDepositsUsed();
    $this->invoice->remaintopay = price2num($this->invoice->total_ttc - $this->invoice->totalpaid - $this->invoice->totalcreditnotes - $this->invoice->totaldeposits, 'MT');
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    // Retrieve credit note ids
    $this->invoice->getListIdAvoirFromInvoice();
 
    // Add external contacts ids
    if ($contact_list > -1) {
      $tmparray = $this->invoice->liste_contact(-1, 'external', $contact_list);
      if (is_array($tmparray)) {
        $this->invoice->contacts_ids = $tmparray;
      }
      $tmparray = $this->invoice->liste_contact(-1, 'internal', $contact_list);
      if (is_array($tmparray)) {
        $this->invoice->contacts_ids = $tmparray;
      }
    }
 
    $this->invoice->fetchObjectLinked();
 
    // Add online_payment_url, copied from order
    require_once DOL_DOCUMENT_ROOT.'/core/lib/payments.lib.php';
    $this->invoice->online_payment_url = getOnlinePaymentUrl(0, 'invoice', (string) $this->invoice->ref);
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $status = '', $sqlfilters = '', $properties = '', $pagination_data = false, $loadlinkedobjects = 0, $withLines = true)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
 
    $obj_ret = array();
 
    // case of external user, $thirdparty_ids param is ignored and replaced by user's socid
    $socids = DolibarrApiAccess::$user->socid ?: $thirdparty_ids;
 
    // If the internal user must only see his customers, force searching by him
    $search_sale = 0;
    if (!DolibarrApiAccess::$user->hasRight('societe', 'client', 'voir') && !$socids) {
      $search_sale = DolibarrApiAccess::$user->id;
    }
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."facture AS t";
    $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe AS s ON (s.rowid = t.fk_soc)";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."facture_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
    $sql .= ' WHERE t.entity IN ('.getEntity('invoice').')';
    if ($socids) {
      $sql .= " AND t.fk_soc IN (".$this->db->sanitize($socids).")";
    }
    // Search on sale representative
    if ($search_sale && $search_sale != '-1') {
      if ($search_sale == -2) {
        $sql .= " AND ".getSalesRepresentativeSqlFilter('t.fk_soc', 0, 1);
      } elseif ($search_sale > 0) {
        $sql .= " AND ".getSalesRepresentativeSqlFilter('t.fk_soc', (int) $search_sale);
      }
    }
    // Filter by status
    if ($status == 'draft') {
      $sql .= " AND t.fk_statut IN (0)";
    }
    if ($status == 'unpaid') {
      $sql .= " AND t.fk_statut IN (1)";
    }
    if ($status == 'paid') {
      $sql .= " AND t.fk_statut IN (2)";
    }
    if ($status == 'cancelled') {
      $sql .= " AND t.fk_statut IN (3)";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    //this query will return total invoices with the filters given
    $sqlTotals = str_replace('SELECT t.rowid', 'SELECT count(t.rowid) as total', $sql);
 
    $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) {
      $i = 0;
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $invoice_static = new Facture($this->db);
        if ($invoice_static->fetch($obj->rowid) > 0) {
          // Get payment details
          $invoice_static->totalpaid = $invoice_static->getSommePaiement();
          $invoice_static->totalcreditnotes = $invoice_static->getSumCreditNotesUsed();
          $invoice_static->totaldeposits = $invoice_static->getSumDepositsUsed();
          $invoice_static->remaintopay = price2num($invoice_static->total_ttc - $invoice_static->totalpaid - $invoice_static->totalcreditnotes - $invoice_static->totaldeposits, 'MT');
 
          // Retrieve credit note ids
          $invoice_static->getListIdAvoirFromInvoice();
 
          // Add external contacts ids
          $tmparray = $invoice_static->liste_contact(-1, 'external', 1);
          if (is_array($tmparray)) {
            $invoice_static->contacts_ids = $tmparray;
          }
 
          if ($loadlinkedobjects) {
            // retrieve linked objects
            $invoice_static->fetchObjectLinked();
          }
 
          if (!$withLines) {
            unset($invoice_static->lines);
          }
 
          // Add online_payment_url, copied from order
          require_once DOL_DOCUMENT_ROOT.'/core/lib/payments.lib.php';
          $invoice_static->online_payment_url = getOnlinePaymentUrl(0, 'invoice', (string) $invoice_static->ref);
 
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($invoice_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve invoice list : '.$this->db->lasterror());
    }
 
    //if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
    if ($pagination_data) {
      $totalsResult = $this->db->query($sqlTotals);
      $total = $this->db->fetch_object($totalsResult)->total;
 
      $tmp = $obj_ret;
      $obj_ret = [];
 
      $obj_ret['data'] = $tmp;
      $obj_ret['pagination'] = [
        'total' => (int) $total,
        'page' => $page, //count starts from 0
        'page_count' => ceil((int) $total / $limit),
        'limit' => $limit
      ];
    }
 
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    global $conf;
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403, "Insufficiant rights");
    }
 
    if (!is_array($request_data)) {
      $request_data = array();
    }
 
    // Check mandatory fields (not using output, only possible exception is important)
    $this->_validate($request_data);
 
    // Check thirdparty validity
    $socid = (int) $request_data['socid'];
    $thirdpartytmp = new Societe($this->db);
    $thirdparty_result = $thirdpartytmp->fetch($socid);
    if ($thirdparty_result < 1) {
      throw new RestException(404, 'Thirdparty with id='.$socid.' not found or not allowed');
    }
    if (!DolibarrApi::_checkAccessToResource('societe', $thirdpartytmp->id)) {
      throw new RestException(404, 'Thirdparty with id='.$thirdpartytmp->id.' not found or not allowed');
    }
 
    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
        $this->invoice->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
      if ($field == 'id') {
        throw new RestException(400, 'Creating with id field is forbidden');
      }
      if ($field == 'entity' && ((int) $value) != ((int) $conf->entity)) {
        throw new RestException(403, 'Creating with entity='.((int) $value).' MUST be the same entity='.((int) $conf->entity).' as your API user/key belongs to');
      }
 
      $this->invoice->$field = $this->_checkValForAPI($field, $value, $this->invoice);
    }
    if (!array_key_exists('date', $request_data)) {
      $this->invoice->date = dol_now();
    }
    /* We keep lines as an array
     if (isset($request_data["lines"])) {
      $lines = array();
      foreach ($request_data["lines"] as $line) {
        array_push($lines, (object) $line);
      }
      $this->invoice->lines = $lines;
    }*/
 
    if ($this->invoice->create(DolibarrApiAccess::$user, 0, (empty($request_data["date_lim_reglement"]) ? 0 : $request_data["date_lim_reglement"])) < 0) {
      throw new RestException(500, "Error creating invoice", array_merge(array($this->invoice->error), $this->invoice->errors));
    }
    return ((int) $this->invoice->id);
  }
 
  public function createInvoiceFromOrder($orderid)
  {
    require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
 
    if (!DolibarrApiAccess::$user->hasRight('commande', 'lire')) {
      throw new RestException(403);
    }
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    if (empty($orderid)) {
      throw new RestException(400, 'Order ID is mandatory');
    }
    if (!DolibarrApi::_checkAccessToResource('commande', $orderid)) {
      throw new RestException(403, 'Access not allowed on order for login '.DolibarrApiAccess::$user->login);
    }
 
    $order = new Commande($this->db);
    $result = $order->fetch($orderid);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }
 
    // Refuse orders that cannot be billed, to mirror the GUI (order card "CreateBill" button and list mass action):
    // this excludes draft and canceled orders, as well as orders already classified as billed.
    if ($order->status <= Commande::STATUS_DRAFT || !empty($order->billed)) {
      throw new RestException(405, 'Order '.$order->ref.' is not eligible for invoicing: its status does not allow creating an invoice');
    }
 
    $result = $this->invoice->createFromOrder($order, DolibarrApiAccess::$user);
    if ($result < 0) {
      throw new RestException(405, $this->invoice->error);
    }
    $this->invoice->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->invoice);
  }
 
  public function createInvoiceFromContract($contractid)
  {
    require_once DOL_DOCUMENT_ROOT.'/contrat/class/contrat.class.php';
 
    if (!DolibarrApiAccess::$user->hasRight('contrat', 'lire')) {
      throw new RestException(403);
    }
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    if (empty($contractid)) {
      throw new RestException(400, 'Contract ID is mandatory');
    }
 
    $contract = new Contrat($this->db);
    $result = $contract->fetch($contractid);
    if (!$result) {
      throw new RestException(404, 'Contract not found');
    }
 
    $result = $this->invoice->createFromContract($contract, DolibarrApiAccess::$user);
    if ($result < 0) {
      throw new RestException(405, $this->invoice->error);
    }
    $this->invoice->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->invoice);
  }
 
  public function getLines($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $this->invoice->getLinesArray();
    $result = array();
    foreach ($this->invoice->lines as $line) {
      array_push($result, $this->_cleanObjectDatas($line));
    }
    return $result;
  }
 
  public function putLine($id, $lineid, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $request_data = (object) $request_data;
 
    $request_data->desc = sanitizeVal($request_data->desc, 'restricthtml');
    $request_data->label = sanitizeVal($request_data->label);
 
    $updateRes = $this->invoice->updateline(
      $lineid,
      $request_data->desc,
      $request_data->subprice,
      $request_data->qty,
      $request_data->remise_percent,
      $request_data->date_start,
      $request_data->date_end,
      $request_data->tva_tx,
      $request_data->localtax1_tx,
      $request_data->localtax2_tx,
      $request_data->price_base_type ? $request_data->price_base_type : 'HT',
      $request_data->info_bits,
      $request_data->product_type,
      $request_data->fk_parent_line,
      0,
      $request_data->fk_fournprice,
      $request_data->pa_ht,
      $request_data->label,
      $request_data->special_code,
      $request_data->array_options,
      $request_data->situation_percent,
      $request_data->fk_unit,
      $request_data->multicurrency_subprice,
      0,
      $request_data->ref_ext,
      $request_data->rang
    );
 
    if ($updateRes > 0) {
      $result = $this->get($id);
      unset($result->line);
      return $this->_cleanObjectDatas($result);
    } else {
      throw new RestException(304, $this->invoice->error);
    }
  }
 
  public function postContact($id, $contactid, $type, $source = 'external', $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
 
    // test source
    if (empty($source)) {
      throw new RestException(400, 'Source can not be empty');
    }
    $sql_distinct_source = "SELECT DISTINCT source";
    $sql_distinct_source .= " FROM ".MAIN_DB_PREFIX."c_type_contact";
    $sql_distinct_source .= " WHERE element LIKE 'facture'";
    $sql_distinct_source .= " AND source is NOT NULL";
    $sql_distinct_source .= " AND active != 0";
    $source_result = $this->db->query($sql_distinct_source);
    $source_array = array();
 
    if ($source_result) {
      $num = $this->db->num_rows($source_result);
      $i = 0;
      while ($i < $num) {
        $obj = $this->db->fetch_object($source_result);
        $source_kind = (string) $obj->source;
        array_push($source_array, $source_kind);
        dol_syslog("source_kind=".$source_kind);
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieving a list of invoice contact sources: '.$this->db->lasterror());
    }
    if (!in_array($source, (array) $source_array, true)) {
      throw new RestException(400, 'Combo of Source='.$source.' and Type='.$type.' not found in dictionary with active invoice contact types');
    }
 
    // test type
    if (empty($type)) {
      throw new RestException(400, 'type can not be empty');
    }
    // variable called type here, but code in dictionary and database
    $sql_distinct_type = "SELECT DISTINCT code";
    $sql_distinct_type .= " FROM ".MAIN_DB_PREFIX."c_type_contact";
    $sql_distinct_type .= " WHERE element LIKE 'facture'";
    $sql_distinct_type .= " AND source='".$this->db->escape($source)."'";
    $sql_distinct_type .= " AND code is NOT NULL";
    $sql_distinct_type .= " AND active != 0";
    $type_result = $this->db->query($sql_distinct_type);
    $type_array = array();
 
    if ($type_result) {
      $num = $this->db->num_rows($type_result);
      $i = 0;
      while ($i < $num) {
        $obj = $this->db->fetch_object($type_result);
        // variable called type here, but code in dictionary and database
        $type_kind = (string) $obj->code;
        array_push($type_array, $type_kind);
        dol_syslog("type_kind=".$type_kind);
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieving a list of invoice contact types: '.$this->db->lasterror());
    }
    if (!in_array($type, (array) $type_array, true)) {
      throw new RestException(400, 'Combo of Type='.$type.' and Source='.$source.' not found in dictionary with active invoice contact types');
    }
 
    // tests done, let's get it
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
    if (!DolibarrApi::_checkAccessToResource('invoice', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->add_contact($contactid, $type, $source, $notrigger);
 
    if ($result == 0) {
      throw new RestException(400, 'Already exists: Contact='.$contactid.' is already linked to the invoice='.$id.' as source='.$source.' and type='.$type);
    } elseif ($result == -1) {
      throw new RestException(400, 'Wrong contact='.$contactid);
    } elseif ($result == -2) {
      throw new RestException(400, 'Wrong type='.$type);
    } elseif ($result == -3) {
      throw new RestException(400, 'Not allowed contacts');
    } elseif ($result == -4) {
      throw new RestException(400, 'ErrorCommercialNotAllowedForThirdparty');
    } elseif ($result == -5) {
      throw new RestException(400, 'Trigger failed');
    } elseif ($result == -6) {
      throw new RestException(400, 'DB_ERROR_RECORD_ALREADY_EXISTS');
    } elseif ($result == -7) {
      throw new RestException(400, 'Some other error');
    }
 
    if (!$result) {
      throw new RestException(500, 'Error when added the contact');
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Contact='.$contactid.' linked to the invoice='.$id.' as '.$source.' '.$type
      )
    );
  }
 
  public function getContacts($id, $type = '')
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $contacts = $this->invoice->liste_contact(-1, 'external', 0, $type);
    $socpeoples = $this->invoice->liste_contact(-1, 'internal', 0, $type);
 
    $contacts = array_merge($contacts, $socpeoples);
 
    return $contacts;
  }
 
  public function deleteContact($id, $contactid, $type)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->invoice->fetch($id);
 
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('invoice', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $contacts = $this->invoice->liste_contact();
 
    foreach ($contacts as $contact) {
      if ($contact['id'] == $contactid && $contact['code'] == $type) {
        $result = $this->invoice->delete_contact($contact['rowid']);
 
        if (!$result) {
          throw new RestException(500, 'Error when deleted the contact');
        }
      }
    }
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
  public function deleteLine($id, $lineid)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    if (empty($lineid)) {
      throw new RestException(400, 'Line ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
    if ($this->invoice->status != 0) {
      throw new RestException(403, 'Invoice not in Draft Status : '.$this->invoice->getLibStatut(1));
    }
 
    $updateRes = $this->invoice->deleteLine($lineid, $id);
    if ($updateRes > 0) {
      return $this->get($id);
    } else {
      throw new RestException(405, $this->invoice->error);
    }
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    if ($id == 0) {
      throw new RestException(400, 'No invoice with id=0 can exist');
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, '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 with the caller
        $this->invoice->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $this->invoice->array_options[$index] = $this->_checkValExtrafieldsForAPI($index, $val, $this->invoice);
        }
        continue;
      }
 
      $this->invoice->$field = $this->_checkValForAPI($field, $value, $this->invoice);
 
      // If cond reglement => update date lim reglement
      if ($field == 'cond_reglement_id') {
        $this->invoice->date_lim_reglement = $this->invoice->calculate_date_lim_reglement();
      }
    }
 
    // update bank account
    if (!empty($this->invoice->fk_account)) {
      if ($this->invoice->setBankAccount((int) $this->invoice->fk_account) == 0) {
        throw new RestException(400, $this->invoice->error);
      }
    }
 
    if ($this->invoice->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->invoice->error);
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'supprimer')) {
      throw new RestException(403);
    }
    if ($id == 0) {
      throw new RestException(400, 'No invoice with id=0 can exist');
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->delete(DolibarrApiAccess::$user);
    if ($result < 0) {
      throw new RestException(500, 'Error when deleting invoice');
    } elseif ($result == 0) {
      throw new RestException(403, 'Invoice not erasable');
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Invoice deleted'
      )
    );
  }
 
  public function postLine($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $request_data = (object) $request_data;
 
    $request_data->desc = sanitizeVal($request_data->desc, 'restricthtml');
    $request_data->label = sanitizeVal($request_data->label);
 
    // Reset fk_parent_line for no child products and special product
    if (($request_data->product_type != 9 && empty($request_data->fk_parent_line)) || $request_data->product_type == 9) {
      $request_data->fk_parent_line = 0;
    }
 
    // calculate pa_ht
    $marginInfos = getMarginInfos($request_data->subprice, $request_data->remise_percent, $request_data->tva_tx, $request_data->localtax1_tx, $request_data->localtax2_tx, $request_data->fk_fournprice, $request_data->pa_ht);
    $pa_ht = $marginInfos[0];
 
    $updateRes = $this->invoice->addline(
      $request_data->desc,
      $request_data->subprice,
      $request_data->qty,
      $request_data->tva_tx,
      $request_data->localtax1_tx,
      $request_data->localtax2_tx,
      $request_data->fk_product,
      $request_data->remise_percent,
      $request_data->date_start,
      $request_data->date_end,
      $request_data->fk_code_ventilation,
      $request_data->info_bits,
      $request_data->fk_remise_except,
      $request_data->price_base_type ? $request_data->price_base_type : 'HT',
      $request_data->subprice,
      $request_data->product_type,
      $request_data->rang,
      $request_data->special_code,
      $request_data->origin,
      $request_data->origin_id,
      $request_data->fk_parent_line,
      empty($request_data->fk_fournprice) ? null : $request_data->fk_fournprice,
      $pa_ht,
      $request_data->label,
      $request_data->array_options,
      $request_data->situation_percent,
      $request_data->fk_prev_id,
      $request_data->fk_unit,
      0,
      $request_data->ref_ext
    );
 
    if ($updateRes < 0) {
      throw new RestException(400, 'Unable to insert the new line. Check your inputs. '.$this->invoice->error);
    }
 
    return $updateRes;
  }
 
  public function addContact($id, $fk_socpeople, $type_contact, $source, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->add_contact($fk_socpeople, $type_contact, $source, $notrigger);
    if ($result < 0) {
      throw new RestException(500, 'Error : '.$this->invoice->error);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    // test already done
    // if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
    //  throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    // }
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
 
 
  public function settodraft($id, $idwarehouse = -1)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->setDraft(DolibarrApiAccess::$user, $idwarehouse);
    if ($result == 0) {
      throw new RestException(304, 'Nothing done.');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error : '.$this->invoice->error);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
 
  public function validate($id, $force_number = '', $idwarehouse = 0, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->validate(DolibarrApiAccess::$user, $force_number, $idwarehouse, $notrigger);
    if ($result == 0) {
      throw new RestException(304, 'Error nothing done. May be object is already validated');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when validating Invoice: '.$this->invoice->error);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    // test already done
    // if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
    //  throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    // }
 
    // copy from order
    require_once DOL_DOCUMENT_ROOT.'/core/lib/payments.lib.php';
    $this->invoice->online_payment_url = getOnlinePaymentUrl(0, 'invoice', (string) $this->invoice->ref);
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
  public function settopaid($id, $close_code = '', $close_note = '')
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->setPaid(DolibarrApiAccess::$user, $close_code, $close_note);
    if ($result == 0) {
      throw new RestException(304, 'Error nothing done. May be object is already validated');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error : '.$this->invoice->error);
    }
 
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    // test already done
    // if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
    //  throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    // }
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
 
  public function settounpaid($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->setUnpaid(DolibarrApiAccess::$user);
    if ($result == 0) {
      throw new RestException(304, 'Nothing done');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error : '.$this->invoice->error);
    }
 
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    // test already done
    // if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
    //  throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    // }
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
  public function getDiscount($id)
  {
    require_once DOL_DOCUMENT_ROOT.'/core/class/discount.class.php';
 
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $discountcheck = new DiscountAbsolute($this->db);
    $result = $discountcheck->fetch(0, $this->invoice->id);
 
    if ($result == 0) {
      throw new RestException(404, 'Discount not found');
    }
    if ($result < 0) {
      throw new RestException(500, $discountcheck->error);
    }
 
    return parent::_cleanObjectDatas($discountcheck);
  }
 
  public function markAsCreditAvailable($id)
  {
    require_once DOL_DOCUMENT_ROOT.'/core/class/discount.class.php';
 
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if ($this->invoice->paye) {   // TODO Replace by a test on status
      throw new RestException(500, 'Alreay paid');
    }
 
    $this->invoice->fetch($id);
    $this->invoice->fetch_thirdparty();
 
    // Check if there is already a discount (protection to avoid duplicate creation when resubmit post)
    $discountcheck = new DiscountAbsolute($this->db);
    $result = $discountcheck->fetch(0, $this->invoice->id);
 
    $canconvert = 0;
    if ($this->invoice->type == Facture::TYPE_DEPOSIT && empty($discountcheck->id)) {
      $canconvert = 1; // we can convert deposit into discount if deposit is paid (completely, partially or not at all) and not already converted (see real condition into condition used to show button converttoreduc)
    }
    if (($this->invoice->type == Facture::TYPE_CREDIT_NOTE || $this->invoice->type == Facture::TYPE_STANDARD) && $this->invoice->paye == 0 && empty($discountcheck->id)) {
      $canconvert = 1; // we can convert credit note into discount if credit note is not paid back and not already converted and amount of payment is 0 (see real condition into condition used to show button converttoreduc)
    }
    if ($canconvert) {
      $this->db->begin();
 
      $amount_ht = $amount_tva = $amount_ttc = array();
      $multicurrency_amount_ht = $multicurrency_amount_tva = $multicurrency_amount_ttc = array();
      '
      @phan-var-force array<string,float> $amount_ht
      @phan-var-force array<string,float> $amount_tva
      @phan-var-force array<string,float> $amount_ttc
      @phan-var-force array<string,float> $multicurrency_amount_ht
      @phan-var-force array<string,float> $multicurrency_amount_tva
      @phan-var-force array<string,float> $multicurrency_amount_ttc
      ';
 
      // Loop on each vat rate
      $i = 0;
      foreach ($this->invoice->lines as $line) {
        if ($line->product_type < 9 && $line->total_ht != 0) { // Remove lines with product_type greater than or equal to 9
          if (!array_key_exists($line->tva_tx, $amount_ht)) {
            $amount_ht[$line->tva_tx] = 0.0;
            $amount_tva[$line->tva_tx] = 0.0;
            $amount_ttc[$line->tva_tx] = 0.0;
            $multicurrency_amount_ht[$line->tva_tx] = 0.0;
            $multicurrency_amount_tva[$line->tva_tx] = 0.0;
            $multicurrency_amount_ttc[$line->tva_tx] = 0.0;
          }
          // no need to create discount if amount is null
          $amount_ht[$line->tva_tx] += $line->total_ht;
          $amount_tva[$line->tva_tx] += $line->total_tva;
          $amount_ttc[$line->tva_tx] += $line->total_ttc;
          $multicurrency_amount_ht[$line->tva_tx] += $line->multicurrency_total_ht;
          $multicurrency_amount_tva[$line->tva_tx] += $line->multicurrency_total_tva;
          $multicurrency_amount_ttc[$line->tva_tx] += $line->multicurrency_total_ttc;
          $i++;
        }
      }
 
      // Insert one discount by VAT rate category
      $discount = new DiscountAbsolute($this->db);
      if ($this->invoice->type == Facture::TYPE_CREDIT_NOTE) {
        $discount->description = '(CREDIT_NOTE)';
      } elseif ($this->invoice->type == Facture::TYPE_DEPOSIT) {
        $discount->description = '(DEPOSIT)';
      } elseif ($this->invoice->type == Facture::TYPE_STANDARD || $this->invoice->type == Facture::TYPE_REPLACEMENT || $this->invoice->type == Facture::TYPE_SITUATION) {
        $discount->description = '(EXCESS RECEIVED)';
      } else {
        throw new RestException(500, 'Cant convert to reduc an Invoice of this type');
      }
 
      $discount->fk_soc = $this->invoice->socid;
      $discount->socid = $this->invoice->socid;
      $discount->fk_facture_source = $this->invoice->id;
 
      $error = 0;
 
      if ($this->invoice->type == Facture::TYPE_STANDARD || $this->invoice->type == Facture::TYPE_REPLACEMENT || $this->invoice->type == Facture::TYPE_SITUATION) {
        // If we're on a standard invoice, we have to get excess received to create a discount in TTC without VAT
 
        // Total payments
        $sql = 'SELECT SUM(pf.amount) as total_payments';
        $sql .= ' FROM '.MAIN_DB_PREFIX.'paiement_facture as pf, '.MAIN_DB_PREFIX.'paiement as p';
        $sql .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_paiement as c ON p.fk_paiement = c.id';
        $sql .= ' WHERE pf.fk_facture = '.((int) $this->invoice->id);
        $sql .= ' AND pf.fk_paiement = p.rowid';
        $sql .= ' AND p.entity IN ('.getEntity('invoice').')';
        $resql = $this->db->query($sql);
        if (!$resql) {
          dol_print_error($this->db);
        }
 
        $res = $this->db->fetch_object($resql);
        $total_payments = $res->total_payments;
 
        // Total credit note and deposit
        $total_creditnote_and_deposit = 0;
        $sql = "SELECT re.rowid, re.amount_ht, re.amount_tva, re.amount_ttc,";
        $sql .= " re.description, re.fk_facture_source";
        $sql .= " FROM ".MAIN_DB_PREFIX."societe_remise_except as re";
        $sql .= " WHERE fk_facture = ".((int) $this->invoice->id);
        $resql = $this->db->query($sql);
        if (!empty($resql)) {
          while ($obj = $this->db->fetch_object($resql)) {
            $total_creditnote_and_deposit += $obj->amount_ttc;
          }
        } else {
          dol_print_error($this->db);
        }
 
        $discount->amount_ht = $discount->amount_ttc = $total_payments + $total_creditnote_and_deposit - $this->invoice->total_ttc;
        $discount->total_ht = $discount->total_ttc = $total_payments + $total_creditnote_and_deposit - $this->invoice->total_ttc;
        $discount->amount_tva = 0;
        $discount->total_tva = 0;
        $discount->tva_tx = 0;
 
        $result = $discount->create(DolibarrApiAccess::$user);
        if ($result < 0) {
          $error++;
        }
      }
      if ($this->invoice->type == Facture::TYPE_CREDIT_NOTE || $this->invoice->type == Facture::TYPE_DEPOSIT) {
        foreach ($amount_ht as $tva_tx => $xxx) {
          $discount->amount_ht = abs($amount_ht[$tva_tx]);
          $discount->amount_tva = abs($amount_tva[$tva_tx]);
          $discount->amount_ttc = abs($amount_ttc[$tva_tx]);
          $discount->total_ht = abs($amount_ht[$tva_tx]);
          $discount->total_tva = abs($amount_tva[$tva_tx]);
          $discount->total_ttc = abs($amount_ttc[$tva_tx]);
          $discount->multicurrency_amount_ht = abs($multicurrency_amount_ht[$tva_tx]);
          $discount->multicurrency_amount_tva = abs($multicurrency_amount_tva[$tva_tx]);
          $discount->multicurrency_amount_ttc = abs($multicurrency_amount_ttc[$tva_tx]);
          $discount->multicurrency_total_ht = abs($multicurrency_amount_ht[$tva_tx]);
          $discount->multicurrency_total_tva = abs($multicurrency_amount_tva[$tva_tx]);
          $discount->multicurrency_total_ttc = abs($multicurrency_amount_ttc[$tva_tx]);
          $discount->tva_tx = abs((float) $tva_tx);
 
          $result = $discount->create(DolibarrApiAccess::$user);
          if ($result < 0) {
            $error++;
            break;
          }
        }
      }
 
      if (empty($error)) {
        if ($this->invoice->type != Facture::TYPE_DEPOSIT) {
          // Set the invoice as paid
          $result = $this->invoice->setPaid(DolibarrApiAccess::$user);
          if ($result >= 0) {
            $this->db->commit();
          } else {
            $this->db->rollback();
            throw new RestException(500, 'Could not set paid');
          }
        } else {
          $this->db->commit();
        }
      } else {
        $this->db->rollback();
        throw new RestException(500, 'Discount creation error');
      }
    }
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
  public function useDiscount($id, $discountid)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    if (empty($id)) {
      throw new RestException(400, 'Invoice ID is mandatory');
    }
    if (empty($discountid)) {
      throw new RestException(400, 'Discount ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    $result = $this->invoice->insert_discount($discountid);
    if ($result < 0) {
      throw new RestException(405, $this->invoice->error);
    }
 
    return $result;
  }
 
  public function useCreditNote($id, $discountid)
  {
    require_once DOL_DOCUMENT_ROOT.'/core/class/discount.class.php';
 
    if (!DolibarrApiAccess::$user->hasRight('facture', 'creer')) {
      throw new RestException(403);
    }
    if (empty($id)) {
      throw new RestException(400, 'Invoice ID is mandatory');
    }
    if (empty($discountid)) {
      throw new RestException(400, 'Credit ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $discount = new DiscountAbsolute($this->db);
    $result = $discount->fetch($discountid);
    if (!$result) {
      throw new RestException(404, 'Credit not found');
    }
 
    $result = $discount->link_to_invoice(0, $id);
    if ($result < 0) {
      throw new RestException(405, $discount->error);
    }
 
    return $result;
  }
 
  public function getPayments($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
    if (empty($id)) {
      throw new RestException(400, 'Invoice ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    $result = $this->invoice->getListOfPayments();
    if (!is_array($result) && $result < 0) {
      throw new RestException(405, $this->invoice->error);
    }
 
    return $result;
  }
 
 
  public function addPayment($id, $datepaye, $paymentid, $closepaidinvoices, $accountid, $num_payment = '', $comment = '', $chqemetteur = '', $chqbank = '')
  {
    require_once DOL_DOCUMENT_ROOT.'/compta/paiement/class/paiement.class.php';
 
    if (!DolibarrApiAccess::$user->hasRight('facture', 'paiement')) {
      throw new RestException(403);
    }
    if (empty($id)) {
      throw new RestException(400, 'Invoice ID is mandatory');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facture', $id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (isModEnabled("bank")) {
      if (empty($accountid)) {
        throw new RestException(400, 'Account ID is mandatory');
      }
    }
 
    if (empty($paymentid)) {
      throw new RestException(400, 'Payment ID or Payment Code is mandatory');
    }
 
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    // Calculate amount to pay
    $totalpaid = $this->invoice->getSommePaiement();
    $totalcreditnotes = $this->invoice->getSumCreditNotesUsed();
    $totaldeposits = $this->invoice->getSumDepositsUsed();
 
    $this->db->begin();
 
    $amounts = array();
    $multicurrency_amounts = array();
 
    // Clean parameters amount if payment is for a credit note
    if ($this->invoice->type == Facture::TYPE_CREDIT_NOTE) {
      $resteapayer = price2num($this->invoice->total_ttc + $totalpaid - $totalcreditnotes - $totaldeposits, 'MT');
      $amounts[$id] = (float) price2num(-1 * abs((float) $resteapayer), 'MT');
      // Multicurrency
      $newvalue = price2num($this->invoice->multicurrency_total_ttc, 'MT');
      $multicurrency_amounts[$id] = (float) price2num(-1 * (float) $newvalue, 'MT');
    } else {
      $resteapayer = price2num($this->invoice->total_ttc - $totalpaid - $totalcreditnotes - $totaldeposits, 'MT');
      $amounts[$id] = (float) $resteapayer;
      // Multicurrency
      $newvalue = price2num($this->invoice->multicurrency_total_ttc, 'MT');
      $multicurrency_amounts[$id] = (float) $newvalue;
    }
 
    // Creation of payment line
    $paymentobj = new Paiement($this->db);
    if (is_numeric($datepaye)) {
      $paymentobj->datepaye = $datepaye;
    } else {
      $paymentobj->datepaye = dol_stringtotime($datepaye);
    }
    $paymentobj->amounts      = $amounts; // Array with all payments dispatching with invoice id
    $paymentobj->multicurrency_amounts = $multicurrency_amounts; // Array with all payments dispatching
    $paymentobj->paiementid = $paymentid;
    $paymentobj->paiementcode = (string) dol_getIdFromCode($this->db, (string) $paymentid, 'c_paiement', 'id', 'code', 1);
    $paymentobj->num_payment = $num_payment;
    $paymentobj->note_private = $comment;
 
    $payment_id = $paymentobj->create(DolibarrApiAccess::$user, ($closepaidinvoices == 'yes' ? 1 : 0)); // This include closing invoices
    if ($payment_id < 0) {
      $this->db->rollback();
      throw new RestException(400, 'Payment error : '.$paymentobj->error);
    }
 
    if (isModEnabled("bank")) {
      $label = '(CustomerInvoicePayment)';
 
      if ($paymentobj->paiementcode == 'CHQ' && empty($chqemetteur)) {
        throw new RestException(400, 'Emetteur is mandatory when payment code is '.$paymentobj->paiementcode);
      }
      if ($this->invoice->type == Facture::TYPE_CREDIT_NOTE) {
        $label = '(CustomerInvoicePaymentBack)'; // Refund of a credit note
      }
      $result = $paymentobj->addPaymentToBank(DolibarrApiAccess::$user, 'payment', $label, $accountid, $chqemetteur, $chqbank);
      if ($result < 0) {
        $this->db->rollback();
        throw new RestException(400, 'Add payment to bank error : '.$paymentobj->error);
      }
    }
 
    $this->db->commit();
 
    return $payment_id;
  }
 
  public function addPaymentDistributed($arrayofamounts, $datepaye, $paymentid, $closepaidinvoices, $accountid, $num_payment = '', $comment = '', $chqemetteur = '', $chqbank = '', $ref_ext = '', $accepthigherpayment = false)
  {
    require_once DOL_DOCUMENT_ROOT.'/compta/paiement/class/paiement.class.php';
 
    if (!DolibarrApiAccess::$user->hasRight('facture', 'paiement')) {
      throw new RestException(403);
    }
    foreach ($arrayofamounts as $id => $amount) {
      if (empty($id)) {
        throw new RestException(400, 'Invoice ID is mandatory. Fill the invoice id and amount into arrayofamounts parameter. For example: {"1": "99.99", "2": "10"}');
      }
      if (!DolibarrApi::_checkAccessToResource('facture', (int) $id)) {
        throw new RestException(403, 'Access not allowed on invoice ID '.$id.' for login '.DolibarrApiAccess::$user->login);
      }
    }
 
    if (isModEnabled("bank")) {
      if (empty($accountid)) {
        throw new RestException(400, 'Account ID is mandatory');
      }
    }
    if (empty($paymentid)) {
      throw new RestException(400, 'Payment ID or Payment Code is mandatory');
    }
 
    $this->db->begin();
 
    $amounts = array();
    $multicurrency_amounts = array();
 
    // Loop on each invoice to pay
    foreach ($arrayofamounts as $id => $amountarray) {
      $id = (int) $id;  // Ensure $id is seen as int, required by function calls and array indexes.
      $result = $this->invoice->fetch($id);
      if (!$result) {
        $this->db->rollback();
        throw new RestException(404, 'Invoice ID '.$id.' not found');
      }
 
      if (($amountarray["amount"] == "remain" || $amountarray["amount"] > 0) && ($amountarray["multicurrency_amount"] == "remain" || $amountarray["multicurrency_amount"] > 0)) {
        $this->db->rollback();
        throw new RestException(400, 'Payment in both currency '.$id.' ( amount: '.$amountarray["amount"].', multicurrency_amount: '.$amountarray["multicurrency_amount"].')');
      }
 
      $is_multicurrency = 0;
      $total_ttc = $this->invoice->total_ttc;
 
      if ($amountarray["multicurrency_amount"] > 0 || $amountarray["multicurrency_amount"] == "remain") {
        $is_multicurrency = 1;
        $total_ttc = $this->invoice->multicurrency_total_ttc;
      }
 
      // Calculate amount to pay
      $totalpaid = $this->invoice->getSommePaiement($is_multicurrency);
      $totalcreditnotes = $this->invoice->getSumCreditNotesUsed($is_multicurrency);
      $totaldeposits = $this->invoice->getSumDepositsUsed($is_multicurrency);
      $remainstopay = $amount = (float) price2num($total_ttc - $totalpaid - $totalcreditnotes - $totaldeposits, 'MT');
 
      if (!$is_multicurrency && $amountarray["amount"] != 'remain') {
        $amount = (float) price2num($amountarray["amount"], 'MT');
      }
 
      if ($is_multicurrency && $amountarray["multicurrency_amount"] != 'remain') {
        $amount = (float) price2num($amountarray["multicurrency_amount"], 'MT');
      }
 
      if (abs($amount) > abs($remainstopay) && !$accepthigherpayment) {
        $this->db->rollback();
        throw new RestException(400, 'Payment amount on invoice ID '.$id.' ('.$amount.') is higher than remain to pay ('.$remainstopay.')');
      }
 
      if ($this->invoice->type == Facture::TYPE_CREDIT_NOTE) {
        $amount = (float) price2num(-1 * abs((float) $amount), 'MT');
      }
 
      if ($is_multicurrency) {
        $amounts[$id] = null;
        // Multicurrency
        $multicurrency_amounts[$id] = (float) $amount;
      } else {
        $amounts[$id] = (float) $amount;
        // Multicurrency
        $multicurrency_amounts[$id] = null;
      }
    }
 
    // Creation of payment line
    $paymentobj = new Paiement($this->db);
    if (is_numeric($datepaye)) {
      $paymentobj->datepaye = $datepaye;
    } else {
      $paymentobj->datepaye = dol_stringtotime($datepaye);
    }
    $paymentobj->amounts      = $amounts; // Array with all payments dispatching with invoice id
    $paymentobj->multicurrency_amounts = $multicurrency_amounts; // Array with all payments dispatching
    $paymentobj->paiementid   = $paymentid;
    $paymentobj->paiementcode = (string) dol_getIdFromCode($this->db, (string) $paymentid, 'c_paiement', 'id', 'code', 1);
    $paymentobj->num_payment  = $num_payment;
    $paymentobj->note_private = $comment;
    $paymentobj->ref_ext      = $ref_ext;
    $payment_id = $paymentobj->create(DolibarrApiAccess::$user, ($closepaidinvoices == 'yes' ? 1 : 0)); // This include closing invoices
    if ($payment_id < 0) {
      $this->db->rollback();
      throw new RestException(400, 'Payment error : '.$paymentobj->error);
    }
    if (isModEnabled("bank")) {
      $label = '(CustomerInvoicePayment)';
      if ($paymentobj->paiementcode == 'CHQ' && empty($chqemetteur)) {
        throw new RestException(400, 'Emetteur is mandatory when payment code is '.$paymentobj->paiementcode);
      }
      if ($this->invoice->type == Facture::TYPE_CREDIT_NOTE) {
        $label = '(CustomerInvoicePaymentBack)'; // Refund of a credit note
      }
      $result = $paymentobj->addPaymentToBank(DolibarrApiAccess::$user, 'payment', $label, $accountid, $chqemetteur, $chqbank);
      if ($result < 0) {
        $this->db->rollback();
        throw new RestException(400, 'Add payment to bank error : '.$paymentobj->error);
      }
    }
 
    $this->db->commit();
 
    return $payment_id;
  }
 
  public function putPayment($id, $num_payment = '')
  {
    require_once DOL_DOCUMENT_ROOT.'/compta/paiement/class/paiement.class.php';
 
    if (!DolibarrApiAccess::$user->hasRight('facture', 'paiement')) {
      throw new RestException(403);
    }
    if (empty($id)) {
      throw new RestException(400, 'Payment ID is mandatory');
    }
 
    $paymentobj = new Paiement($this->db);
    $result = $paymentobj->fetch($id);
 
    if (!$result) {
      throw new RestException(404, 'Payment not found');
    }
 
    // Check all invoices of the payment to see if the user has permission on them for the object level permission test
    $tmparray = $paymentobj->getBillsArray();
    foreach ($tmparray as $tmpinvoiceid) {
      if (!DolibarrApi::_checkAccessToResource('facture', $tmpinvoiceid)) {
        throw new RestException(403, 'Payment is on invoices that are not all allowed for login '.DolibarrApiAccess::$user->login);
      }
    }
 
    if (!empty($num_payment)) {
      $result = $paymentobj->update_num($num_payment);
      if ($result < 0) {
        throw new RestException(500, 'Error when updating the payment num');
      }
    }
 
    return [
      'success' => [
        'code' => 200,
        'message' => 'Payment updated'
      ]
    ];
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->note);
    unset($object->address);
    unset($object->barcode_type);
    unset($object->barcode_type_code);
    unset($object->barcode_type_label);
    unset($object->barcode_type_coder);
    unset($object->canvas);
 
    return $object;
  }
 
  private function _validate($data)
  {
    if ($data === null) {
      $data = array();
    }
    $invoice = array();
    foreach (Invoices::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $invoice[$field] = $data[$field];
    }
    return $invoice;
  }
 
 
  public function getTemplateInvoice($id, $contact_list = 1)
  {
    return $this->_fetchTemplateInvoice($id, '', '', $contact_list);
  }
 
 
  public function indexTemplateInvoices($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $status = '', $sqlfilters = '', $properties = '', $pagination_data = false, $loadlinkedobjects = 0, $withLines = true)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
 
    $obj_ret = array();
 
    // case of external user, $thirdparty_ids param is ignored and replaced by user's socid
    $socids = DolibarrApiAccess::$user->socid ?: $thirdparty_ids;
 
 
    // If the internal user must only see his customers, force searching by him
    $search_sale = 0;
    if (!DolibarrApiAccess::$user->hasRight('societe', 'client', 'voir') && !$socids) {
      $search_sale = DolibarrApiAccess::$user->id;
    }
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."facture_rec AS t";
    $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe AS s ON (s.rowid = t.fk_soc)";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."facture_rec_extrafields AS ef ON (ef.fk_object = t.rowid)";
    $sql .= ' WHERE t.entity IN ('.getEntity('invoice').')';
    if ($socids) {
      $sql .= " AND t.fk_soc IN (".$this->db->sanitize($socids).")";
    }
 
    // Search on sale representative
    if ($search_sale && $search_sale != '-1') {
      if ($search_sale == -2) {
        $sql .= " AND NOT EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux AS sc WHERE sc.fk_soc = t.fk_soc)";
      } elseif ($search_sale > 0) {
        $sql .= " AND EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux AS sc WHERE sc.fk_soc = t.fk_soc AND sc.fk_user = ".((int) $search_sale).")";
      }
    }
 
    // Filter by status
    if ($status == 'active') {
      $sql .= " AND t.suspended = 0 AND t.frequency IS NOT NULL";
    }
    if ($status == 'suspended') {
      $sql .= " AND t.suspended = 1 AND t.frequency IS NOT NULL";
    }
    if ($status == 'draft') {
      $sql .= " AND t.frequency IS NULL";
    }
    // add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    //this query will return total template invoices with the filters given
    $sqlTotals = str_replace('SELECT t.rowid', 'SELECT count(t.rowid) as total', $sql);
 
    $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) {
      $i = 0;
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $factureRec = new FactureRec($this->db);
        if ($factureRec->fetch($obj->rowid) > 0) {
          if ($loadlinkedobjects) {
            // retrieve linked objects
            $factureRec->fetchObjectLinked();
          }
 
          if (!$withLines) {
            unset($factureRec->lines);
          }
 
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanTemplateObjectDatas($factureRec), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieving recurring invoice templates: '.$this->db->lasterror());
    }
 
    //if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
    if ($pagination_data) {
      $totalsResult = $this->db->query($sqlTotals);
      $total = $this->db->fetch_object($totalsResult)->total;
 
      $tmp = $obj_ret;
      $obj_ret = array();
 
      $obj_ret['data'] = $tmp;
      $obj_ret['pagination'] = array(
        'total' => (int) $total,
        'page' => $page,
        'page_count' => ceil((int) $total / $limit),
        'limit' => $limit
      );
    }
 
    return $obj_ret;
  }
 
  private function _fetchTemplateInvoice($id, $ref = '', $ref_ext = '', $contact_list = 1)
  {
    if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->template_invoice->fetch($id, $ref, $ref_ext);
    if (!$result) {
      throw new RestException(404, 'Template invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('facturerec', $this->template_invoice->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    // Add external contacts ids
    if ($contact_list > -1) {
      $tmparray = $this->template_invoice->liste_contact(-1, 'external', $contact_list);
      if (is_array($tmparray)) {
        $this->template_invoice->contacts_ids = $tmparray;
      }
    }
 
    $this->template_invoice->fetchObjectLinked();
    return $this->_cleanTemplateObjectDatas($this->template_invoice);
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanTemplateObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->note);
    unset($object->address);
    unset($object->barcode_type);
    unset($object->barcode_type_code);
    unset($object->barcode_type_label);
    unset($object->barcode_type_coder);
    unset($object->canvas);
 
    return $object;
  }
}