api_vatpayments.class.php

<?php
/*
 * Copyright (C) 2026 Xabier Trigo Losada <xabi@galicloud.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/tva/class/tva.class.php';
require_once DOL_DOCUMENT_ROOT.'/compta/tva/class/paymentvat.class.php';
// PaymentVAT::delete() instantiates AccountLine without requiring it; load it here
// so deleting a bank-linked payment via the API does not throw a fatal error.
require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php';
 
class VatPayments extends DolibarrApi
{
  public static $FIELDS = array(
    'datep',
    'datev',
    'amount',
    'label',
  );
 
  public static $PAYMENT_FIELDS = array(
    'datepaye',
    'amount',
    'paiementtype',
  );
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'lire')) {
      throw new RestException(403);
    }
 
    $vat = new Tva($this->db);
    $result = $vat->fetch($id);
    // Tva::fetch() returns 1 even when the record does not exist,
    // so also check that the id was actually loaded.
    if ($result <= 0 || empty($vat->id)) {
      throw new RestException(404, 'VAT payment not found');
    }
 
    return $this->_cleanObjectDatas($vat);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '', $properties = '', $pagination_data = false)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'lire')) {
      throw new RestException(403);
    }
 
    $obj_ret = array();
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."tva AS t";
    $sql .= " WHERE t.entity IN (".getEntity('tva').")";
 
    // 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 count total records matching the filters (before pagination)
    $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);
    }
 
    dol_syslog("API Rest request");
    $result = $this->db->query($sql);
 
    if (!$result) {
      throw new RestException(503, 'Error when retrieving list of VAT payments: '.$this->db->lasterror());
    }
 
    $num = $this->db->num_rows($result);
    $min = min($num, ($limit <= 0 ? $num : $limit));
    for ($i = 0; $i < $min; $i++) {
      $obj = $this->db->fetch_object($result);
      $vat = new Tva($this->db);
      if ($vat->fetch($obj->rowid) > 0) {
        $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($vat), $properties);
      }
    }
 
    // If $pagination_data is true, the response will contain the element data with all values
    // and the element pagination with pagination data (total, page, page_count, 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, // count starts from 0
        'page_count' => ($limit > 0 ? (int) ceil((int) $total / $limit) : 1),
        'limit' => $limit
      );
    }
 
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'creer')) {
      throw new RestException(403);
    }
 
    // Check mandatory fields
    $this->_validate($request_data);
 
    $vat = new Tva($this->db);
    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
        $vat->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $vat->$field = $this->_checkValForAPI($field, $value, $vat);
    }
 
    if ($vat->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error when creating VAT payment: '.$vat->errorsToString());
    }
 
    return $vat->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'creer')) {
      throw new RestException(403);
    }
 
    $vat = new Tva($this->db);
    $result = $vat->fetch($id);
    // Tva::fetch() returns 1 even when the record does not exist,
    // so also check that the id was actually loaded.
    if ($result <= 0 || empty($vat->id)) {
      throw new RestException(404, 'VAT payment not found');
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $vat->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $vat->array_options[$index] = $this->_checkValExtrafieldsForAPI($index, $val, $vat);
        }
        continue;
      }
 
      $vat->$field = $this->_checkValForAPI($field, $value, $vat);
    }
 
    if ($vat->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, 'Error when updating VAT payment: '.$vat->errorsToString());
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'supprimer')) {
      throw new RestException(403);
    }
 
    $vat = new Tva($this->db);
    $result = $vat->fetch($id);
    // Tva::fetch() returns 1 even when the record does not exist,
    // so also check that the id was actually loaded.
    if ($result <= 0 || empty($vat->id)) {
      throw new RestException(404, 'VAT payment not found');
    }
 
    // As the card does, and as DELETE /invoices/{id}: not once something is paid
    if (!empty($vat->getSommePaiement())) {
      throw new RestException(403, 'VAT declaration not erasable, it has payments');
    }
 
    if ($vat->delete(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error when deleting VAT payment: '.$vat->errorsToString());
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'VAT payment deleted'
      )
    );
  }
 
  public function getAllPayments($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'lire')) {
      throw new RestException(403);
    }
 
    $list = array();
 
    $sql = "SELECT t.rowid FROM ".MAIN_DB_PREFIX."payment_vat AS t, ".MAIN_DB_PREFIX."tva AS s";
    $sql .= " WHERE t.fk_tva = s.rowid AND s.entity IN (".getEntity('tva').")";
    $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) {
      throw new RestException(503, 'Error when retrieving list of VAT payments: '.$this->db->lasterror());
    }
 
    $num = $this->db->num_rows($result);
    $min = min($num, ($limit <= 0 ? $num : $limit));
    for ($i = 0; $i < $min; $i++) {
      $obj = $this->db->fetch_object($result);
      $payment = new PaymentVAT($this->db);
      if ($payment->fetch($obj->rowid) > 0) {
        $list[] = $this->_cleanObjectDatas($payment);
      }
    }
 
    return $list;
  }
 
  public function getPayments($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'lire')) {
      throw new RestException(403);
    }
 
    $list = array();
 
    $sql = "SELECT t.rowid FROM ".MAIN_DB_PREFIX."payment_vat AS t";
    $sql .= " WHERE t.fk_tva = ".((int) $id);
    $sql .= $this->db->order('t.rowid', 'ASC');
 
    $result = $this->db->query($sql);
    if (!$result) {
      throw new RestException(503, 'Error when retrieving list of VAT payments: '.$this->db->lasterror());
    }
 
    $num = $this->db->num_rows($result);
    for ($i = 0; $i < $num; $i++) {
      $obj = $this->db->fetch_object($result);
      $payment = new PaymentVAT($this->db);
      if ($payment->fetch($obj->rowid) > 0) {
        $list[] = $this->_cleanObjectDatas($payment);
      }
    }
 
    return $list;
  }
 
  public function getPayment($pid)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'lire')) {
      throw new RestException(403);
    }
 
    $payment = new PaymentVAT($this->db);
    $result = $payment->fetch($pid);
    if ($result <= 0 || empty($payment->id)) {
      throw new RestException(404, 'VAT payment not found');
    }
 
    return $this->_cleanObjectDatas($payment);
  }
 
  public function addPayment($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'creer')) {
      throw new RestException(403);
    }
 
    // Check mandatory fields
    $this->_validatePayment($request_data);
 
    $payment = new PaymentVAT($this->db);
    $payment->chid = $id;
    $payment->datepaye = $request_data['datepaye'];
    $payment->amounts = array($id => (float) $request_data['amount']);
    $payment->paiementtype = $request_data['paiementtype'];
    if (isset($request_data['num_payment'])) {
      $payment->num_payment = $request_data['num_payment'];
    }
    if (isset($request_data['note'])) {
      $payment->note = $request_data['note'];
    }
 
    if ($payment->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error when creating VAT payment', array_merge(array($payment->error), $payment->errors));
    }
 
    if (isModEnabled("bank") && !empty($request_data['accountid'])) {
      $payment->addPaymentToBank(DolibarrApiAccess::$user, 'payment_vat', '(VATPayment)', (int) $request_data['accountid'], '', '');
    }
 
    return $payment->id;
  }
 
  public function deletePayment($pid)
  {
    if (!DolibarrApiAccess::$user->hasRight('tax', 'charges', 'supprimer')) {
      throw new RestException(403);
    }
 
    $payment = new PaymentVAT($this->db);
    $result = $payment->fetch($pid);
    if ($result <= 0 || empty($payment->id)) {
      throw new RestException(404, 'VAT payment not found');
    }
 
    if ($payment->delete(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error when deleting VAT payment: '.$payment->errorsToString());
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'VAT payment deleted'
      )
    );
  }
 
  private function _validate($data)
  {
    if ($data === null) {
      $data = array();
    }
    $vat = array();
    foreach (VatPayments::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $vat[$field] = $data[$field];
    }
    return $vat;
  }
 
  private function _validatePayment($data)
  {
    if ($data === null) {
      $data = array();
    }
    $payment = array();
    foreach (VatPayments::$PAYMENT_FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $payment[$field] = $data[$field];
    }
    return $payment;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->statut);
    unset($object->labelStatus);
    unset($object->labelStatusShort);
 
    return $object;
  }
}