Inheritance diagram for SupplierInvoices:

Collaboration diagram for SupplierInvoices:

Public Member Functions
	__construct ()
	Constructor.

	get ($id)
	Get properties of a supplier invoice object.

	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $status='', $sqlfilters='', $properties='', $pagination_data=false)
	List invoices.

	post ($request_data=null)
	Create supplier invoice object.

	put ($id, $request_data=null)
	Update supplier invoice.

	delete ($id)
	Delete supplier invoice.

	validate ($id, $idwarehouse=0, $notrigger=0)
	Validate an invoice.

	getPayments ($id)
	Get list of payments of a given supplier invoice.

	addPayment ($id, $datepaye, $payment_mode_id, $closepaidinvoices, $accountid, $num_payment='', $comment='', $chqemetteur='', $chqbank='', $amount=null)
	Add payment line to a specific supplier invoice with the remain to pay as amount.

	getLines ($id)
	Get lines of a supplier invoice.

	postLine ($id, $request_data=null)
	Add a line to given supplier invoice.

	putLine ($id, $lineid, $request_data=null)
	Update a line to a given supplier invoice.

	deleteLine ($id, $lineid)
	Deletes a line of a given supplier invoice.

Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

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.

	_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.

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 34 of file api_supplier_invoices.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

SupplierInvoices::_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 753 of file api_supplier_invoices.class.php.

References $object.

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

◆ _validate()

SupplierInvoices::_validate ( $data )

private

Validate fields before create or update object.

Parameters

array $data Datas to validate

Returns: array

Exceptions

RestException

Definition at line 775 of file api_supplier_invoices.class.php.

Referenced by post().

◆ addPayment()

SupplierInvoices::addPayment	(	$id,
		$datepaye,
		$payment_mode_id,
		$closepaidinvoices,
		$accountid,
		$num_payment = '',
		$comment = '',
		$chqemetteur = '',
		$chqbank = '',
		$amount = null )

Add payment line to a specific supplier invoice with the remain to pay as amount.

Parameters

int	$id	Id of invoice
int	$datepaye	{@from body} Payment date {@type timestamp}
int	$payment_mode_id	{@from body} Payment mode ID (look it up via REST GET to /setup/dictionary/payment_types) {@min 1}
string	$closepaidinvoices	{@from body} Close paid invoices {@choice yes,no}
int	$accountid	{@from body} Bank account ID (look it up via REST GET to /bankaccounts) {@min 1}
string	$num_payment	{@from body} Payment number (optional)
string	$comment	{@from body} Note (optional)
string	$chqemetteur	{@from body} Payment issuer (mandatory if payment_mode_id corresponds to 'CHQ'-payment type)
string	$chqbank	{@from body} Issuer bank name (optional)
float	$amount	{@from body} Amount of payment if we don't want to use the remain to pay

@url POST {id}/payments

Returns: int Payment ID

Exceptions

RestException	400
RestException	403
RestException	404

Definition at line 448 of file api_supplier_invoices.class.php.

References $id, DolibarrApi\_checkAccessToResource(), dol_getIdFromCode(), and price2num().

◆ delete()

SupplierInvoices::delete ( $id )

Delete supplier invoice.

Parameters

int $id Supplier invoice ID

Returns: array

Exceptions

RestException	403
RestException	404
RestException	500 System error

Definition at line 313 of file api_supplier_invoices.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ deleteLine()

SupplierInvoices::deleteLine	(		$id,
			$lineid )

Deletes a line of a given supplier invoice.

Parameters

int	$id	Id of supplier invoice
int	$lineid	Id of the line to delete

@url DELETE {id}/lines/{lineid}

Returns: array

Exceptions

RestException	400 Bad parameters
RestException	403 Not allowed
RestException	404 Not found
RestException	405 Error

Definition at line 713 of file api_supplier_invoices.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ get()

SupplierInvoices::get ( $id )

Get properties of a supplier invoice object.

Return an array with supplier invoice information

Parameters

int $id ID of supplier invoice

Returns: Object Object with cleaned properties

Exceptions

RestException	403
RestException	404

Definition at line 70 of file api_supplier_invoices.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

◆ getLines()

SupplierInvoices::getLines ( $id )

Get lines of a supplier invoice.

Parameters

int $id Id of supplier invoice

@url GET {id}/lines

Returns: array

Exceptions

RestException	403
RestException	404

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

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

◆ getPayments()

SupplierInvoices::getPayments ( $id )

Get list of payments of a given supplier invoice.

Parameters

int $id Id of SupplierInvoice

@url GET {id}/payments

Returns: array

Exceptions

RestException	400
RestException	403
RestException	404
RestException	405

Definition at line 399 of file api_supplier_invoices.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ index()

SupplierInvoices::index	(	$sortfield = "t.rowid",
		$sortorder = 'ASC',
		$limit = 100,
		$page = 0,
		$thirdparty_ids = '',
		$status = '',
		$sqlfilters = '',
		$properties = '',
		$pagination_data = false )

List invoices.

Get a list of supplier invoices

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$thirdparty_ids	Thirdparty ids to filter invoices of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string	$status	Filter by invoice status : draft \| unpaid \| paid \| cancelled
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.datec:<:'20160101')"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
bool	$pagination_data	If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*

Returns: array Array of invoice objects

Exceptions

RestException

Definition at line 107 of file api_supplier_invoices.class.php.

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

◆ post()

SupplierInvoices::post ( $request_data = null )

Create supplier invoice object.

Note: soc_id = dolibarr_order_id

Example: {'ref': 'auto', 'ref_supplier': '7985630', 'socid': 1, 'note': 'Inserted with Python', 'order_supplier': 1, 'date': '2021-07-28'}

Parameters

array $request_data Request datas

Returns: int ID of supplier invoice

Exceptions

RestException	403
RestException	500 System error

Definition at line 225 of file api_supplier_invoices.class.php.

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

◆ postLine()

SupplierInvoices::postLine	(		$id,
			$request_data = null )

Add a line to given supplier invoice.

Note: socid = dolibarr_order_id, pu_ht = net price, remise = discount

Example: {'socid': 1, 'qty': 1, 'pu_ht': 21.0, 'tva_tx': 25.0, 'fk_product': '1189', 'product_type': 0, 'remise_percent': 1.0, 'vat_src_code': None}

Parameters

int	$id	Id of supplier invoice to update
array	$request_data	supplier invoice line data

@url POST {id}/lines

Returns: int|bool

Exceptions

RestException	403
RestException	404

Definition at line 579 of file api_supplier_invoices.class.php.

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

◆ put()

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

Update supplier invoice.

Parameters

int	$id	Id of supplier invoice to update
array	$request_data	Datas

Returns: Object|false Updated object

Exceptions

RestException	403
RestException	404

Definition at line 262 of file api_supplier_invoices.class.php.

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

◆ putLine()

SupplierInvoices::putLine	(	$id,
		$lineid,
		$request_data = null )

Update a line to a given supplier invoice.

Parameters

int	$id	Id of supplier invoice to update
int	$lineid	Id of line to update
array	$request_data	InvoiceLine data

@url PUT {id}/lines/{lineid}

Returns: object

Exceptions

RestException	403 Not allowed
RestException	404 Not found
RestException	304 Error

Definition at line 646 of file api_supplier_invoices.class.php.

References $id, DolibarrApi\_checkAccessToResource(), _cleanObjectDatas(), and sanitizeVal().

◆ validate()

SupplierInvoices::validate	(	$id,
		$idwarehouse = 0,
		$notrigger = 0 )

Validate an invoice.

Parameters

int	$id	Invoice ID
int	$idwarehouse	Warehouse ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers

@url POST {id}/validate

Returns: array

Exceptions

RestException	304
RestException	403
RestException	404
RestException	405
RestException	500 System error

Definition at line 355 of file api_supplier_invoices.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

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

dolibarr_dev/htdocs/fourn/class/api_supplier_invoices.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ addPayment()

◆ delete()

◆ deleteLine()

◆ get()

◆ getLines()

◆ getPayments()

◆ index()

◆ post()

◆ postLine()

◆ put()

◆ putLine()

◆ validate()