Parts and Inventory | Inventory Part
Service to manage entities of type 'InventoryPart'.
This service extends Parts.
Overview
URL | api/{tenantKey}/{orgKey}/inventoryCore/inventoryParts |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute InventoryPart
- PUT Set Custom Attribute InventoryPartWarehouse
- PUT Set IsActive InventoryPart
- PUT Set MaxStock InventoryPart
- PUT Set MinStock InventoryPart
- PUT Set DefaultWarehouse InventoryPart
- PUT Set PartSubType InventoryPart
- PUT Set StockBalance InventoryPartWarehouse
- PUT Set UnitCost InventoryPartWarehouse
- PUT Set InventoryBalance InventoryPartWarehouse
- PUT Set IsLocked InventoryPartWarehouse
- PUT Set Warehouse InventoryPartWarehouse
- PUT Set ManagedExternally InventoryPartWarehouse
- PUT Set Currency InventoryPartWarehouse
- PUT Set CalculatedUnitCost InventoryPartWarehouse
- PUT Set AverageCostPricing InventoryPartWarehouse
- PUT Set MaxStock InventoryPartWarehouse
- PUT Set MinStock InventoryPartWarehouse
- DELETE:
All Resources
This service uses the following resources:
- ApiBaseInventoryPartInventoryPartWarehousesResource
- ApiBaseInventoryPartResource
- ApiInventoryPartInventoryPartWarehousesResource
- ApiInventoryPartResource
- BaseInventoryPartInventoryPartWarehousesResource
- BaseInventoryPartResource
- InventoryPartExtend
- InventoryPartResource
- InventoryPartViewInventoryPartWarehousesResource
- InventoryPartViewResource
- MoneyResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET InventoryParts (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 InventoryPartResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET InventoryPart 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 InventoryPartResource. |
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 InventoryPart by key
Returns the entity record that matches the specified key.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
Response:
When successful, the response body contains the entity record. See InventoryPartResource. |
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 InventoryParts (with Part)
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 BaseInventoryPartResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET InventoryParts (with Part) (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 BaseInventoryPartResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET InventoryPart (with Part) 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 BaseInventoryPartResource. |
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 InventoryPart (with Part) 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:
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
Response:
When successful, the response body contains the entity record. See BaseInventoryPartResource. |
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 InventoryParts
Creates a new entity record.
The following elements are required:
inventoryPartResource | (ApiInventoryPartResource) The request body should contain the entity record that should be created. See ApiInventoryPartResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
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 ApiInventoryPartResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST InventoryParts (with ApiBaseInventoryPart)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
inventoryPartResource | (ApiInventoryPartResource) The request body should contain the entity record that should be created. See ApiInventoryPartResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
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 ApiBaseInventoryPartResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Inventory Part Warehouse
Inserts a new 'Inventory Part Warehouse' in the 'Inventory Part'.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
value | (ApiInventoryPartInventoryPartWarehousesResource) The ApiInventoryPartInventoryPartWarehousesResource instance. See ApiInventoryPartInventoryPartWarehousesResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
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:
POST Change Stock Balance
Custom operation 'ChangeStockBalance'.
The following elements are required:
inventoryPartId | (Guid) InventoryPartId. |
inventoryPartWarehouseId | (Guid) InventoryPartWarehouseId. |
warehouseId | (Guid) WarehouseId. |
stockBalance | (decimal) StockBalance. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body contains an item of type 'boolean'. |
Resource URL:
POST Register Average Cost Pricing
Custom operation 'RegisterAverageCostPricing'.
The following elements are required:
inventoryPartId | (Guid) InventoryPartId. |
warehouseId | (Guid) WarehouseId. |
price | (decimal) Price. |
quantity | (decimal) Quantity. |
date | (DateTime?) Date. |
currency | (Guid) Currency. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body contains a unique identifier. |
Resource URL:
POST Extend Inventory Parts
Custom operation 'ExtendInventoryParts'.
The following elements are required:
inventoryPartExtend | (InventoryPartExtend) InventoryPartExtend. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body contains a unique identifier. |
Resource URL:
PUT Set AverageCostPricing InventoryPartWarehouse
Updates the value of attribute 'AverageCostPricing' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 CalculatedUnitCost InventoryPartWarehouse
Updates the value of attribute 'CalculatedUnitCost' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 InventoryPartWarehouse
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 InventoryPart
Updates the value of attribute 'DefaultWarehouse' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 InventoryPartWarehouse
Updates the value of attribute 'InventoryBalance' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 InventoryPart
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 InventoryPartWarehouse
Updates the value of attribute 'IsLocked' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 ManagedExternally InventoryPartWarehouse
Updates the value of attribute 'ManagedExternally' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 MaxStock InventoryPart
Updates the value of attribute 'MaxStock' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 MaxStock InventoryPartWarehouse
Updates the value of attribute 'MaxStock' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 MinStock InventoryPart
Updates the value of attribute 'MinStock' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 InventoryPartWarehouse
Updates the value of attribute 'MinStock' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 PartSubType InventoryPart
Updates the value of attribute 'PartSubType' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 StockBalance InventoryPartWarehouse
Updates the value of attribute 'StockBalance' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 UnitCost InventoryPartWarehouse
Updates the value of attribute 'UnitCost' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 Warehouse InventoryPartWarehouse
Updates the value of attribute 'Warehouse' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 Custom Attribute InventoryPart
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
customAttributeName | (string) The custom attribute name. |
value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
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 Custom Attribute InventoryPartWarehouse
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
lineId | (string) The detail identifier. |
customAttributeName | (string) The custom attribute name. |
value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
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:
DELETE Inventory Part Warehouse by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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 InventoryPart 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 InventoryPart by key
Deletes the entity record that matches the specified key.
The following elements are required:
partKey | (string) The key for the part. Uniquely identifies the part 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
ApiBaseInventoryPartInventoryPartWarehousesResource
The following elements are required:
stockBalance | (decimal) The stock balance for the warehouse. |
unitCost | (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. |
warehouse | (string) Warehouse. |
currency | (string) Currency. |
calculatedUnitCost | (MoneyResource) Calculated Unit Cost.
See MoneyResource . |
averageCostPricing | (MoneyResource) Average Cost Pricing.
See MoneyResource . |
The following elements are optional:
managedExternally | (bool) Managed Externally. |
maxStock | (decimal) The maximum stock for the Inventory Part for the Warehouse. |
minStock | (decimal) The minimun stock for the Inventory Part for the Warehouse. |
ApiBaseInventoryPartResource
The following elements are required:
defaultWarehouse | (string) The default warehouse for the Inventory Part. |
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
description | (string) The description for the part. |
isExternallyManaged | (bool) A flag indicating if the part is externally managed. |
baseUnit | (string) The base unit for the part. |
partType | (enum PartType) The part type for the part.
See PartType. |
haveDependents | (bool) Have Dependents. |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Inventory Part. |
minStock | (decimal) The minimum stock for the Inventory Part. |
partSubType | (string) The Part Subtype for the Inventory Part. |
inventoryPartWarehouses | (List of ApiBaseInventoryPartInventoryPartWarehousesResource) Inventory Part Warehouses.
See ApiBaseInventoryPartInventoryPartWarehousesResource. |
complementaryDescription | (string) The extended description for the part. |
keyword | (string) Keyword. |
family | (string) The assortment for the part. |
barcode | (string) The barcode for the part. |
brand | (string) The brand for the part. |
image | (string) The picture for the part. |
remarks | (string) The remarks for the part. |
externalId | (string) The external identifier for the part. |
externalVersion | (string) The external version for the part. |
brandModel | (string) The brand model for the part. |
supplier | (string) Supplier. |
attribute | (string) Attribute. |
ApiInventoryPartInventoryPartWarehousesResource
The following elements are required:
stockBalance | (decimal) The stock balance for the warehouse. |
unitCost | (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. |
warehouse | (string) Warehouse. |
currency | (string) Currency. |
calculatedUnitCost | (MoneyResource) Calculated Unit Cost.
See MoneyResource . |
averageCostPricing | (MoneyResource) Average Cost Pricing.
See MoneyResource . |
The following elements are optional:
managedExternally | (bool) Managed Externally. |
maxStock | (decimal) The maximum stock for the Inventory Part for the Warehouse. |
minStock | (decimal) The minimun stock for the Inventory Part for the Warehouse. |
ApiInventoryPartResource
The following elements are required:
defaultWarehouse | (string) The default warehouse for the Inventory Part. |
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Inventory Part. |
minStock | (decimal) The minimum stock for the Inventory Part. |
partSubType | (string) The Part Subtype for the Inventory Part. |
inventoryPartWarehouses | (List of ApiInventoryPartInventoryPartWarehousesResource) Inventory Part Warehouses.
See ApiInventoryPartInventoryPartWarehousesResource. |
BaseInventoryPartInventoryPartWarehousesResource
The following elements are required:
stockBalance | (decimal) The stock balance for the warehouse. |
unitCost | (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. |
warehouse | (string) Warehouse. |
currency | (string) Currency. |
calculatedUnitCost | (MoneyResource) Calculated Unit Cost.
See MoneyResource . |
averageCostPricing | (MoneyResource) Average Cost Pricing.
See MoneyResource . |
The following elements are optional:
managedExternally | (bool) Managed Externally. |
maxStock | (decimal) The maximum stock for the Inventory Part for the Warehouse. |
minStock | (decimal) The minimun stock for the Inventory Part for the Warehouse. |
BaseInventoryPartResource
The following elements are required:
defaultWarehouse | (string) The default warehouse for the Inventory Part. |
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
description | (string) The description for the part. |
isExternallyManaged | (bool) A flag indicating if the part is externally managed. |
baseUnit | (string) The base unit for the part. |
partType | (enum PartType) The part type for the part.
See PartType. |
haveDependents | (bool) Have Dependents. |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Inventory Part. |
minStock | (decimal) The minimum stock for the Inventory Part. |
partSubType | (string) The Part Subtype for the Inventory Part. |
inventoryPartWarehouses | (List of BaseInventoryPartInventoryPartWarehousesResource) Inventory Part Warehouses.
See BaseInventoryPartInventoryPartWarehousesResource. |
complementaryDescription | (string) The extended description for the part. |
keyword | (string) Keyword. |
family | (string) The assortment for the part. |
barcode | (string) The barcode for the part. |
brand | (string) The brand for the part. |
image | (string) The picture for the part. |
remarks | (string) The remarks for the part. |
externalId | (string) The external identifier for the part. |
externalVersion | (string) The external version for the part. |
brandModel | (string) The brand model for the part. |
supplier | (string) Supplier. |
attribute | (string) Attribute. |
InventoryPartExtend
The following elements are required:
partKey | (string) Part Key. |
description | (string) Description. |
partType | (enum PartType) Part Type.
See PartType. |
baseUnit | (string) Base Unit. |
The following elements are optional:
complementaryDescription | (string) Complementary Description. |
keyword | (string) Keyword. |
barcode | (string) Barcode. |
family | (string) Family. |
brand | (string) Brand. |
brandModel | (string) Brand Model. |
supplier | (string) Supplier. |
remarks | (string) Remarks. |
partSubType | (string) Part Sub Type. |
warehouse | (string) Warehouse. |
minStock | (decimal) Min Stock. |
maxStock | (decimal) Max Stock. |
unitCost | (decimal) Unit Cost. |
InventoryPartResource
The following elements are required:
defaultWarehouse | (string) The default warehouse for the Inventory Part.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service. |
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Inventory Part. |
minStock | (decimal) The minimum stock for the Inventory Part. |
partSubType | (string) The Part Subtype for the Inventory Part.
(fk) Allowed value: the natural key of a record of type PartSubType. These records are accessibly through the PartSubTypes service. |
inventoryPartWarehouses | (List of InventoryPartWarehouseResource) Inventory Part Warehouses.
See InventoryPartWarehouseResource. |
InventoryPartViewInventoryPartWarehousesResource
The following elements are required:
unitCost | (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. |
stockBalance | (decimal) The stock balance for the warehouse. |
warehouse | (string) Warehouse. |
averageCostPricing | (MoneyResource) Average Cost Pricing.
See MoneyResource . |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Inventory Part for the Warehouse. |
minStock | (decimal) The minimun stock for the Inventory Part for the Warehouse. |
managedExternally | (bool) Managed Externally. |
InventoryPartViewResource
The following elements are required:
defaultWarehouse | (string) The default warehouse for the Inventory Part. |
partKey | (string) The key for the part. Uniquely identifies the part within the organization. |
The following elements are optional:
maxStock | (decimal) The maximum stock for the Inventory Part. |
minStock | (decimal) The minimum stock for the Inventory Part. |
partSubType | (string) The Part Subtype for the Inventory Part. |
inventoryPartWarehouses | (List of InventoryPartViewInventoryPartWarehousesResource) Inventory Part Warehouses.
See InventoryPartViewInventoryPartWarehousesResource. |
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.
ExtensibilityCustomAttributeValueResource
The following elements are required:
value | (object) The custom attribute value. |