Sales | Sales Item
Service to manage entities of type 'SalesItem'.
This service extends Items.
Overview
| URL | api/{tenantKey}/{orgKey}/salesCore/salesItems |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive SalesItem
- PUT Set Unit SalesItem
- PUT Set ItemTaxSchema SalesItem
- PUT Set ItemWithholdingTaxSchema SalesItem
- PUT Set IncomeAccount SalesItem
- PUT Set Locked SalesItem
- PUT Set PriceAmount PriceListLine
- PUT Set Unit PriceListLine
- PUT Set PriceList PriceListLine
- PUT Set Currency PriceListLine
- PUT Set Selected SalesChannelLine
- DELETE:
All Resources
This service uses the following resources:
- ApiBaseSalesItemPriceListLinesResource
- ApiBaseSalesItemResource
- ApiBaseSalesItemSalesChannelLinesResource
- ApiSalesItemPriceListLinesResource
- ApiSalesItemResource
- ApiSalesItemSalesChannelLinesResource
- BaseSalesItemPriceListLinesResource
- BaseSalesItemResource
- BaseSalesItemSalesChannelLinesResource
- CatalogsItem
- PriceListLineResource
- SalesChannelLineResource
- SalesItemResource
All Enumerations
This service uses the following enumerations:
GET SalesItems
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See SalesItemResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/salesCore/salesItems/extension
GET /salesCore/salesItems/extension
GET SalesItems (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 SalesItemResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/salesCore/salesItems/extension?page={page}&pageSize={pageSize}
GET /salesCore/salesItems/extension?page={page}&pageSize={pageSize}
GET SalesItem 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 SalesItemResource. |
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}/salesCore/salesItems/{id}/extension
GET /salesCore/salesItems/{id}/extension
GET SalesItem 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 SalesItemResource. |
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}/salesCore/salesItems/{itemKey}/extension
GET /salesCore/salesItems/{itemKey}/extension
GET SalesItems (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 BaseSalesItemResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/salesCore/salesItems
GET /salesCore/salesItems
GET SalesItems (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 BaseSalesItemResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/salesCore/salesItems?page={page}&pageSize={pageSize}
GET /salesCore/salesItems?page={page}&pageSize={pageSize}
GET SalesItem (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 BaseSalesItemResource. |
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}/salesCore/salesItems/{id}
GET /salesCore/salesItems/{id}
GET SalesItem (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 BaseSalesItemResource. |
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}/salesCore/salesItems/{itemKey}
GET /salesCore/salesItems/{itemKey}
POST SalesItems
Creates a new entity record.
The following elements are required:
| salesItemResource | (ApiSalesItemResource) The request body should contain the entity record that should be created. See ApiSalesItemResource. |
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 ApiSalesItemResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/salesCore/salesItems/extension
POST /salesCore/salesItems/extension
POST SalesItems (with ApiBaseSalesItem)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| salesItemResource | (ApiSalesItemResource) The request body should contain the entity record that should be created. See ApiSalesItemResource. |
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 ApiBaseSalesItemResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/salesCore/salesItems
POST /salesCore/salesItems
POST Sales Item
Inserts a new 'Price List Line' in the 'Sales Item'.
The following elements are required:
| itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
| value | (ApiSalesItemPriceListLinesResource) The ApiSalesItemPriceListLinesResource instance. See ApiSalesItemPriceListLinesResource. |
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}/salesCore/salesItems/{itemKey}/priceListLines
POST /salesCore/salesItems/{itemKey}/priceListLines
POST Sales Item
Inserts a new 'Sales Channel Line' in the 'Sales Item'.
The following elements are required:
| itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
| value | (ApiSalesItemSalesChannelLinesResource) The ApiSalesItemSalesChannelLinesResource instance. See ApiSalesItemSalesChannelLinesResource. |
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}/salesCore/salesItems/{itemKey}/salesChannelLines
POST /salesCore/salesItems/{itemKey}/salesChannelLines
POST Get Items Catalog
Custom operation 'GetItemsCatalog'.
The following elements are required:
| itemsCatalogParameters | (ItemsCatalogParameters) ItemsCatalogParameters. |
Response:
| When successful, the response body contains a list of resources of type 'CatalogsItem'. See CatalogsItem. |
Resource URL:
api/{tenantKey}/{orgKey}/salesCore/salesItems/getItemsCatalog
POST /salesCore/salesItems/getItemsCatalog
PUT Set Currency PriceListLine
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}/salesCore/salesItems/{itemKey}/priceListLines/{lineId}/currency
PUT /salesCore/salesItems/{itemKey}/priceListLines/{lineId}/currency
PUT Set IncomeAccount SalesItem
Updates the value of attribute 'IncomeAccount' 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}/salesCore/salesItems/{itemKey}/incomeAccount
PUT /salesCore/salesItems/{itemKey}/incomeAccount
PUT Set IsActive SalesItem
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}/salesCore/salesItems/{itemKey}/isActive
PUT /salesCore/salesItems/{itemKey}/isActive
PUT Set ItemTaxSchema SalesItem
Updates the value of attribute 'ItemTaxSchema' 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}/salesCore/salesItems/{itemKey}/itemTaxSchema
PUT /salesCore/salesItems/{itemKey}/itemTaxSchema
PUT Set ItemWithholdingTaxSchema SalesItem
Updates the value of attribute 'ItemWithholdingTaxSchema' 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}/salesCore/salesItems/{itemKey}/itemWithholdingTaxSchema
PUT /salesCore/salesItems/{itemKey}/itemWithholdingTaxSchema
PUT Set Locked SalesItem
Updates the value of attribute 'Locked' 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. |
Resource URL:
api/{tenantKey}/{orgKey}/salesCore/salesItems/{itemKey}/locked
PUT /salesCore/salesItems/{itemKey}/locked
PUT Set PriceAmount PriceListLine
Updates the value of attribute 'PriceAmount' 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}/salesCore/salesItems/{itemKey}/priceListLines/{lineId}/priceAmount
PUT /salesCore/salesItems/{itemKey}/priceListLines/{lineId}/priceAmount
PUT Set PriceList PriceListLine
Updates the value of attribute 'PriceList' 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}/salesCore/salesItems/{itemKey}/priceListLines/{lineId}/priceList
PUT /salesCore/salesItems/{itemKey}/priceListLines/{lineId}/priceList
PUT Set Selected SalesChannelLine
Updates the value of attribute 'Selected' 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}/salesCore/salesItems/{itemKey}/salesChannelLines/{lineId}/selected
PUT /salesCore/salesItems/{itemKey}/salesChannelLines/{lineId}/selected
PUT Set Unit PriceListLine
Updates the value of attribute 'Unit' 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}/salesCore/salesItems/{itemKey}/priceListLines/{lineId}/unit
PUT /salesCore/salesItems/{itemKey}/priceListLines/{lineId}/unit
PUT Set Unit SalesItem
Updates the value of attribute 'Unit' 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}/salesCore/salesItems/{itemKey}/unit
PUT /salesCore/salesItems/{itemKey}/unit
DELETE Price List Line 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}/salesCore/salesItems/{itemKey}/priceListLines/{lineId}
DELETE /salesCore/salesItems/{itemKey}/priceListLines/{lineId}
DELETE Sales Channel Line 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}/salesCore/salesItems/{itemKey}/salesChannelLines/{lineId}
DELETE /salesCore/salesItems/{itemKey}/salesChannelLines/{lineId}
DELETE SalesItem 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}/salesCore/salesItems/{id}
DELETE /salesCore/salesItems/{id}
DELETE SalesItem 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}/salesCore/salesItems/{itemKey}
DELETE /salesCore/salesItems/{itemKey}
Resources
ApiBaseSalesItemPriceListLinesResource
The following elements are required:
| priceAmount | (decimal) The price. |
| unit | (string) The pricelist's line unit. |
| currency | (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. |
The following elements are optional:
| priceList | (string) The pricelist that corresponds to this price list line. |
| taxIncluded | (bool) Tax Included. |
ApiBaseSalesItemResource
The following elements are required:
| unit | (string) The unit of measure for the sales item. |
| itemTaxSchema | (string) The sales item's tax schema. The tax schema identifies the group of taxes a item is liable for. |
| incomeAccount | (string) The defined income account. |
| locked | (bool) Locked. |
| 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:
| itemWithholdingTaxSchema | (string) The sales item's withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. |
| priceListLines | (List of ApiBaseSalesItemPriceListLinesResource) The corresponding price list lines.
See ApiBaseSalesItemPriceListLinesResource. |
| salesChannelLines | (List of ApiBaseSalesItemSalesChannelLinesResource) Sales Channel Lines.
See ApiBaseSalesItemSalesChannelLinesResource. |
| 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. |
ApiBaseSalesItemSalesChannelLinesResource
The following elements are required:
| salesChannel | (string) The sales channel. |
The following elements are optional:
| selected | (bool) Selected. |
ApiSalesItemPriceListLinesResource
The following elements are required:
| priceAmount | (decimal) The price. |
| unit | (string) The pricelist's line unit. |
| currency | (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. |
The following elements are optional:
| priceList | (string) The pricelist that corresponds to this price list line. |
| taxIncluded | (bool) Tax Included. |
ApiSalesItemResource
The following elements are required:
| unit | (string) The unit of measure for the sales item. |
| itemTaxSchema | (string) The sales item's tax schema. The tax schema identifies the group of taxes a item is liable for. |
| incomeAccount | (string) The defined income account. |
| locked | (bool) Locked. |
| itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
The following elements are optional:
| itemWithholdingTaxSchema | (string) The sales item's withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. |
| priceListLines | (List of ApiSalesItemPriceListLinesResource) The corresponding price list lines.
See ApiSalesItemPriceListLinesResource. |
| salesChannelLines | (List of ApiSalesItemSalesChannelLinesResource) Sales Channel Lines.
See ApiSalesItemSalesChannelLinesResource. |
ApiSalesItemSalesChannelLinesResource
The following elements are required:
| salesChannel | (string) The sales channel. |
The following elements are optional:
| selected | (bool) Selected. |
BaseSalesItemPriceListLinesResource
The following elements are required:
| priceAmount | (decimal) The price. |
| unit | (string) The pricelist's line unit. |
| currency | (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. |
The following elements are optional:
| priceList | (string) The pricelist that corresponds to this price list line. |
| taxIncluded | (bool) Tax Included. |
BaseSalesItemResource
The following elements are required:
| unit | (string) The unit of measure for the sales item. |
| itemTaxSchema | (string) The sales item's tax schema. The tax schema identifies the group of taxes a item is liable for. |
| incomeAccount | (string) The defined income account. |
| locked | (bool) Locked. |
| 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:
| itemWithholdingTaxSchema | (string) The sales item's withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. |
| priceListLines | (List of BaseSalesItemPriceListLinesResource) The corresponding price list lines.
See BaseSalesItemPriceListLinesResource. |
| salesChannelLines | (List of BaseSalesItemSalesChannelLinesResource) Sales Channel Lines.
See BaseSalesItemSalesChannelLinesResource. |
| 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. |
BaseSalesItemSalesChannelLinesResource
The following elements are required:
| salesChannel | (string) The sales channel. |
The following elements are optional:
| selected | (bool) Selected. |
CatalogsItem
The following elements are optional:
| item | (string) Item. |
| itemDescription | (string) Item Description. |
| itemId | (string) Item Id. |
| barCode | (string) Bar Code. |
| assortment | (string) Assortment. |
| assortmentId | (string) Assortment Id. |
| assortmentDescription | (string) Assortment Description. |
| brand | (string) Brand. |
| brandId | (string) Brand Id. |
| brandDescription | (string) Brand Description. |
| brandModel | (string) Brand Model. |
| brandModelId | (string) Brand Model Id. |
| brandModelDescription | (string) Brand Model Description. |
| unit | (string) Unit. |
| unitId | (string) Unit Id. |
| unitDescription | (string) Unit Description. |
| comparativePrice | (decimal) Comparative Price. |
| currentPrice | (decimal) Current Price. |
| stock | (decimal) Stock. |
| currentPriceCurrency | (string) Current Price Currency. |
| currentPriceCurrencyDescription | (string) Current Price Currency Description. |
| currentPriceCurrencyId | (string) Current Price Currency Id. |
| comparativePriceCurrency | (string) Comparative Price Currency. |
| comparativePriceCurrencyDescription | (string) Comparative Price Currency Description. |
| comparativePriceCurrencyId | (string) Comparative Price Currency Id. |
| image | (string) Image. |
| imageThumbnail | (string) Image Thumbnail. |
| taxRate | (decimal) Tax Rate. |
| complementaryDescription | (string) Complementary Description. |
PriceListLineResource
The following elements are required:
| priceAmount | (decimal) The price. |
| unit | (string) The pricelist's line unit. |
| currency | (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. |
The following elements are optional:
| priceList | (string) The pricelist that corresponds to this price list line. |
| taxIncluded | (bool) Tax Included. |
SalesChannelLineResource
The following elements are required:
| salesChannel | (string) The sales channel. |
The following elements are optional:
| selected | (bool) Selected. |
SalesItemResource
The following elements are required:
| unit | (string) The unit of measure for the sales item.
(fk) Allowed value: the natural key of a record of type Unit. These records are accessibly through the Units service. |
| itemTaxSchema | (string) The sales item's tax schema. The tax schema identifies the group of taxes a item is liable for.
(fk) Allowed value: the natural key of a record of type ItemTaxSchema. These records are accessibly through the ItemTaxSchemas service. |
| incomeAccount | (string) The defined income account.
(fk) Allowed value: the natural key of a record of type Account. These records are accessibly through the Accounts service. |
| locked | (bool) Locked. |
| itemKey | (string) The key for the item. Uniquely identifies the item within the organization. |
The following elements are optional:
| itemWithholdingTaxSchema | (string) The sales item's withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for.
(fk) Allowed value: the natural key of a record of type ItemWithholdingTaxSchema. These records are accessibly through the ItemWithholdingTaxSchemas service. |
| priceListLines | (List of PriceListLineResource) The corresponding price list lines.
See PriceListLineResource. |
| salesChannelLines | (List of SalesChannelLineResource) Sales Channel Lines.
See SalesChannelLineResource. |