GetItemsStock

Get Items Stock.

Overview

Url	api/public/FluentisErp/WM/Common/GetItemsStock
HTTP Method	POST
Method Type	Operation
Fluentis Object	None

ItemStockInputRequest properties

Property	Type	Is Required	Default Value	Description
Items	array	No	Empty list	List of ItemIdentification objects representing specific items
ItemVariants	array	No	Empty list	List of ItemVariantIdentification objects representing item variants
ItemClassCode	string	No	Empty string	Classification code of the item
ItemClassId	int?	No	null	Classification Id of the item
ItemCode	string	No	Empty string	Code of the item (filters items starting with this code)
ItemDescription	string	No	Empty string	Description of the item (filters items starting with this description)
VariantId	int?	No	null	Id of the item variant
VariantCode	string	No	Empty string	Code of the item variant
VariantDescription	string	No	Empty string	Description of the item variant
AccountId	int?	No	null	Id of the associated account
AccountCode	string	No	Empty string	Code of the associated account
AccountDetailCode	string	No	Empty string	Detail code of the associated account
AccountDescription	string	No	Empty string	Description of the associated account
VersionId	int?	No	null	Version Id of the item
WarehouseCode	string	No	Empty string	Code of the warehouse
WarehouseId	int?	No	null	Id of the warehouse
ProjectId	int?	No	null	Id of the associated project
ProjectItemId	int?	No	null	Id of the associated project item
FiscalCategoryId	int?	No	null	Fiscal category Id
ProductCategoryId	int?	No	null	Product category Id
ItemNatureId	int?	No	null	Nature Id of the item
ItemCharacteristicId	int?	No	null	Characteristic Id of the item
LocationId	int?	No	null	Location Id
LocationStatusId	int?	No	null	Location status Id
ProductionJobOrderId	int?	No	null	Production job order Id
LotRegisterCode	string	No	Empty string	Code of the lot register
FIPostingsFromWarehouseMovements	bool	No	false	Whether to generate FI postings from warehouse movements
ShowItemsArchived	bool	No	true	Whether to include archived items
ShowPositiveQuantity	bool	No	true	Whether to include items with positive quantity
ShowNegativeQuantity	bool	No	true	Whether to include items with negative quantity
ShowNullQuantity	bool	No	true	Whether to include items with zero quantity
StockGroupBy	int	Yes	-	How to group the stock results
StockDate	date-time?	No	null	The date at which stock is checked
AlternativeMeasurementUnitId	short?	No	null	Alternative measurement unit Id.
UseConversionFactor	bool	No	false	If it's true the alternative stock is calculated from the stock and the item's conversion factor for the alternative measurement unit, otherwise it's calculated only from the movements that have the alternative measurement unit.

ItemIdentification properties

Property	Type	Description
Id	integer	Id of the item to check stock for
ExternalSystem	string	Reference to external system for item identification
ExternalId	string	External system identifier of the item

ItemVariantIdentification properties

Property	Type	Description
Id	integer	Id of the item variant to check stock for
ExternalSystem	string	Reference to external system for item variant identification
ExternalId	string	External system identifier of the item variant

StockGroupBy values

Name	Value	Description
GroupByItemVariant	0	Group the stock results by Item, Item Variant
GroupByWarehouse	1	Group the stock results by Item, Item Variant and Warehouse
GroupByLocation	2	Group the stock results by Item, Item Variant and Location
GroupByProject	3	Group the stock results by Item, Item Variant and Project
GroupByAccount	4	Group the stock results by Item, Item Variant and Account
GroupByBatchRegister	5	Group the stock results by Item, Item Variant, Warehouse and Batch Register
GroupByProductionJobOrder	6	Group the stock results by Item, Item Variant, Warehouse, Location, Batch Register and Production Job Order
GroupByAllDetails	7	Group the stock results by Item, Item Variant, Warehouse, Location, Project, Account and Batch Register

Response properties

Parameter	Type	Is Required	Default Value	Description
ItemId	int	Yes	0	The unique identifier for the item
ItemVariantId	int?	No	null	The ID of the item variant, if applicable
ItemClassCode	string	No	Empty string	Code representing the classification of the item
ItemCode	string	No	Empty string	Alphanumeric code of the item
ItemDescription	string	No	Empty string	Description of the item
ItemSecondDescription	string	No	Empty string	Additional description for the item
ItemVariantCode	string	No	Empty string	Alphanumeric code of the item variant
ItemVariantDescription	string	No	Empty string	Description of the item variant
MeasurementUnitCode	string	No	Empty string	Code of the item's measurement unit
StandardCost	decimal?	No	null	The standard cost assigned to the item
AverageCost	decimal?	No	null	The average cost of the item
LatestCost	decimal?	No	null	The latest known cost of the item
NextStandardCost	decimal?	No	null	The upcoming standard cost for the item
WarehouseCode	string	No	Empty string	Code of the warehouse where the item is located
WarehouseDescription	string	No	Empty string	Description of the warehouse
CodeLocation	string	No	Empty string	Location code within the warehouse
ReceptionList	string	No	Empty string	Reference to the reception list
LocationStatus	string	No	Empty string	Status of the warehouse location
ProjectNumber	string	No	Empty string	Number associated with the project
ProjectYear	int?	No	null	Year of the associated project
ProjectItemLevelNumber	string	No	Empty string	Level number of the item in the project
ProjectItemDescription	string	No	Empty string	Description of the project item
AccountCode	string	No	Empty string	Code of the associated account
AccountDetailCode	string	No	Empty string	Detail code of the account
AccountDescription	string	No	Empty string	Description of the associated account
BatchRegisterCode	string	No	Empty string	Code of the batch register
VendorBatchCode	string	No	Empty string	Vendor's batch code
ProductionJobOrderNumber	int?	No	null	Number of the production job order
ProductionJobOrderYear	int?	No	null	Year of the production job order
WarehouseId	int?	No	null	Id of the warehouse
BatchRegisterId	int?	No	null	Id of the batch register
LocationId	int?	No	null	Id of the location
ProjectId	int?	No	null	Id of the associated project
ProjectItemId	int?	No	null	Id of the associated project item
AccountId	int?	No	null	Id of the associated account
ProductionJobOrderId	int?	No	null	Id of the production job order
AvailableQuantity	decimal?	No	null	Quantity of the item available for use or sale
StockQuantity	decimal?	No	null	Total stock quantity of the item
AlternativeStockQuantity	decimal?	No	null	Alternative stock calculated from stock quantity, alternative measurement unit and use conversion factor parameter.
RealAlternativeStockQuantity	decimal?	No	null	Stock quantity corresponding to the Alternative stock quantity ( if use conversion factor is true, then it's equal to stock quantity, otherwise it's the stock quantity calculated only from the movements that have the alternative measurement unit).