dolibarr  16.0.5
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
SupplierOrders Class Reference
Inheritance diagram for SupplierOrders:
Inheritance graph
[legend]
Collaboration diagram for SupplierOrders:
Collaboration graph
[legend]

Public Member Functions

 __construct ()
 Constructor.
 
 get ($id)
 Get properties of a supplier order object. More...
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $product_ids='', $status='', $sqlfilters='')
 List orders. More...
 
 post ($request_data=null)
 Create supplier order object. More...
 
 put ($id, $request_data=null)
 Update supplier order. More...
 
 delete ($id)
 Delete supplier order. More...
 
 validate ($id, $idwarehouse=0, $notrigger=0)
 Validate an order. More...
 
 approve ($id, $idwarehouse=0, $secondlevel=0)
 Approve an order. More...
 
 makeOrder ($id, $date, $method, $comment='')
 Sends an order to the vendor. More...
 
 receiveOrder ($id, $closeopenorder, $comment, $lines)
 Receives the order, dispatches products. More...
 
- Public Member Functions inherited from DolibarrApi
 __construct ($db, $cachedir='', $refreshCache=false)
 Constructor. More...
 

Protected Member Functions

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

Private Member Functions

 _validate ($data)
 Validate fields before create or update object. More...
 

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. More...
 
static _forge_criteria_callback ($matches)
 Function to forge a SQL criteria from a Generic filter string. More...
 

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$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

◆ _validate()

SupplierOrders::_validate (   $data)
private

Validate fields before create or update object.

Parameters
array$dataDatas to validate
Returns
array
Exceptions
RestException

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

◆ approve()

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

Approve an order.

Parameters
int$idOrder ID
int$idwarehouseWarehouse ID
int$secondlevel1=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 390 of file api_supplier_orders.class.php.

◆ delete()

SupplierOrders::delete (   $id)

Delete supplier order.

Parameters
int$idSupplier order ID
Returns
array Array of result

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

◆ get()

SupplierOrders::get (   $id)

Get properties of a supplier order object.

Return an array with supplier order information

Parameters
int$idID of supplier order
Returns
array|mixed data without useless information
Exceptions
RestException

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

◆ index()

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

List orders.

Get a list of supplier orders

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$thirdparty_idsThirdparty ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string$product_idsProduct ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string$statusFilter by order status : draft | validated | approved | running | received_start | received_end | cancelled | refused
string$sqlfiltersOther criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.datec:<:'20160101')"
Returns
array Array of order objects
Exceptions
RestException

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

◆ makeOrder()

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

Sends an order to the vendor.

Parameters
int$idOrder ID
integer$dateDate (unix timestamp in sec)
int$methodMethod
string$commentComment

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

◆ 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_dataRequest datas
Returns
int ID of supplier order

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

◆ put()

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

Update supplier order.

Parameters
int$idId of supplier order to update
array$request_dataDatas
Returns
int

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

◆ 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$idOrder ID
integer$closeopenorderClose order if everything is received {@required false}
string$commentComment {@required false}
array$linesArray 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 504 of file api_supplier_orders.class.php.

◆ validate()

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

Validate an order.

Parameters
int$idOrder ID
int$idwarehouseWarehouse ID
int$notrigger1=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 342 of file api_supplier_orders.class.php.


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