api_supplier_invoices.class.php

<?php
/* Copyright (C) 2015 Jean-François Ferry   <jfefe@aternatik.fr>
 * Copyright (C) 2016 Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2023 Joachim Kueter      <git-jk@bloxera.com>
 * Copyright (C) 2024-2025  MDW         <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2025  Frédéric France     <frederic.france@free.fr>
 *
 * 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 . '/fourn/class/fournisseur.facture.class.php';
require_once DOL_DOCUMENT_ROOT . '/fourn/class/paiementfourn.class.php';
 
class SupplierInvoices extends DolibarrApi
{
  public static $FIELDS = array(
    'socid',
  );
 
  public $invoice;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
    $this->invoice = new FactureFournisseur($this->db);
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "lire")) {
      throw new RestException(403);
    }
 
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      throw new RestException(403, 'Access not allowed for login ' . DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    // Retrieve credit note ids
    $this->invoice->getListIdAvoirFromInvoice();
 
    $this->invoice->fetchObjectLinked();
    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)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "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")) {
      $search_sale = DolibarrApiAccess::$user->id;
    }
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM " . MAIN_DB_PREFIX . "facture_fourn AS t";
    $sql .= " LEFT JOIN " . MAIN_DB_PREFIX . "facture_fourn_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('supplier_invoice') . ')';
    if ($socids) {
      $sql .= " AND t.fk_soc IN (" . $this->db->sanitize($socids) . ")";
    }
    // 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)";
    }
    // 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).")";
      }
    }
    // 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 supplier 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 FactureFournisseur($this->db);
        if ($invoice_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($invoice_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve supplier 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)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "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);
 
    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;
      }
 
      $this->invoice->$field = $this->_checkValForAPI($field, $value, $this->invoice);
    }
    if (!array_key_exists('date', $request_data)) {
      $this->invoice->date = dol_now();
    }
 
    if ($this->invoice->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating invoice ", array_merge(array($this->invoice->error), $this->invoice->errors));
    }
    return $this->invoice->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "creer")) {
      throw new RestException(403);
    }
 
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      throw new RestException(403, 'Access not allowed for login ' . DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    if (!is_array($request_data)) {
      $request_data = array();
    }
 
    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 ($this->invoice->update(DolibarrApiAccess::$user)) {
      return $this->get($id);
    }
 
    return false;
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "supprimer")) {
      throw new RestException(403);
    }
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      throw new RestException(403, 'Access not allowed for login ' . DolibarrApiAccess::$user->login);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    if ($this->invoice->delete(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error when deleting invoice');
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Supplier invoice deleted'
      )
    );
  }
 
  public function validate($id, $idwarehouse = 0, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "creer")) {
      throw new RestException(403);
    }
 
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      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->validate(DolibarrApiAccess::$user, '', $idwarehouse, $notrigger);
    if ($result == 0) {
      throw new RestException(304, 'Error nothing done. The invoice is already validated');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when validating Invoice: ' . $this->invoice->error);
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Invoice validated (Ref=' . $this->invoice->ref . ')'
      )
    );
  }
 
  public function settodraft($id, $idwarehouse = -1, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "creer")) {
      throw new RestException(403);
    }
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      throw new RestException(403, 'Access not allowed for login ' . DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->setDraft(DolibarrApiAccess::$user, $idwarehouse, $notrigger);
    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 getPayments($id)
  {
    if (empty($id)) {
      throw new RestException(400, 'Invoice ID is mandatory');
    }
 
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "lire")) {
      throw new RestException(403);
    }
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      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 ($this->invoice->error !== '') {
      throw new RestException(405, $this->invoice->error);
    }
 
    return $result;
  }
 
 
  public function addPayment($id, $datepaye, $payment_mode_id, $closepaidinvoices, $accountid, $num_payment = '', $comment = '', $chqemetteur = '', $chqbank = '', $amount = null)
  {
    if (empty($id)) {
      throw new RestException(400, 'Invoice ID is mandatory');
    }
 
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "creer")) {
      throw new RestException(403);
    }
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      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 (isModEnabled("bank")) {
      if (empty($accountid)) {
        throw new RestException(400, 'Bank account ID is mandatory');
      }
    }
 
    if (empty($payment_mode_id)) {
      throw new RestException(400, 'Payment mode ID is mandatory');
    }
 
    if (null !== $amount && $amount > 0) {
      // We use the amount given in parameter
      $paymentamount = $amount;
    } else {
      // We calculate the remain to pay, and use it as amount
      $totalpaid = $this->invoice->getSommePaiement();
      $totaldeposits = $this->invoice->getSumDepositsUsed();
      $paymentamount = price2num($this->invoice->total_ttc - $totalpaid - $totaldeposits, 'MT');
    }
 
    $this->db->begin();
 
    $amounts = array();
    $multicurrency_amounts = array();
 
    $paymentamount = (float) price2num($paymentamount, 'MT');
 
    $amounts[$id] = $paymentamount;
 
    // Multicurrency
    $newvalue = (float) price2num($this->invoice->multicurrency_total_ttc, 'MT');
    $multicurrency_amounts[$id] = $newvalue;
 
    // Creation of payment line
    $paiement = new PaiementFourn($this->db);
    $paiement->datepaye     = $datepaye;
    $paiement->amounts      = $amounts; // Array with all payments dispatching with invoice id
    $paiement->multicurrency_amounts = $multicurrency_amounts; // Array with all payments dispatching
    $paiement->paiementid = $payment_mode_id;
    $paiement->paiementcode = (string) dol_getIdFromCode($this->db, (string) $payment_mode_id, 'c_paiement', 'id', 'code', 1);
    $paiement->num_payment = $num_payment;
    $paiement->note_private = $comment;
 
    $paiement_id = $paiement->create(DolibarrApiAccess::$user, ($closepaidinvoices == 'yes' ? 1 : 0)); // This include closing invoices
    if ($paiement_id < 0) {
      $this->db->rollback();
      throw new RestException(400, 'Payment error : ' . $paiement->error);
    }
 
    if (isModEnabled("bank")) {
      $result = $paiement->addPaymentToBank(DolibarrApiAccess::$user, 'payment_supplier', '(SupplierInvoicePayment)', $accountid, $chqemetteur, $chqbank);
      if ($result < 0) {
        $this->db->rollback();
        throw new RestException(400, 'Add payment to bank error : ' . $paiement->error);
      }
    }
 
    $this->db->commit();
 
    return $paiement_id;
  }
 
  public function settopaid($id, $close_code = '', $close_note = '')
  {
    if (!DolibarrApiAccess::$user->hasRight('fournisseur', 'facture', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $this->invoice->id, 'facture_fourn', 'facture')) {
      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. Maybe object is already paid or not payable.');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error: ' . $this->invoice->error);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
  public function settounpaid($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('fournisseur', 'facture', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $this->invoice->id, 'facture_fourn', 'facture')) {
      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, 'Supplier invoice not found');
    }
 
    return $this->_cleanObjectDatas($this->invoice);
  }
 
  public function getLines($id)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "creer")) {
      throw new RestException(403);
    }
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      throw new RestException(403, 'Access not allowed for login ' . DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    $this->invoice->fetch_lines();
    $result = array();
    foreach ($this->invoice->lines as $line) {
      array_push($result, $this->_cleanObjectDatas($line));
    }
    return $result;
  }
 
  public function postLine($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "creer")) {
      throw new RestException(403);
    }
 
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      throw new RestException(403, 'Access not allowed for login ' . DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    $request_data = (object) $request_data;
 
    $request_data->description = sanitizeVal($request_data->description, 'restricthtml');
    $request_data->ref_supplier = sanitizeVal($request_data->ref_supplier);
 
    $updateRes = $this->invoice->addline(
      $request_data->description,
      $request_data->pu_ht,
      $request_data->tva_tx,
      $request_data->localtax1_tx,
      $request_data->localtax2_tx,
      $request_data->qty,
      $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->price_base_type ? $request_data->price_base_type : 'HT',
      $request_data->product_type,
      $request_data->rang,
      0,
      $request_data->array_options,
      $request_data->fk_unit,
      $request_data->origin_id,
      $request_data->multicurrency_subprice,
      $request_data->ref_supplier,
      $request_data->special_code
    );
 
    if ($updateRes < 0) {
      throw new RestException(400, 'Unable to insert the new line. Check your inputs. ' . $this->invoice->error);
    }
 
    return $updateRes;
  }
 
  public function putLine($id, $lineid, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "creer")) {
      throw new RestException(403);
    }
 
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      throw new RestException(403, 'Access not allowed for login ' . DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    $request_data = (object) $request_data;
 
    $request_data->description = sanitizeVal($request_data->description, 'restricthtml');
    $request_data->ref_supplier = sanitizeVal($request_data->ref_supplier);
 
    $updateRes = $this->invoice->updateline(
      $lineid,
      $request_data->description,
      $request_data->pu_ht,
      $request_data->tva_tx,
      $request_data->localtax1_tx,
      $request_data->localtax2_tx,
      $request_data->qty,
      $request_data->fk_product,
      $request_data->price_base_type ? $request_data->price_base_type : 'HT',
      $request_data->info_bits,
      $request_data->product_type,
      $request_data->remise_percent,
      0,
      $request_data->date_start,
      $request_data->date_end,
      $request_data->array_options,
      $request_data->fk_unit,
      $request_data->multicurrency_subprice,
      $request_data->ref_supplier,
      $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 deleteLine($id, $lineid)
  {
    if (empty($lineid)) {
      throw new RestException(400, 'Line ID is mandatory');
    }
 
    if (!DolibarrApiAccess::$user->hasRight("fournisseur", "facture", "creer")) {
      throw new RestException(403);
    }
    if (!DolibarrApi::_checkAccessToResource('fournisseur', $id, 'facture_fourn', 'facture')) {
      throw new RestException(403, 'Access not allowed for login ' . DolibarrApiAccess::$user->login);
    }
 
    $result = $this->invoice->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier invoice not found');
    }
 
    // TODO Check the lineid $lineid is a line of object
 
    $updateRes = $this->invoice->deleteLine($lineid);
    if ($updateRes > 0) {
      return array(
        'success' => array(
          'code' => 200,
          'message' => 'line '.$lineid.' deleted'
        )
      );
    } else {
      throw new RestException(405, $this->invoice->error);
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->rowid);
    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)
  {
    if ($data === null) {
      $data = array();
    }
    $invoice = array();
    foreach (SupplierInvoices::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $invoice[$field] = $data[$field];
    }
    return $invoice;
  }
}