|
SalesCategoryItemsForCategoryBycategoryId_InventoryUnitsItemClassAttributes |
Contents Previous Home Next More |
Get a range of Inventory Items from a specific Sales Category
Catalog: VismaNet
Schema: SalesCategory
The data in this table is partitioned per value of the COMPANY_CODE column.
This is a read-only table function. The Visma.net API may not support changing the data or the Invantive SQL driver for Visma.net does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net API.
Select Visma.net API URL: /controller/api/v1/salescategory/{categoryId}/item
Insert Visma.net API URL: /controller/api/v1/salescategory/{categoryId}/item
Update Visma.net API URL: /controller/api/v1/salescategory/{categoryId}/item
Delete Visma.net API URL: /controller/api/v1/salescategory/{categoryId}/item
Field Selection Method: NotRequired
Base Path: inventoryUnits[*].itemClass.attributes[*]
Select Visma.net API Operation: get /controller/api/v1/salescategory/{categoryId}/item
Table Function Parameters
The following parameters can be used to control the behaviour of the table function SalesCategoryItemsForCategoryBycategoryId_InventoryUnitsItemClassAttributes. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
categoryId |
int32 |
☑ |
|
Identifies the Sales Category |
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
Table Function Columns
The columns of the table function SalesCategoryItemsForCategoryBycategoryId_InventoryUnitsItemClassAttributes are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
attributeId |
string |
Attribute ID |
☐ |
The Attributes tab > Attribute ID > The identifier of the attribute. |
attributeType |
string |
|
☐ |
|
baseUnit |
string |
Base Unit |
☐ |
Mandatory field: General information tab > Unit of measurement section > Base unit* > The UoM used as the base unit for this stock item. |
body |
string |
|
☐ |
The top part > Body *> A brief description of the stock item. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
currentCost |
double |
|
☐ |
Price/cost information tab > Standard cost section > Current cost > Read-only. This field displays the current standard cost for the stock item. |
defaultPrice |
double |
Default Price |
☐ |
Price/cost information tab > Price management section > Default price > The price of the stock item. |
defaultValue |
string |
|
☐ |
The Attributes tab > Default value > The default value of the attribute. |
description |
string |
Description |
☐ |
The Attributes tab > Description > A read-only column that displays the detailed description of the attribute. |
description_1 |
string |
|
☐ |
Click on the magnifier. > The description. |
description_2 |
string |
|
☐ |
The top part > Description *> A brief description of the stock item. |
effectiveDate |
datetime |
Effective Date |
☐ |
Price/cost information tab > Standard cost section > Effective date > Read-only. This field shows the effective date for the current standard cost of the stock item. |
errorInfo |
string |
Error Message |
☐ |
|
fromUnit |
string |
|
☐ |
Mandatory field: From unit > The unit of measure for which the conversion parameters are specified. |
id |
string |
ID |
☐ |
Click on the magnifier. > The identifier. |
inventoryID |
int32 |
Inventory ID |
☐ |
The top part > Item ID > The unique alphanumeric identifier of the stock item. |
inventoryId_1 |
int32 |
|
☐ |
The unique internal identifier of the item as is stored in the database. This Id is not visible in the window. |
inventoryNumber |
string |
Inventory Number |
☐ |
Mandatory field: The top part > Item Id* > The unique alphanumeric identifier of the stock item. |
lastCost |
double |
Last Cost |
☐ |
Price/cost information tab > Standard cost section > Last cost > Read-only. This field showing the last standard cost defined for the stock item. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
Information collected from system. |
pendingCost |
double |
Pending Cost |
☐ |
Price/cost information tab > Standard cost section > Pending cost > The pending standard cost for the stock item. |
pendingCostDate |
datetime |
Pending Cost Date |
☐ |
Price/cost information tab > Standard cost section > Pending cost date > The date when the pending standard cost becomes effective. |
priceAdjustmentMultiplier |
double |
|
☐ |
Price adjustment multiplier > Changes the price automatically if you change the UoM. |
priceClassID |
string |
|
☐ |
The Price/cost information tab > Price management section > Price class > The price class of the item. |
priceManagerID |
string |
|
☐ |
The Price/cost information tab > Price management section > Price manager > The ID of the manager responsible for the product pricing. |
priceWorkgroupID |
int32 |
|
☐ |
The Price/cost information tab > Price management section > Price work group > The work group responsible for product pricing. Select the pricing work group for the stock item. |
purchaseUnit |
string |
|
☐ |
Mandatory field: General information tab > Unit of measurement section > Purchase unit *> The UoM to be used as the purchase unit for the stock item. |
recommendedPrice |
double |
|
☐ |
The Price/cost information tab > Price management section > List price > The manufacturer's suggested retail price (MSRP) of the stock item. |
recordID |
int64 |
Record ID |
☐ |
|
required |
boolean |
Required |
☐ |
The Attributes tab > Required > This check box indicates (if selected) that the attribute value is required for items of the class. |
salesUnit |
string |
Sales Unit |
☐ |
Mandatory field: General information tab > Unit of measurement section > Sales unit *> The UoM to be used as the sales unit for the stock item. |
sampleToUnit |
string |
|
☐ |
|
sortOrder |
int32 |
|
☐ |
The Attributes tab > Sort order > A number that represents the order of the attribute in the list of class attributes.The lower the number, the higher the attribute will be in the list of class attributes. |
status |
string |
Status |
☐ |
The top part > Item status > The status of the stock item. The alternatives are: Active, No sales, No purchases, No request, Inactive, Marked for deletion. |
stockItem |
boolean |
Stock Item |
☐ |
|
toUnit |
string |
|
☐ |
To unit > The unit of measure selected as the base unit for the item. |
type |
string |
Type |
☐ |
|
type_1 |
string |
|
☐ |
General information tab > Item defaults section > Type > The type of stock item. |
unitMultDiv |
string |
|
☐ |
Multiply/divide > The operation to be performed for unit conversion. |
unitRate |
double |
|
☐ |
|
unitType |
int32 |
|
☐ |
|
12-12-2020 18:42 Version 20.1.301-BETA+3023
