api_invoices.class.php

<?php
/* Copyright (C) 2015   Jean-François Ferry     <jfefe@aternatik.fr>
/* Copyright (C) 2020   Thibault FOUCART      <support@ptibogxiv.net>
 *
 * 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';

class Invoices extends DolibarrApi
{
  static $FIELDS = array(
    'socid',
  );

  public $invoice;

  public function __construct()
  {
    global $db, $conf;
    $this->db = $db;
    $this->invoice = new Facture($this->db);
  }

  public function get($id, $contact_list = 1)
  {
    return $this->_fetch($id, '', '', $contact_list);
  }

  public function getByRef($ref, $contact_list = 1)
  {
    return $this->_fetch('', $ref, '', $contact_list);
  }

  public function getByRefExt($ref_ext, $contact_list = 1)
  {
    return $this->_fetch('', '', $ref_ext, $contact_list);
  }

  private function _fetch($id, $ref = '', $ref_ext = '', $contact_list = 1)
  {
    if (!DolibarrApiAccess::$user->rights->facture->lire) {
      throw new RestException(401);
    }

    $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(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    // Add external contacts ids
    $this->invoice->contacts_ids = $this->invoice->liste_contact(-1, 'external', $contact_list);

    $this->invoice->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->invoice);
  }

  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $status = '', $sqlfilters = '')
  {
    global $db, $conf;

    $obj_ret = array();

    // case of external user, $thirdparty_ids param is ignored and replaced by user's socid
    $socids = DolibarrApiAccess::$user->socid ? DolibarrApiAccess::$user->socid : $thirdparty_ids;

    // 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."facture as t";

    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 .= ' WHERE t.entity IN ('.getEntity('invoice').')';
    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) $sql .= " AND t.fk_soc = sc.fk_soc";
    if ($socids) $sql .= " AND t.fk_soc IN (".$socids.")";

    if ($search_sale > 0) $sql .= " AND t.rowid = sc.fk_soc"; // Join for the needed table to filter by 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)";
    // Insert sale filter
    if ($search_sale > 0)
    {
      $sql .= " AND sc.fk_user = ".$search_sale;
    }
    // Add sql filters
    if ($sqlfilters)
    {
      if (!DolibarrApi::_checkFilters($sqlfilters))
      {
        throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters);
      }
      $regexstring = '\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
      $sql .= " AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")";
    }

    $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))
        {
          // 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');

          // Add external contacts ids
          $invoice_static->contacts_ids = $invoice_static->liste_contact(-1, 'external', 1);

          $obj_ret[] = $this->_cleanObjectDatas($invoice_static);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve invoice list : '.$this->db->lasterror());
    }
    if (!count($obj_ret)) {
      throw new RestException(404, 'No invoice found');
    }
    return $obj_ret;
  }

  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      throw new RestException(401, "Insuffisant rights");
    }
    // Check mandatory fields
    $result = $this->_validate($request_data);

    foreach ($request_data as $field => $value) {
      $this->invoice->$field = $value;
    }
    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 $this->invoice->id;
  }

  public function createInvoiceFromOrder($orderid)
  {

    require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';

    if (!DolibarrApiAccess::$user->rights->commande->lire) {
      throw new RestException(401);
    }
    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      throw new RestException(401);
    }
    if (empty($orderid)) {
      throw new RestException(400, 'Order ID is mandatory');
    }

    $order = new Commande($this->db);
    $result = $order->fetch($orderid);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    $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 getLines($id)
  {
    if (!DolibarrApiAccess::$user->rights->facture->lire) {
      throw new RestException(401);
    }

    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, '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->rights->facture->creer) {
      throw new RestException(401);
    }

    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $request_data = (object) $request_data;
    $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,
      '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
    );

    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)
  {
    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      throw new RestException(401);
    }

    $result = $this->invoice->fetch($id);

    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!in_array($type, array('BILLING', 'SHIPPING', 'CUSTOMER'), true)) {
      throw new RestException(500, 'Availables types: BILLING, SHIPPING OR CUSTOMER');
    }

    if (!DolibarrApi::_checkAccessToResource('invoice', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->invoice->add_contact($contactid, $type, 'external');

    if (!$result) {
      throw new RestException(500, 'Error when added the contact');
    }

    return $this->_cleanObjectDatas($this->invoice);
  }

  public function deleteContact($id, $contactid, $type)
  {
    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      throw new RestException(401);
    }

    $result = $this->invoice->fetch($id);

    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('invoice', $this->invoice->id)) {
      throw new RestException(401, '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->rights->facture->creer) {
      throw new RestException(401);
    }
    if (empty($lineid)) {
      throw new RestException(400, 'Line ID is mandatory');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    // TODO Check the lineid $lineid is a line of ojbect

    $updateRes = $this->invoice->deleteline($lineid);
    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->rights->facture->creer) {
      throw new RestException(401);
    }

    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    foreach ($request_data as $field => $value) {
      if ($field == 'id') continue;
      $this->invoice->$field = $value;
    }

    // update bank account
    if (!empty($this->invoice->fk_account))
    {
      if ($this->invoice->setBankAccount($this->invoice->fk_account) == 0) {
        throw new RestException(400, $this->invoice->error);
      }
    }

    if ($this->invoice->update(DolibarrApiAccess::$user))
      return $this->get($id);

    return false;
  }

  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->rights->facture->supprimer) {
      throw new RestException(401);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->invoice->delete(DolibarrApiAccess::$user);
    if ($result < 0)
    {
      throw new RestException(500);
    }

    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Invoice deleted'
      )
    );
  }

  public function postLine($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      throw new RestException(401);
    }

    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $request_data = (object) $request_data;

    // 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,
      'HT',
      0,
      $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->rights->facture->creer) {
      throw new RestException(401);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, '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');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    return $this->_cleanObjectDatas($this->invoice);
  }



  public function settodraft($id, $idwarehouse = -1)
  {
    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      throw new RestException(401);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, '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');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    return $this->_cleanObjectDatas($this->invoice);
  }


  public function validate($id, $idwarehouse = 0, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      throw new RestException(401);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->invoice->validate(DolibarrApiAccess::$user, '', $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');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    return $this->_cleanObjectDatas($this->invoice);
  }

  public function settopaid($id, $close_code = '', $close_note = '')
  {
    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      throw new RestException(401);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->invoice->set_paid(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');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    return $this->_cleanObjectDatas($this->invoice);
  }


  public function settounpaid($id)
  {
    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      throw new RestException(401);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->invoice->set_unpaid(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');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, '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->rights->facture->lire) {
      throw new RestException(401);
    }

    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, '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->rights->facture->creer) {
      throw new RestException(401);
    }

    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $this->invoice->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    if ($this->invoice->paye) {
      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 payed (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 payed 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();

      // 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
        {   // 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->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 = '.$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 = ".$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->amount_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->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->tva_tx = abs($tva_tx);

          $result = $discount->create(DolibarrApiAccess::$user);
          if ($result < 0)
          {
            $error++;
            break;
          }
        }
      }

      if (empty($error))
      {
        if ($this->invoice->type != Facture::TYPE_DEPOSIT) {
          // Classe facture
          $result = $this->invoice->set_paid(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->rights->facture->creer) {
      throw new RestException(401);
    }
    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(401, '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->rights->facture->creer) {
      throw new RestException(401);
    }
    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(401, '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->rights->facture->lire) {
      throw new RestException(401);
    }
    if (empty($id)) {
      throw new RestException(400, 'Invoice ID is mandatory');
    }

    if (!DolibarrApi::_checkAccessToResource('facture', $id)) {
      throw new RestException(401, '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 ($result < 0) {
      throw new RestException(405, $this->invoice->error);
    }

    return $result;
  }


  public function addPayment($id, $datepaye, $paymentid, $closepaidinvoices, $accountid, $num_payment = '', $comment = '', $chqemetteur = '', $chqbank = '')
  {
    global $conf;

    require_once DOL_DOCUMENT_ROOT.'/compta/paiement/class/paiement.class.php';

    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      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 (!empty($conf->banque->enabled)) {
      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
    $totalpaye = $this->invoice->getSommePaiement();
    $totalcreditnotes = $this->invoice->getSumCreditNotesUsed();
    $totaldeposits = $this->invoice->getSumDepositsUsed();
    $resteapayer = price2num($this->invoice->total_ttc - $totalpaye - $totalcreditnotes - $totaldeposits, 'MT');

    $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($resteapayer, 'MT');
      $amounts[$id] = -$resteapayer;
      // Multicurrency
      $newvalue = price2num($this->invoice->multicurrency_total_ttc, 'MT');
      $multicurrency_amounts[$id] = -$newvalue;
    } else {
      $resteapayer = price2num($resteapayer, 'MT');
      $amounts[$id] = $resteapayer;
      // Multicurrency
      $newvalue = price2num($this->invoice->multicurrency_total_ttc, 'MT');
      $multicurrency_amounts[$id] = $newvalue;
    }


    // Creation of payment line
    $paymentobj = new Paiement($this->db);
    $paymentobj->datepaye     = $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 = dol_getIdFromCode($this->db, $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 (!empty($conf->banque->enabled)) {
      $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)
  {
    global $conf;

    require_once DOL_DOCUMENT_ROOT.'/compta/paiement/class/paiement.class.php';

    if (!DolibarrApiAccess::$user->rights->facture->creer) {
      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', $id)) {
        throw new RestException(403, 'Access not allowed on invoice ID '.$id.' for login '.DolibarrApiAccess::$user->login);
      }
    }

    if (!empty($conf->banque->enabled)) {
      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)
    {
      $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
      $totalpaye = $this->invoice->getSommePaiement($is_multicurrency);
      $totalcreditnotes = $this->invoice->getSumCreditNotesUsed($is_multicurrency);
      $totaldeposits = $this->invoice->getSumDepositsUsed($is_multicurrency);
      $remainstopay = $amount = price2num($total_ttc - $totalpaye - $totalcreditnotes - $totaldeposits, 'MT');

      if (!$is_multicurrency && $amountarray["amount"] != 'remain')
      {
        $amount = price2num($amountarray["amount"], 'MT');
      }

      if ($is_multicurrency && $amountarray["multicurrency_amount"] != 'remain')
      {
        $amount = price2num($amountarray["multicurrency_amount"], 'MT');
      }

      if ($amount > $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 = -$amount;
      }

      if ($is_multicurrency) {
        $amounts[$id] = null;
        // Multicurrency
        $multicurrency_amounts[$id] = $amount;
      } else {
        $amounts[$id] = $amount;
        // Multicurrency
        $multicurrency_amounts[$id] = null;
      }
    }

    // Creation of payment line
    $paymentobj = new Paiement($this->db);
    $paymentobj->datepaye     = $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 = dol_getIdFromCode($this->db, $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 (!empty($conf->banque->enabled)) {
      $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->rights->facture->creer) {
      throw new RestException(401);
    }
    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');
    }

    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);

    return $object;
  }

  private function _validate($data)
  {
    $invoice = array();
    foreach (Invoices::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $invoice[$field] = $data[$field];
    }
    return $invoice;
  }
}