API documentation
Method list
Test your request
Changelog


getInventoryDocumentSeries
This method allows you to retrieve information about available inventory document series in BaseLinker. Each series can be linked to a specific warehouse (warehouse_id) and can have its own numbering format settings.


Input parameters



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
document_seriesarrayList of document series. Each element contains the fields listed below.
| - document_series_idintUnique identifier of the series.
| - namevarchar(20)The name of the series.
| - document_typetinyint(4)The type of document for which this series is intended.
0 - GR (Goods Received)
1 - IGR (Internal Goods Received)
2 - GI (Goods Issue)
3 - IGI (Internal Goods Issue)
4 - IT (Internal Transfer)
5 - OB (Opening Balance)
| - warehouse_idintThe warehouse ID to which this series applies.
| - formatvarchar(30)The format for document numbering (e.g. "%N/%M/%Y/GR" in the format column).



Sample
Input data:
Output data:
A sample request in PHP: