lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #14723 from c3do/patch-13

Browse Source 
NEW API Can update a payment
This commit is contained in:
Laurent Destailleur 2020-09-14 00:29:10 +02:00 committed by GitHub
commit 62b7a90ea3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 54 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
htdocs/compta/facture/class/api_invoices.class.php
View File

@ -1284,7 +1284,7 @@ class Invoices extends DolibarrApi
* @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 $num_payment {@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)
@ -1297,7 +1297,7 @@ class Invoices extends DolibarrApi
* @throws RestException 401
* @throws RestException 404
*/
public function addPayment($id, $datepaye, $paiementid, $closepaidinvoices, $accountid, $num_paiement = '', $comment = '', $chqemetteur = '', $chqbank = '')
public function addPayment($id, $datepaye, $paiementid, $closepaidinvoices, $accountid, $num_payment = '', $comment = '', $chqemetteur = '', $chqbank = '')
{
global $conf;
@ -1321,7 +1321,7 @@ class Invoices extends DolibarrApi
}
if (empty($paiementid)) {
throw new RestException(400, 'Paiement ID or Paiement Code is mandatory');
throw new RestException(400, 'Payment ID or Payment Code is mandatory');
}
@ -1364,7 +1364,7 @@ class Invoices extends DolibarrApi
$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->num_payment = $num_payment;
$paiement->note = $comment;
$paiement_id = $paiement->create(DolibarrApiAccess::$user, ($closepaidinvoices == 'yes' ? 1 : 0)); // This include closing invoices
@ -1404,7 +1404,7 @@ class Invoices extends DolibarrApi
* @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 $num_payment {@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)
@ -1418,7 +1418,7 @@ class Invoices extends DolibarrApi
* @throws RestException 403
* @throws RestException 404
*/
public function addPaymentDistributed($arrayofamounts, $datepaye, $paiementid, $closepaidinvoices, $accountid, $num_paiement = '', $comment = '', $chqemetteur = '', $chqbank = '')
public function addPaymentDistributed($arrayofamounts, $datepaye, $paiementid, $closepaidinvoices, $accountid, $num_payment = '', $comment = '', $chqemetteur = '', $chqbank = '')
{
global $conf;
@ -1442,7 +1442,7 @@ class Invoices extends DolibarrApi
}
}
if (empty($paiementid)) {
throw new RestException(400, 'Paiement ID or Paiement Code is mandatory');
throw new RestException(400, 'Payment ID or Payment Code is mandatory');
}
$this->db->begin();
@ -1496,7 +1496,7 @@ class Invoices extends DolibarrApi
$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->num_payment = $num_payment;
$paiement->note = $comment;
$paiement_id = $paiement->create(DolibarrApiAccess::$user, ($closepaidinvoices == 'yes' ? 1 : 0)); // This include closing invoices
if ($paiement_id < 0)
@ -1523,6 +1523,52 @@ class Invoices extends DolibarrApi
return $paiement_id;
}
/**
* Update a payment
*
* @param int $id Id of payment
* @param string $num_payment Payment number
*
* @url PUT payments/{id}
*
* @return array
* @throws 400
* @throws 401
* @throws 404
*/
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
/**
* Clean sensible object datas