Paiements Class Reference

Inheritance diagram for Paiements:

Collaboration diagram for Paiements:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a paiement object.
	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='')
	List paiements.
	put ($id, $request_data=null)
	Update paiement.
	delete ($id)
	Delete paiement.
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensitive object data fields @phpstan-template T.
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.

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.

Detailed Description

Definition at line 38 of file api_paiements.class.php.

Constructor & Destructor Documentation

__construct()

Paiements::__construct

(

)

Constructor.

@url GET /

Definition at line 50 of file api_paiements.class.php.

Member Function Documentation

_cleanObjectDatas()

Paiements::_cleanObjectDatas ( $object )

protected

Clean sensitive object data fields @phpstan-template T.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

@phpstan-param T $object @phpstan-return T

Reimplemented from DolibarrApi.

Definition at line 268 of file api_paiements.class.php.

References $object.

Referenced by get(), and index().

delete()

Paiements::delete

(

$id

)

Delete paiement.

Parameters

int

$id

Paiement ID

Returns

array @phan-return array<string,array{code:int,message:string}> @phpstan-return array<string,array{code:int,message:string}>

Exceptions

RestException	403 Not allowed
RestException	404 Not found
RestException	409 Nothing to do
RestException	500 System error

Definition at line 227 of file api_paiements.class.php.

References $id.

get()

Paiements::get

(

$id

)

Get properties of a paiement object.

Return an array with paiement information

Parameters

int

$id

ID of paiement

Returns

Object Object with cleaned properties @phan-return Paiement Object with cleaned properties @phpstan-return Paiement Object with cleaned properties

@phan-return Paiement

Exceptions

RestException	403 Not allowed
RestException	404 Not found

Definition at line 75 of file api_paiements.class.php.

References $id, and _cleanObjectDatas().

index()

Paiements::index	(		$sortfield = "t.rowid",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$sqlfilters = '',
			$properties = '' )

List paiements.

Get a list of paiements

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
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

Returns

array Array of paiements objects @phan-return array<int,Paiement> @phpstan-return array<int,Paiement>

Exceptions

RestException	403 Not allowed
RestException	503 System error

Definition at line 109 of file api_paiements.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().

put()

Paiements::put	(		$id,
			$request_data = null )

Update paiement.

Parameters

int	$id	Id of paiement to update
array	$request_data	Data @phan-param ?array<string,mixed> $request_data @phpstan-param ?array<string,mixed> $request_data

Returns

Object Object after update @phan-return Paiement @phpstan-return Paiement

Exceptions

RestException	403 Not allowed
RestException	404 Not found
RestException	500 System error

Definition at line 179 of file api_paiements.class.php.

References $id, DolibarrApi\_checkValForAPI(), and sanitizeVal().

---

The documentation for this class was generated from the following file:

• dolibarr_23.0/htdocs/compta/facture/class/api_paiements.class.php