Materials Management | Materials Item

Service to manage entities of type 'MaterialsItem'.

This service extends Items.

Overview

api/{tenantKey}/{orgKey}/materialsCore/materialsItems

URL	api/{tenantKey}/{orgKey}/materialsCore/materialsItems
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiBaseMaterialsItemMaterialsItemWarehousesResource
ApiBaseMaterialsItemResource
ApiMaterialsItemMaterialsItemWarehousesResource
ApiMaterialsItemResource
BaseMaterialsItemMaterialsItemWarehousesResource
BaseMaterialsItemResource
MaterialsItemResource
MaterialsItemWarehouseResource

All Enumerations

This service uses the following enumerations:

ItemType

GET Operations

GET MaterialsItems

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/extension

GET /materialsCore/materialsItems/extension

GET MaterialsItems (paged)

Returns a page of the list of all the entity records available.

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 MaterialsItemResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/extension?page={page}&pageSize={pageSize}

GET /materialsCore/materialsItems/extension?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{id}/extension

GET /materialsCore/materialsItems/{id}/extension

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/extension

GET /materialsCore/materialsItems/{itemKey}/extension

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems

GET /materialsCore/materialsItems

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems?page={page}&pageSize={pageSize}

GET /materialsCore/materialsItems?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{id}

GET /materialsCore/materialsItems/{id}

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}

GET /materialsCore/materialsItems/{itemKey}

POST Operations

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/extension

POST /materialsCore/materialsItems/extension

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems

POST /materialsCore/materialsItems

POST Materials Item

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses

POST /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses

PUT Operations

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/calculatedUnitCost

PUT /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/calculatedUnitCost

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/committedQuantity

PUT /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/committedQuantity

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/currency

PUT /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/currency

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/defaultWarehouse

PUT /materialsCore/materialsItems/{itemKey}/defaultWarehouse

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/inventoryBalance

PUT /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/inventoryBalance

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/isActive

PUT /materialsCore/materialsItems/{itemKey}/isActive

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/isLocked

PUT /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/isLocked

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/itemSubtype

PUT /materialsCore/materialsItems/{itemKey}/itemSubtype

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/lastUnitCost

PUT /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/lastUnitCost

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/maxStock

PUT /materialsCore/materialsItems/{itemKey}/maxStock

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/minStock

PUT /materialsCore/materialsItems/{itemKey}/minStock

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/orderedQuantity

PUT /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/orderedQuantity

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/stockBalance

PUT /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}/stockBalance

DELETE Operations

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}

DELETE /materialsCore/materialsItems/{itemKey}/materialsItemWarehouses/{lineId}

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{id}

DELETE /materialsCore/materialsItems/{id}

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:

api/{tenantKey}/{orgKey}/materialsCore/materialsItems/{itemKey}

DELETE /materialsCore/materialsItems/{itemKey}

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	(decimal) The calculated unit cost for the warehouse.
inventoryBalance	(decimal) The inventory balance for the warehouse.
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	(decimal) The calculated unit cost for the warehouse.
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	(decimal) The calculated unit cost for the warehouse.
inventoryBalance	(decimal) The inventory balance for the warehouse.
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	(decimal) The calculated unit cost for the warehouse.
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	(decimal) The calculated unit cost for the warehouse.
inventoryBalance	(decimal) The inventory balance for the warehouse.
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	(decimal) The calculated unit cost for the warehouse.
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.

MaterialsItemWarehouseResource

The following elements are required:

warehouse	(string) The warehouse for the Materials Item Warehouse.
stockBalance	(decimal) The stock balance for the warehouse.
calculatedUnitCost	(decimal) The calculated unit cost for the warehouse.
inventoryBalance	(decimal) The inventory balance for the warehouse.
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	(decimal) The calculated unit cost for the warehouse.
currency	(string) The currency for the warehouse.

Enumerations

ItemType

1	Item
2	Service
3	SpecialSalesTaxes
4	Tax
5	Other