BankAccounts Class Reference

Inheritance diagram for BankAccounts:

Collaboration diagram for BankAccounts:

Public Member Functions
	__construct ()
	Constructor.
	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $category=0, $sqlfilters='')
	Get the list of accounts.
	get ($id)
	Get account by ID.
	post ($request_data=null)
	Create account object.
	transfer ($bankaccount_from_id=0, $bankaccount_to_id=0, $date=null, $description="", $amount=0.0, $amount_to=0.0)
	Create an internal wire transfer between two bank accounts.
	put ($id, $request_data=null)
	Update account.
	delete ($id)
	Delete account.
	getLines ($id, $sqlfilters='')
	Get the list of lines of the account.
	addLine ($id, $date, $type, $label, $amount, $category=0, $cheque_number='', $cheque_writer='', $cheque_bank='', $accountancycode='', $datev=null, $num_releve='')
	Add a line to an account.
	addLink ($id, $line_id, $url_id, $url, $label, $type)
	Add a link to an account line.
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Static Public Attributes
static	$FIELDS
	array $FIELDS Mandatory fields, checked when creating an object

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas.
Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name.
	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid Function no more used.

Private Member Functions
	_validate ($data)
	Validate fields before creating an 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.

Detailed Description

Definition at line 30 of file api_bankaccounts.class.php.

Member Function Documentation

_cleanObjectDatas()

BankAccounts::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 401 of file api_bankaccounts.class.php.

Referenced by get(), getLines(), and index().

_validate()

BankAccounts::_validate ( $data )

private

Validate fields before creating an object.

Parameters

array | null

$data

Data to validate

Returns

array

Exceptions

RestException

Definition at line 382 of file api_bankaccounts.class.php.

References $FIELDS.

Referenced by post().

addLine()

BankAccounts::addLine	(		$id,
			$date,
			$type,
			$label,
			$amount,
			$category = 0,
			$cheque_number = '',
			$cheque_writer = '',
			$cheque_bank = '',
			$accountancycode = '',
			$datev = null,
			$num_releve = '' )

Add a line to an account.

Parameters

int	$id	ID of account
string	$date	Payment date (timestamp) {@from body} {@type timestamp}
string	$type	Payment mode (TYP,VIR,PRE,LIQ,VAD,CB,CHQ...) {@from body}
string	$label	Label {@from body}
float	$amount	Amount (may be 0) {@from body}
int	$category	Category
string	$cheque_number	Cheque numero {@from body}
string	$cheque_writer	Name of cheque writer {@from body}
string	$cheque_bank	Bank of cheque writer {@from body}
string	$accountancycode	Accountancy code {@from body}
string	$datev	Payment date value (timestamp) {@from body} {@type timestamp}
string	$num_releve	Bank statement numero {@from body}

Returns

int ID of line

@url POST {id}/lines

Definition at line 487 of file api_bankaccounts.class.php.

References sanitizeVal().

addLink()

BankAccounts::addLink	(		$id,
			$line_id,
			$url_id,
			$url,
			$label,
			$type )

Add a link to an account line.

Parameters

int	$id	ID of account
int	$line_id	ID of account line
int	$url_id	ID to set in the URL {@from body}
string	$url	URL of the link {@from body}
string	$label	Label {@from body}
string	$type	Type of link ('payment', 'company', 'member', ...) {@from body}

Returns

int ID of link

@url POST {id}/lines/{line_id}/links

Definition at line 540 of file api_bankaccounts.class.php.

References sanitizeVal().

delete()

BankAccounts::delete

(

$id

)

Delete account.

Parameters

int

$id

ID of account

Returns

array

Definition at line 351 of file api_bankaccounts.class.php.

get()

BankAccounts::get

(

$id

)

Get account by ID.

Parameters

int

$id

ID of account

Returns

Object Object with cleaned properties

Exceptions

RestException

Definition at line 129 of file api_bankaccounts.class.php.

References _cleanObjectDatas().

getLines()

BankAccounts::getLines	(		$id,
			$sqlfilters = '' )

Get the list of lines of the account.

Parameters

int

$id

ID of account

Returns

array Array of AccountLine objects

Exceptions

RestException

@url GET {id}/lines

Parameters

string

$sqlfilters

Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.import_key:<:'20160101')"

Definition at line 422 of file api_bankaccounts.class.php.

References _cleanObjectDatas(), and forgeSQLFromUniversalSearchCriteria().

index()

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

Get the list of accounts.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
int	$category	Use this param to filter list by category
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.import_key:<:'20160101')"

Returns

array List of account objects

Exceptions

RestException

Definition at line 65 of file api_bankaccounts.class.php.

References _cleanObjectDatas(), dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

post()

BankAccounts::post

(

$request_data = null

)

Create account object.

Parameters

array

$request_data

Request data

Returns

int ID of account

Definition at line 150 of file api_bankaccounts.class.php.

References DolibarrApi\_checkValForAPI(), and _validate().

put()

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

Update account.

Parameters

int	$id	ID of account
array	$request_data	data

Returns

Object Object with cleaned properties

Definition at line 319 of file api_bankaccounts.class.php.

References DolibarrApi\_checkValForAPI().

transfer()

BankAccounts::transfer	(		$bankaccount_from_id = 0,
			$bankaccount_to_id = 0,
			$date = null,
			$description = "",
			$amount = 0.0,
			$amount_to = 0.0 )

Create an internal wire transfer between two bank accounts.

Parameters

int	$bankaccount_from_id	BankAccount ID to use as the source of the internal wire transfer {@from body}{@required true}
int	$bankaccount_to_id	BankAccount ID to use as the destination of the internal wire transfer {@from body}{@required true}
string	$date	Date of the internal wire transfer (UNIX timestamp) {@from body}{@required true}{@type timestamp}
string	$description	Description of the internal wire transfer {@from body}{@required true}
float	$amount	Amount to transfer from the source to the destination BankAccount {@from body}{@required true}
float	$amount_to	Amount to transfer to the destination BankAccount (only when accounts does not share the same currency) {@from body}{@required false}

@url POST /transfer

Returns

array

@status 201

Exceptions

RestException	401 Unauthorized: User does not have permission to configure bank accounts
RestException	404 Not Found: Either the source or the destination bankaccount for the provided id does not exist
RestException	422 Unprocessable Entity: Refer to detailed exception message for the cause
RestException	500 Internal Server Error: Error(s) returned by the RDBMS

Creating bank line records

Creating links between bank line record and its source

Definition at line 195 of file api_bankaccounts.class.php.

References price2num(), sanitizeVal(), and Account\TYPE_CASH.

---

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

• dolibarr_18.0/htdocs/compta/bank/class/api_bankaccounts.class.php