Inheritance diagram for SupplierOrders:

Collaboration diagram for SupplierOrders:

Public Member Functions
	__construct ()
	Constructor.

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

	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $product_ids='', $status='', $sqlfilters='', $sqlfilterlines='', $properties='')
	List orders.

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

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

	getContacts ($id, $source, $type='')
	Get contacts of given supplier order.

	postContact ($id, $contactid, $type, $source)
	Add a contact type of given supplier order.

	deleteContact ($id, $contactid, $type, $source)
	Unlink a contact type of given supplier order.

	delete ($id)
	Delete supplier order.

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

	approve ($id, $idwarehouse=0, $secondlevel=0)
	Approve an order.

	makeOrder ($id, $date, $method, $comment='')
	Sends an order to the vendor.

	receiveOrder ($id, $closeopenorder, $comment, $lines)
	Receives the order, dispatches products.

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 29 of file api_supplier_orders.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

SupplierOrders::_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 726 of file api_supplier_orders.class.php.

References $object.

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

◆ _validate()

SupplierOrders::_validate ( $data )

private

Validate fields before create or update object.

Parameters

array $data Datas to validate

Returns: array

Exceptions

RestException

Definition at line 748 of file api_supplier_orders.class.php.

Referenced by post().

◆ approve()

SupplierOrders::approve	(	$id,
		$idwarehouse = 0,
		$secondlevel = 0 )

Approve an order.

Parameters

int	$id	Order ID
int	$idwarehouse	Warehouse ID
int	$secondlevel	1=Does not execute triggers, 0= execute triggers

@url POST {id}/approve

Returns: array FIXME An error 403 is returned if the request has an empty body. Error message: "Forbidden: Content type `text/plain` is not supported." Workaround: send this in the body { "idwarehouse": 0, "secondlevel": 0 }

Definition at line 552 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

◆ delete()

SupplierOrders::delete ( $id )

Delete supplier order.

Parameters

int $id Supplier order ID

Returns: array Array of result

Definition at line 459 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

◆ deleteContact()

SupplierOrders::deleteContact	(	$id,
		$contactid,
		$type,
		$source )

Unlink a contact type of given supplier order.

Parameters

int	$id	Id of supplier order to update
int	$contactid	Id of contact/user to add
string	$type	Type of the contact (BILLING, SHIPPING, CUSTOMER, SALESREPFOLL, ...).
string	$source	Source of the contact (internal, external).

@url DELETE {id}/contact/{contactid}/{type}/{source}

Returns: array

Exceptions

RestException	401
RestException	404
RestException	500 System error

Definition at line 410 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

◆ get()

SupplierOrders::get ( $id )

Get properties of a supplier order object.

Return an array with supplier order information

Parameters

int $id ID of supplier order

Returns: array|mixed data without useless information

Exceptions

RestException

Definition at line 64 of file api_supplier_orders.class.php.

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

◆ getContacts()

SupplierOrders::getContacts	(	$id,
		$source,
		$type = '' )

Get contacts of given supplier order.

Return an array with contact information

Parameters

int	$id	ID of supplier order
string	$source	Source of the contact (internal, external, all).
string	$type	Type of the contact (BILLING, SHIPPING, CUSTOMER, SALESREPFOLL, ...)

Returns: Object Object with cleaned properties

@url GET {id}/contacts

Exceptions

RestException

Definition at line 318 of file api_supplier_orders.class.php.

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

◆ index()

SupplierOrders::index	(	$sortfield = "t.rowid",
		$sortorder = 'ASC',
		$limit = 100,
		$page = 0,
		$thirdparty_ids = '',
		$product_ids = '',
		$status = '',
		$sqlfilters = '',
		$sqlfilterlines = '',
		$properties = '' )

List orders.

Get a list of supplier orders

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 orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string	$product_ids	Product ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string	$status	Filter by order status : draft \| validated \| approved \| running \| received_start \| received_end \| cancelled \| refused
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.datec:<:'20160101')"
string	$sqlfilterlines	Other criteria to filter answers separated by a comma. Syntax example "(tl.fk_product:=:'17') and (tl.price:<:'250')"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names

Returns: array Array of order objects

Exceptions

RestException

Definition at line 102 of file api_supplier_orders.class.php.

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

◆ makeOrder()

SupplierOrders::makeOrder	(	$id,
		$date,
		$method,
		$comment = '' )

Sends an order to the vendor.

Parameters

int	$id	Order ID
integer	$date	Date (unix timestamp in sec)
int	$method	Method
string	$comment	Comment

@url POST {id}/makeorder

Returns: array FIXME An error 403 is returned if the request has an empty body. Error message: "Forbidden: Content type `text/plain` is not supported." Workaround: send this in the body { "date": 0, "method": 0, "comment": "" }

Definition at line 603 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

◆ post()

SupplierOrders::post ( $request_data = null )

Create supplier order object.

Example: {"ref": "auto", "ref_supplier": "1234", "socid": "1", "multicurrency_code": "SEK", "multicurrency_tx": 1, "tva_tx": 25, "note": "Imported via the REST API"}

Parameters

array $request_data Request datas

Returns: int ID of supplier order

Definition at line 222 of file api_supplier_orders.class.php.

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

◆ postContact()

SupplierOrders::postContact	(	$id,
		$contactid,
		$type,
		$source )

Add a contact type of given supplier order.

Parameters

int	$id	Id of supplier order to update
int	$contactid	Id of contact/user to add
string	$type	Type of the contact (BILLING, SHIPPING, CUSTOMER, SALESREPFOLL, ...)
string	$source	Source of the contact (external, internal)

Returns: array

@url POST {id}/contact/{contactid}/{type}/{source}

Exceptions

RestException	401
RestException	404

Definition at line 361 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

◆ put()

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

Update supplier order.

Parameters

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

Returns: Object|false Updated object

Definition at line 264 of file api_supplier_orders.class.php.

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

◆ receiveOrder()

SupplierOrders::receiveOrder	(	$id,
		$closeopenorder,
		$comment,
		$lines )

Receives the order, dispatches products.

Example: { "closeopenorder": 1, "comment": "", "lines": [{ "id": 14, "fk_product": 112, "qty": 18, "warehouse": 1, "price": 114, "comment": "", "eatby": 0, "sellby": 0, "batch": 0, "notrigger": 0 }] }

Parameters

int	$id	Order ID
integer	$closeopenorder	Close order if everything is received {@required false}
string	$comment	Comment {@required false}
array	$lines	Array of product dispatches

@url POST {id}/receive

Returns: array FIXME An error 403 is returned if the request has an empty body. Error message: "Forbidden: Content type `text/plain` is not supported."

Definition at line 666 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

◆ validate()

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

Validate an order.

Parameters

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

@url POST {id}/validate

Returns: array FIXME An error 403 is returned if the request has an empty body. Error message: "Forbidden: Content type `text/plain` is not supported." Workaround: send this in the body { "idwarehouse": 0, "notrigger": 0 }

Definition at line 504 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

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

dolibarr_20.0/htdocs/fourn/class/api_supplier_orders.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ approve()

◆ delete()

◆ deleteContact()

◆ get()

◆ getContacts()

◆ index()

◆ makeOrder()

◆ post()

◆ postContact()

◆ put()

◆ receiveOrder()

◆ validate()