Merge pull request #7753 from Oeris/develop-api

NEW Add REST API to add payment line to a specific invoice
Dolibarr · Nov 2, 2017 · 93ab4ca · 93ab4ca
2 parents 952bea4 + be36a79
commit 93ab4ca
Showing 1 changed file with 114 additions and 0 deletions.
diff --git a/htdocs/compta/facture/class/api_invoices.class.php b/htdocs/compta/facture/class/api_invoices.class.php
@@ -779,6 +779,120 @@ function getPayments($id) {
         return $result;
     }
 
+     /**
+     * Add payment line to a specific invoice
+     *
+     * The model schema is defined by the PaymentData class.
+     *
+     * @param int     $id                               Id of invoice
+     * @param string  $datepaye 	  {@from body}  Payment date        {@type timestamp}
+     * @param int     $paiementid 	  {@from body}  Payment mode Id {@min 1}
+     * @param string  $closepaidinvoices  {@from body}  Close paid invoices {@choice yes,no}
+     * @param int     $accountid          {@from body}  Account Id {@min 1}
+     * @param string  $num_paiement       {@from body}  Payment number (optional)
+     * @param string  $comment            {@from body}  Note (optional)
+     * @param string  $chqemetteur        {@from body}  Payment issuer (mandatory if paiementcode = 'CHQ')
+     * @param string  $chqbank            {@from body}  Issuer bank name (optional)
+     *
+     * @url     POST {id}/addpayment
+     *
+     * @return int  Payment ID
+     * @throws 400
+     * @throws 401
+     * @throws 404
+     */
+    function addPayment($id, $datepaye, $paiementid, $closepaidinvoices, $accountid, $num_paiement='', $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(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);
+        }
+
+        $request_data = (object) $payment_data;
+
+        if (! empty($conf->banque->enabled)) {
+            if(empty($accountid)) {
+                throw new RestException(400, 'Account ID is mandatory');
+            }
+        }
+
+        if(empty($paiementid)) {
+            throw new RestException(400, 'Paiement ID or Paiement 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();
+        // 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
+        $paiement = new Paiement($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   = $paiementid;
+        $paiement->paiementcode = dol_getIdFromCode($this->db,$paiementid,'c_paiement','id','code',1);
+        $paiement->num_paiement = $num_paiement;
+        $paiement->note         = $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 (! empty($conf->banque->enabled)) {
+            $label='(CustomerInvoicePayment)';
+
+            if($paiement->paiementcode == 'CHQ' && empty($chqemetteur)) {
+                  throw new RestException(400, 'Emetteur is mandatory when payment code is '.$paiement->paiementcode);
+            }
+            if ($this->invoice->type == Facture::TYPE_CREDIT_NOTE) $label='(CustomerInvoicePaymentBack)';  // Refund of a credit note
+            $result=$paiement->addPaymentToBank(DolibarrApiAccess::$user,'payment',$label,$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;
+    }
+
     /**
      * Clean sensible object datas
      *