PackagingTypeByBoxId: Visma.net Financials Packaging Type by Box ID |
Get a specific PackagingType
Catalog: VismaNet
Schema: PackagingType
Label: Packaging Type by Box ID
The data in this table is partitioned per value of the COMPANY_CODE column.
This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive SQL driver for Visma.net Financials does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net Financials API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function PackagingTypeByBoxId. 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 evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `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 |
---|---|---|---|---|
boxId |
string |
☑ |
|
Identifies the PackagingType |
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
erp-api-background |
string |
☐ |
|
If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation. |
Columns of Table Function
The columns of the table function PackagingTypeByBoxId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
activeByDefault |
boolean |
Active by Default |
☐ |
The table > Active by default > If you select this check box, the package will be added by default to the list of packages for each new ship via code. |
boxId |
string |
Box ID |
☐ |
Mandatory field: The table > Box ID* > The ID of the type of box. |
boxWeight |
double |
Box Weight |
☐ |
The table > Tare weight > The weight of an empty box of this type, which may include the weight of any packaging material used to pack items inside the box. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
description |
string |
Description |
☐ |
The table > Description > A description of the box. |
height |
int32 |
Height |
☐ |
The table > Height > The height of the package. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
The table > The date and time when the type was last modified. |
length |
int32 |
Length |
☐ |
The table > Length > The length of the package. |
maxVolume |
double |
|
☐ |
The table > Max. volume > The maximum volume of items that can fit into a package of the type. |
maxWeight |
double |
Maximum Weight |
☐ |
The table > Max weight > The maximum weight a box of the type can hold. |
volumeUoM |
string |
Volume UOM |
☐ |
The table > Volume UoM > The unit of measure used for the volume as specified in the Inventory preferences (IN101000) window. |
weightUoM |
string |
Weight UOM |
☐ |
The table > Weight UoM > The unit of measure used for the weight. |
width |
int32 |
Width |
☐ |
The table > Width > The width of the package. |
22-12-2022 21:03 Version 22.1.101-BETA+3681