StockMovements

Since: 5.0.0 Initial implementation

class StockMovements extends DolibarrApi (View source)

API class for stock movements

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi
static string[] $FIELDS
MouvementStock $stockmovement

Methods

__construct()

Constructor

string|array<string, mixed>
_checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

from  DolibarrApi
object
_filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

from  DolibarrApi
object
_cleanObjectDatas(object $object)

Clean sensible object datas

static bool
_checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

from  DolibarrApi
bool|string
_checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

from  DolibarrApi
static string
_forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

from  DolibarrApi
object
get(int $id)

Get properties of a stock movement object

array
index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '', bool $pagination_data = false)

Get a list of stock movements

int
post(int $product_id, int $warehouse_id, float $qty, int $type = 2, string $batch = '', string $movementcode = '', string $label = '', string $price = '', string $datem = '', string $sellBy = '', string $eatBy = '', string $origin_type = '', int $origin_id = 0)

Create a stock movement

Details

at line 53
__construct()

Constructor

in DolibarrApi at line 98
protected string|array<string, mixed> _checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

Parameters

string $field

Field name
string|string[] $value

Value to check/clean
object $object Object

Return Value

string|array<string, mixed>

Value cleaned

in DolibarrApi at line 156
protected object _filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

Parameters

object $object

Object to clean
string $properties

Comma separated list of properties names

Return Value

object

Object with cleaned properties

at line 326
protected object _cleanObjectDatas(object $object)

Clean sensible object datas

Parameters

object $object

Object to clean

Return Value

object

Object with cleaned properties

in DolibarrApi at line 393
static protected bool _checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

Parameters

string $resource

element to check
int $resource_id

Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).
string $dbtablename

'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity. Not used if objectid is null (optional)
string $feature2

Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.
string $dbt_keyfield

Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)
string $dbt_select

Field name for select if not rowid. Not used if objectid is null (optional)

Return Value

bool

in DolibarrApi at line 421
protected bool|string _checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string $sqlfilters

sqlfilter string
string $error

Error message

Return Value

bool|string

True if valid, False if not valid

in DolibarrApi at line 439
static protected string _forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string[] $matches

Array of found string by regex search. Each entry is 1 and only 1 criteria. Example: "t.ref:like:'SO-%'", "t.date_creation:<:'20160101'", "t.date_creation:<:'2016-01-01 12:30:00'", "t.nature:is:NULL", "t.field2:isnot:NULL"

Return Value

string

Forged criteria. Example: "t.field like 'abc%'"

at line 77
object get(int $id)

Since: 23.0.0 Initial implementation

Get properties of a stock movement object

Return an array with stock movement information

Parameters

int $id

ID of stock movement

Return Value

object

Stock movement object with cleaned properties

Exceptions

RestException
RestException
RestException
RestException

at line 111
array index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '', bool $pagination_data = false)

Since: 5.0.0 Initial implementation

Get a list of stock movements

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.fk_product:=:1) and (t.date_creation:<:'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*

Return Value

array

Array of warehouse objects

Exceptions

RestException

at line 212
int post(int $product_id, int $warehouse_id, float $qty, int $type = 2, string $batch = '', string $movementcode = '', string $label = '', string $price = '', string $datem = '', string $sellBy = '', string $eatBy = '', string $origin_type = '', int $origin_id = 0)

Since: 5.0.0 Initial implementation

Create a stock movement

You can use the following message to test this REST API:

{ "product_id": 1, "warehouse_id": 1, "qty": 1, "batch": "", "movementcode": "INV123", "label": "Inventory 123", "price": 0 } $price Can be set to update AWP (Average Weighted Price) when you make a stock increase $eatBy Eat-by date. Will be used if a batch does not exist yet and will be created. sellBy Sell-by date. Will be used if a batch does not exist yet and will be created.

Parameters

int $product_id

ID product id {@min 1} {@from body} {@required true}
int $warehouse_id

ID warehouse {@min 1} {@from body} {@required true}
float $qty

Qty to add (Use negative value for a stock decrease) {@from body} {@required true}
int $type

Optionally specify the type of movement. 0=input (stock increase by a stock transfer), 1=output (stock decrease by a stock transfer), 2=output (stock decrease), 3=input (stock increase). {@from body} {@type int}
string $batch

Lot {@from body}
string $movementcode

Movement code {@from body}
string $label

Movement label {@from body}
string $price

To update AWP (Average Weighted Price) when you make a stock increase (qty must be higher then 0). {@from body}
string $datem

Date of movement {@from body} {@type date}
string $sellBy

Eat-by date. {@from body} {@type date}
string $eatBy

Sell-by date. {@from body} {@type date}
string $origin_type

Origin type (Element of source object, like 'project', 'inventory', ...)
int $origin_id

Origin id (ID of source object)

Return Value

int

ID of stock movement

Exceptions

RestException