Materials Management | Materials Item
Service to manage entities of type 'MaterialsItem'.
This service extends Items.
Overview
URL | api/{tenantKey}/{orgKey}/materialsCore/materialsItems |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive MaterialsItem
- PUT Set MaxStock MaterialsItem
- PUT Set MinStock MaterialsItem
- PUT Set DefaultWarehouse MaterialsItem
- PUT Set ItemSubtype MaterialsItem
- PUT Set StockBalance MaterialsItemWarehouse
- PUT Set CalculatedUnitCost MaterialsItemWarehouse
- PUT Set InventoryBalance MaterialsItemWarehouse
- PUT Set IsLocked MaterialsItemWarehouse
- PUT Set CommittedQuantity MaterialsItemWarehouse
- PUT Set OrderedQuantity MaterialsItemWarehouse
- PUT Set LastUnitCost MaterialsItemWarehouse
- PUT Set Currency MaterialsItemWarehouse
- DELETE:
All Resources
This service uses the following resources:
- ApiBaseMaterialsItemMaterialsItemWarehousesResource
- ApiBaseMaterialsItemResource
- ApiMaterialsItemMaterialsItemWarehousesResource
- ApiMaterialsItemResource
- BaseMaterialsItemMaterialsItemWarehousesResource
- BaseMaterialsItemResource
- MaterialsItemResource
- MoneyResource
All Enumerations
This service uses the following enumerations:
GET MaterialsItems (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See MaterialsItemResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET MaterialsItem by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See MaterialsItemResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET MaterialsItem by key
Returns the entity record that matches the specified key.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
Response:
When successful, the response body contains the entity record. See MaterialsItemResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET MaterialsItems (with Item)
Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.
Response:
When successful, the response body contains the list of records available. See BaseMaterialsItemResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET MaterialsItems (with Item) (paged)
Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.
The following elements are optional:
page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
When successful, the response body contains the list of records available. See BaseMaterialsItemResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET MaterialsItem (with Item) by identifier
Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See BaseMaterialsItemResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET MaterialsItem (with Item) by key
Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
Response:
When successful, the response body contains the entity record. See BaseMaterialsItemResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST MaterialsItems
Creates a new entity record.
The following elements are required:
materialsItemResource | (ApiMaterialsItemResource) The request body should contain the entity record that should be created. See ApiMaterialsItemResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiMaterialsItemResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST MaterialsItems (with ApiBaseMaterialsItem)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
materialsItemResource | (ApiMaterialsItemResource) The request body should contain the entity record that should be created. See ApiMaterialsItemResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiBaseMaterialsItemResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Materials Item Warehouse
Inserts a new 'Materials Item Warehouse' in the 'Materials Item'.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
value | (ApiMaterialsItemMaterialsItemWarehousesResource) The ApiMaterialsItemMaterialsItemWarehousesResource instance. See ApiMaterialsItemMaterialsItemWarehousesResource. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CalculatedUnitCost MaterialsItemWarehouse
Updates the value of attribute 'CalculatedUnitCost' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
lineId | (string) The detail identifier. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CommittedQuantity MaterialsItemWarehouse
Updates the value of attribute 'CommittedQuantity' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
lineId | (string) The detail identifier. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Currency MaterialsItemWarehouse
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
lineId | (string) The detail identifier. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DefaultWarehouse MaterialsItem
Updates the value of attribute 'DefaultWarehouse' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set InventoryBalance MaterialsItemWarehouse
Updates the value of attribute 'InventoryBalance' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
lineId | (string) The detail identifier. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive MaterialsItem
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set IsLocked MaterialsItemWarehouse
Updates the value of attribute 'IsLocked' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
lineId | (string) The detail identifier. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ItemSubtype MaterialsItem
Updates the value of attribute 'ItemSubtype' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LastUnitCost MaterialsItemWarehouse
Updates the value of attribute 'LastUnitCost' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
lineId | (string) The detail identifier. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set MaxStock MaterialsItem
Updates the value of attribute 'MaxStock' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set MinStock MaterialsItem
Updates the value of attribute 'MinStock' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set OrderedQuantity MaterialsItemWarehouse
Updates the value of attribute 'OrderedQuantity' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
lineId | (string) The detail identifier. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set StockBalance MaterialsItemWarehouse
Updates the value of attribute 'StockBalance' in the specified entity record.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
lineId | (string) The detail identifier. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE Materials Item Warehouse by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
lineId | (string) The line identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE MaterialsItem by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE MaterialsItem by key
Deletes the entity record that matches the specified key.
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiBaseMaterialsItemMaterialsItemWarehousesResource
The following elements are required:
warehouse | (string) The warehouse for the Materials Item Warehouse. |
stockBalance | (decimal) The stock balance for the warehouse. |
calculatedUnitCost | (MoneyResource) The calculated unit cost for the warehouse.
See MoneyResource . |
inventoryBalance | (MoneyResource) The inventory balance for the warehouse.
See MoneyResource . |
isLocked | (bool) Indicates if the warehouse is currently locked. |
committedQuantity | (decimal) The committed quantity for the warehouse. |
orderedQuantity | (decimal) The ordered quantity for the warehouse. |
lastUnitCost | (MoneyResource) The calculated unit cost for the warehouse.
See MoneyResource . |
currency | (string) The currency for the warehouse. |
ApiBaseMaterialsItemResource
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
description | (string) The description for the item. |
isExternallyManaged | (bool) A flag indicating if the item is externally managed. |
baseUnit | (string) The base unit for the item. |
itemType | (enum ItemType) The item type for the item.
See ItemType. |
manageInventory | (bool) Manage Inventory. |
availableInSales | (bool) Available for Sales. |
availableInPurchases | (bool) Available for Purchases. |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Materials Item. |
minStock | (decimal) The minimum stock for the Materials Item. |
materialsItemWarehouses | (List of ApiBaseMaterialsItemMaterialsItemWarehousesResource) The Materials Item Warehouses for the Materials Item.
See ApiBaseMaterialsItemMaterialsItemWarehousesResource. |
defaultWarehouse | (string) The default warehouse for the Materials Item. |
itemSubtype | (string) The Item Subtype for the Materials Item. |
complementaryDescription | (string) The extended description for the item. |
assortment | (string) The assortment for the item. |
barcode | (string) The barcode for the item. |
brand | (string) The brand for the item. |
image | (string) The picture for the item. |
remarks | (string) The remarks for the item. |
externalId | (string) The external identifier for the item. |
externalVersion | (string) The external version for the item. |
brandModel | (string) The brand model for the item. |
ApiMaterialsItemMaterialsItemWarehousesResource
The following elements are required:
warehouse | (string) The warehouse for the Materials Item Warehouse. |
stockBalance | (decimal) The stock balance for the warehouse. |
calculatedUnitCost | (MoneyResource) The calculated unit cost for the warehouse.
See MoneyResource . |
inventoryBalance | (MoneyResource) The inventory balance for the warehouse.
See MoneyResource . |
isLocked | (bool) Indicates if the warehouse is currently locked. |
committedQuantity | (decimal) The committed quantity for the warehouse. |
orderedQuantity | (decimal) The ordered quantity for the warehouse. |
lastUnitCost | (MoneyResource) The calculated unit cost for the warehouse.
See MoneyResource . |
currency | (string) The currency for the warehouse. |
ApiMaterialsItemResource
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Materials Item. |
minStock | (decimal) The minimum stock for the Materials Item. |
materialsItemWarehouses | (List of ApiMaterialsItemMaterialsItemWarehousesResource) The Materials Item Warehouses for the Materials Item.
See ApiMaterialsItemMaterialsItemWarehousesResource. |
defaultWarehouse | (string) The default warehouse for the Materials Item. |
itemSubtype | (string) The Item Subtype for the Materials Item. |
BaseMaterialsItemMaterialsItemWarehousesResource
The following elements are required:
warehouse | (string) The warehouse for the Materials Item Warehouse. |
stockBalance | (decimal) The stock balance for the warehouse. |
calculatedUnitCost | (MoneyResource) The calculated unit cost for the warehouse.
See MoneyResource . |
inventoryBalance | (MoneyResource) The inventory balance for the warehouse.
See MoneyResource . |
isLocked | (bool) Indicates if the warehouse is currently locked. |
committedQuantity | (decimal) The committed quantity for the warehouse. |
orderedQuantity | (decimal) The ordered quantity for the warehouse. |
lastUnitCost | (MoneyResource) The calculated unit cost for the warehouse.
See MoneyResource . |
currency | (string) The currency for the warehouse. |
BaseMaterialsItemResource
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
description | (string) The description for the item. |
isExternallyManaged | (bool) A flag indicating if the item is externally managed. |
baseUnit | (string) The base unit for the item. |
itemType | (enum ItemType) The item type for the item.
See ItemType. |
manageInventory | (bool) Manage Inventory. |
availableInSales | (bool) Available for Sales. |
availableInPurchases | (bool) Available for Purchases. |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Materials Item. |
minStock | (decimal) The minimum stock for the Materials Item. |
materialsItemWarehouses | (List of BaseMaterialsItemMaterialsItemWarehousesResource) The Materials Item Warehouses for the Materials Item.
See BaseMaterialsItemMaterialsItemWarehousesResource. |
defaultWarehouse | (string) The default warehouse for the Materials Item. |
itemSubtype | (string) The Item Subtype for the Materials Item. |
complementaryDescription | (string) The extended description for the item. |
assortment | (string) The assortment for the item. |
barcode | (string) The barcode for the item. |
brand | (string) The brand for the item. |
image | (string) The picture for the item. |
remarks | (string) The remarks for the item. |
externalId | (string) The external identifier for the item. |
externalVersion | (string) The external version for the item. |
brandModel | (string) The brand model for the item. |
MaterialsItemResource
The following elements are required:
itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Materials Item. |
minStock | (decimal) The minimum stock for the Materials Item. |
materialsItemWarehouses | (List of MaterialsItemWarehouseResource) The Materials Item Warehouses for the Materials Item.
See MaterialsItemWarehouseResource. |
defaultWarehouse | (string) The default warehouse for the Materials Item.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service. |
itemSubtype | (string) The Item Subtype for the Materials Item.
(fk) Allowed value: the natural key of a record of type ItemSubtype. These records are accessibly through the ItemSubtypes service. |
MoneyResource
The following elements are required:
amount | (decimal) The amount. |
The following elements are optional:
baseAmount | (decimal) The base amount. |
reportingAmount | (decimal) The reporting amount. |
fractionDigits | (int) The fraction digits. |
symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.