dolibarr 20.0.0
|
Public Member Functions | |
__construct () | |
Constructor. | |
get ($id) | |
Get properties of an Expense Report. | |
index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $user_ids='', $sqlfilters='', $properties='') | |
List Expense Reports. | |
post ($request_data=null) | |
Create Expense Report object. | |
put ($id, $request_data=null) | |
Get lines of an Expense Report. | |
delete ($id) | |
Delete Expense Report. | |
getAllPayments ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0) | |
Validate an Expense Report. | |
getPayments ($pid) | |
Get a given payment. | |
addPayment ($id, $request_data=null) | |
Create payment of ExpenseReport. | |
updatePayment ($id, $request_data=null) | |
Update a payment of ExpenseReport. | |
Public Member Functions inherited from DolibarrApi | |
__construct ($db, $cachedir='', $refreshCache=false) | |
Constructor. | |
Protected Member Functions | |
_cleanObjectDatas ($object) | |
Delete paymentExpenseReport. | |
Protected Member Functions inherited from DolibarrApi | |
_checkValForAPI ($field, $value, $object) | |
Check and convert a string depending on its type/name. | |
_filterObjectProperties ($object, $properties) | |
Filter properties that will be returned on object. | |
_checkFilters ($sqlfilters, &$error='') | |
Return if a $sqlfilters parameter is valid Function no more used. | |
Private Member Functions | |
_validate ($data) | |
Validate fields before create or update object. | |
_validatepayment ($data) | |
Validate fields before create or update object. | |
Additional Inherited Members | |
Static Protected Member Functions inherited from DolibarrApi | |
static | _checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid') |
Check access by user to a given resource. | |
static | _forge_criteria_callback ($matches) |
Function to forge a SQL criteria from a Generic filter string. | |
Definition at line 32 of file api_expensereports.class.php.
|
protected |
Delete paymentExpenseReport.
int | $id | ID of payment ExpenseReport |
@url DELETE {id}/payments Clean sensible object datas
Object | $object | Object to clean |
Reimplemented from DolibarrApi.
Definition at line 726 of file api_expensereports.class.php.
References $object.
Referenced by get(), getAllPayments(), getPayments(), and index().
|
private |
Validate fields before create or update object.
array | $data | Array with data to verify |
RestException |
Definition at line 780 of file api_expensereports.class.php.
Referenced by post().
|
private |
Validate fields before create or update object.
array | $data | Array with data to verify |
RestException |
Definition at line 799 of file api_expensereports.class.php.
Referenced by addPayment().
ExpenseReports::addPayment | ( | $id, | |
$request_data = null ) |
Create payment of ExpenseReport.
int | $id | ID of expense report |
array | $request_data | {@from body} Request data |
@url POST {id}/payments
Definition at line 620 of file api_expensereports.class.php.
References DolibarrApi\_checkValForAPI(), and _validatepayment().
ExpenseReports::delete | ( | $id | ) |
Delete Expense Report.
int | $id | Expense Report ID |
Definition at line 459 of file api_expensereports.class.php.
References DolibarrApi\_checkAccessToResource().
ExpenseReports::get | ( | $id | ) |
Get properties of an Expense Report.
Return an array with Expense Report information
int | $id | ID of Expense Report |
RestException |
Definition at line 77 of file api_expensereports.class.php.
References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().
ExpenseReports::getAllPayments | ( | $sortfield = "t.rowid", | |
$sortorder = 'ASC', | |||
$limit = 100, | |||
$page = 0 ) |
Validate an Expense Report.
int | $id | Expense Report ID |
@url POST {id}/validate
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
@url GET /payments
RestException |
Definition at line 544 of file api_expensereports.class.php.
References _cleanObjectDatas(), and dol_syslog().
ExpenseReports::getPayments | ( | $pid | ) |
Get a given payment.
int | $pid | Payment ID |
@url GET /payments/{pid}
RestException |
Definition at line 596 of file api_expensereports.class.php.
References _cleanObjectDatas().
ExpenseReports::index | ( | $sortfield = "t.rowid", | |
$sortorder = 'ASC', | |||
$limit = 100, | |||
$page = 0, | |||
$user_ids = '', | |||
$sqlfilters = '', | |||
$properties = '' ) |
List Expense Reports.
Get a list of Expense Reports
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
string | $user_ids | User ids filter field. Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i} |
string | $sqlfilters | Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')" |
string | $properties | Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names |
Definition at line 110 of file api_expensereports.class.php.
References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().
ExpenseReports::post | ( | $request_data = null | ) |
Create Expense Report object.
array | $request_data | Request data |
Definition at line 174 of file api_expensereports.class.php.
References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().
ExpenseReports::put | ( | $id, | |
$request_data = null ) |
Get lines of an Expense Report.
int | $id | Id of Expense Report |
@url GET {id}/lines
int | $id | Id of Expense Report to update |
array | $request_data | Expense Report data |
@url POST {id}/lines
int | $id | Id of Expense Report to update |
int | $lineid | Id of line to update |
array | $request_data | Expense Report data |
@url PUT {id}/lines/{lineid}
int | $id | Id of Expense Report to update |
int | $lineid | Id of line to delete |
@url DELETE {id}/lines/{lineid}
int | $id | Id of Expense Report to update |
array | $request_data | Datas |
RestException | 401 Not allowed |
RestException | 404 Expense report not found |
RestException | 500 System error |
Definition at line 418 of file api_expensereports.class.php.
References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().
ExpenseReports::updatePayment | ( | $id, | |
$request_data = null ) |
Update a payment of ExpenseReport.
int | $id | ID of paymentExpenseReport |
array | $request_data | data |
@url PUT {id}/payments
Definition at line 660 of file api_expensereports.class.php.
References DolibarrApi\_checkValForAPI().