Inheritance diagram for Receptions:

Collaboration diagram for Receptions:

Public Member Functions
	__construct ()
	Constructor.

	get ($id)
	Get properties of a reception object.

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

	post ($request_data=null)
	Create reception object.

	getLines ($id)
	Get lines of a reception.

	postLine ($id, $fk_origin_line=0, $qty=0, $warehouse_id=0, $batch='', $eatby='', $sellby='', $cost_price=0, $comment='')
	Add a line to a given reception.

	putLine ($id, $lineid, $qty=0, $warehouse_id=0)
	Update a line of a given reception.

	deleteLine ($id, $lineid)
	Delete a line of a given reception.

	put ($id, $request_data=null)
	Update reception general fields (won't touch lines of reception)

	delete ($id)
	Delete reception.

	validate ($id, $notrigger=0)
	Validate a reception.

	close ($id, $notrigger=0)
	Classify the reception as invoiced.

	setToDraft ($id)
	Set a reception back to draft status.

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

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas @phpstan-template T.

Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name.

	_checkValExtrafieldsForAPI ($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
	fetchLineOfReception ($lineid)
	Load a line and check it belongs to the reception currently loaded.

	_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', $parenttableforentity='')
	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 36 of file api_receptions.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Receptions::_cleanObjectDatas ( $object )

protected

Clean sensible object datas @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 846 of file api_receptions.class.php.

References $object.

Referenced by close(), get(), getLines(), index(), setToDraft(), and validate().

◆ _validate()

Receptions::_validate ( $data )

private

Validate fields before create or update object.

Parameters

?array<string,mixed|mixed[]> $data Array with data to verify

Returns: array<string,mixed|mixed[]>

Exceptions

RestException

Definition at line 885 of file api_receptions.class.php.

References getDolGlobalString().

Referenced by post().

◆ close()

Receptions::close	(		$id,
			$notrigger = 0 )

Classify the reception as invoiced.

Parameters

int $id Id of the reception

@url POST {id}/setinvoiced

Returns: int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405 Create a reception using an existing order.

Parameters

int $orderid Id of the order

@url POST /createfromorder/{orderid}

Returns: int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405 Close a reception (Classify it as "Delivered")

Parameters

int	$id	Reception ID
int	$notrigger	Disabled triggers

@url POST {id}/close

Returns: Object

Definition at line 753 of file api_receptions.class.php.

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

◆ delete()

Receptions::delete ( $id )

Delete reception.

Parameters

int $id Reception ID

Returns: array @phan-return array{success:array{code:int,message:string}} @phpstan-return array{success:array{code:int,message:string}}

Definition at line 592 of file api_receptions.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ deleteLine()

Receptions::deleteLine	(		$id,
			$lineid )

Delete a line of a given reception.

A line can only be deleted while the reception is still a draft: once validated the stock has already been moved, so removing the line would desync the stock.

Parameters

int	$id	Id of reception to update
int	$lineid	Id of line to delete

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

Returns: Object Updated reception

Exceptions

RestException	403
RestException	404
RestException	405
RestException	500

Definition at line 481 of file api_receptions.class.php.

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

◆ fetchLineOfReception()

Receptions::fetchLineOfReception ( $lineid )

private

Load a line and check it belongs to the reception currently loaded.

Parameters

int $lineid Id of the line to load

Returns: ReceptionLineBatch Loaded line

Exceptions

RestException 404

Definition at line 519 of file api_receptions.class.php.

Referenced by deleteLine(), and putLine().

◆ get()

Receptions::get ( $id )

Get properties of a reception object.

Return an array with reception information

Parameters

int $id ID of reception

Returns: Object Object with cleaned properties

Exceptions

RestException

Definition at line 71 of file api_receptions.class.php.

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

◆ getLines()

Receptions::getLines ( $id )

Get lines of a reception.

Parameters

int $id Id of reception

@url GET {id}/lines

Returns: array @phan-return ReceptionLineBatch[] @phpstan-return ReceptionLineBatch[]

Exceptions

RestException	403
RestException	404

Definition at line 279 of file api_receptions.class.php.

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

◆ index()

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

List receptions.

Get a list of receptions

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 receptions of (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'). (el.fk_source:=:123) allows filtering by supplier order id"
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 reception objects @phan-return Reception[]|array{data:Reception[],pagination:array{total:int,page:int,page_count:int,limit:int}} @phpstan-return Reception[]|array{data:Reception[],pagination:array{total:int,page:int,page_count:int,limit:int}}

Exceptions

RestException

Definition at line 111 of file api_receptions.class.php.

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

◆ post()

Receptions::post ( $request_data = null )

Create reception object.

Parameters

array $request_data Request data @phan-param ?array<string,string|mixed[]> $request_data @phpstan-param ?array<string,string|mixed[]> $request_data

Returns: int ID of reception created

Definition at line 215 of file api_receptions.class.php.

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

◆ postLine()

Receptions::postLine	(	$id,
		$fk_origin_line = 0,
		$qty = 0,
		$warehouse_id = 0,
		$batch = '',
		$eatby = '',
		$sellby = '',
		$cost_price = 0,
		$comment = '' )

Add a line to a given reception.

A reception line always references the supplier order line it receives (fk_elementdet): the received quantity relates to that order line. A line can only be added while the reception is still a draft, before any stock movement.

Parameters

int	$id	Id of reception to update
int	$fk_origin_line	Id of the supplier order line received by this line {@from body}{@required true}
float	$qty	Quantity to receive for this line {@from body}{@required true}{@min 1}
int	$warehouse_id	Target warehouse id (may be optional depending on STOCK_WAREHOUSE_NOT_REQUIRED_FOR_RECEPTIONS) {@from body}{@required false}
string	$batch	Lot/serial number (mandatory for a batch managed product) {@from body}{@required false}
string	$eatby	Eat-by date, timestamp or date string (batch managed product only) {@from body}{@required false}
string	$sellby	Sell-by date, timestamp or date string (batch managed product only) {@from body}{@required false}
float	$cost_price	Line cost used to update the AWP on validation {@from body}{@required false}
string	$comment	Comment kept on the stock movement {@from body}{@required false}

@url POST {id}/lines

Returns: int Id of the created reception line

Exceptions

RestException	400
RestException	403
RestException	404
RestException	405
RestException	500

Definition at line 330 of file api_receptions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), dol_stringtotime(), and dol_strlen().

◆ put()

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

Update reception general fields (won't touch lines of reception)

Parameters

int	$id	Id of reception to update
array	$request_data	Datas @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: Object Object with cleaned properties

Definition at line 543 of file api_receptions.class.php.

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

◆ putLine()

Receptions::putLine	(	$id,
		$lineid,
		$qty = 0,
		$warehouse_id = 0 )

Update a line of a given reception.

Only the quantity (and optionally the target warehouse) of the line can be changed, and only while the reception is still a draft: once validated the stock has already been moved, so editing the line would desync the stock. Lot/serial data is set at line creation - delete the line and create it again to change it.

Parameters

int	$id	Id of reception to update
int	$lineid	Id of line to update
float	$qty	New quantity to receive for this line {@from body}{@required true}{@min 1}
int	$warehouse_id	Target warehouse id for this line (optional, 0 to keep the current one) {@from body}{@required false}

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

Returns: Object Updated reception

Exceptions

RestException	400
RestException	403
RestException	404
RestException	405
RestException	500

Definition at line 423 of file api_receptions.class.php.

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

◆ setToDraft()

Receptions::setToDraft ( $id )

Set a reception back to draft status.

This reverts a validated reception to draft. If stock movements were recorded at validation (module stock enabled and STOCK_CALCULATE_ON_RECEPTION on), they are cancelled back by the native method, and the supplier order goes back to "ordered" when no validated reception remains.

Parameters

int $id Reception ID

@url POST {id}/settodraft

Returns: Object

Exceptions

RestException	304
RestException	403
RestException	404
RestException	500

Definition at line 803 of file api_receptions.class.php.

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

◆ validate()

Receptions::validate	(		$id,
			$notrigger = 0 )

Validate a reception.

This may record stock movements if module stock is enabled and option to decrease stock on reception is on.

Parameters

int	$id	Reception ID
int	$notrigger	{@from query} 1=Does not execute triggers, 0= execute triggers (optional)

@url POST {id}/validate

Returns: Object

Definition at line 631 of file api_receptions.class.php.

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

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

dolibarr_dev/htdocs/reception/class/api_receptions.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ close()

◆ delete()

◆ deleteLine()

◆ fetchLineOfReception()

◆ get()

◆ getLines()

◆ index()

◆ post()

◆ postLine()

◆ put()

◆ putLine()

◆ setToDraft()

◆ validate()