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

NEW Get available assets of an invoice using the REST API

Browse Source 
Returns a list of paid down-payments, available avoirs, etc. with the payments detail
This commit is contained in:
Neil Orley 2017-10-24 11:47:25 +02:00
parent 0a43a12420
commit 41104de7ce
1 changed files with 65 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -680,7 +680,7 @@ class Invoices extends DolibarrApi
*/
function getPayments($id) {
if(! DolibarrApiAccess::$user->rights->facture->creer) {
if(! DolibarrApiAccess::$user->rights->facture->lire) {
throw new RestException(401);
}
if(empty($id)) {
@ -704,7 +704,71 @@ class Invoices extends DolibarrApi
return $result;
}
/**
* Get a list of available assets (down-payments, assets)
*
* @param int $id Id of the invoice
*
* @url GET {id}/getavailableassets
*
* @return array
* @throws 400
* @throws 401
* @throws 404
* @throws 405
*/
function getavailableassets($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->list_qualified_avoir_invoices($this->invoice->socid);
if( $result < 0) {
throw new RestException(405, $this->invoice->error);
}
$return = array();
foreach ($result as $invoiceID=>$line) {
if($invoiceID == $id) { // ignore current invoice
continue;
}
$result = $this->invoice->fetch($invoiceID);
if( ! $result ) {
throw new RestException(404, 'Invoice '.$invoiceID.' not found');
}
$result = $this->invoice->getListOfPayments();
if( $result < 0) {
throw new RestException(405, $this->invoice->error);
}
if(count($result) == 0) { // ignore unpaid invoices
continue;
}
// format results
$line["id"] = $invoiceID;
$line["payments"] = $result;
$return[] = $line;
}
return $return;
}
/**
* Clean sensible object datas