ShipmentDetailLines: Visma.net Financials Shipment Detail Lines |
Get a range of SO Shipments - ScreenId=SO302000Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page size
Catalog: VismaNet
Schema: Shipment
Label: Shipment Detail Lines
This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL 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 ShipmentDetailLines. 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 |
|---|---|---|---|---|
customerId |
int32 |
☐ |
|
|
customerNumber |
string |
☐ |
|
|
greaterThanValue |
string |
☐ |
|
This field has been deprecated and will be removed in future versions. The GreaterThanValue parameter has no effect on the result. |
includeCustomFreeFields |
boolean |
☐ |
|
Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set |
lastModifiedDateTime |
string |
☐ |
|
This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.Accepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd HH:mm:ss```* ```yyyy-MM-dd HH:mm:ss.FFF```* ```yyyy-MM-ddTHH:mm:ss```* ```yyyy-MM-ddTHH:mm:ss.FFF```_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__. |
lastModifiedDateTimeCondition |
string |
☐ |
|
This value represents the condition to be applied when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__. |
orderBy |
string |
☐ |
|
This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result. |
shipmentDate |
string |
☐ |
|
Shipment DateAccepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd HH:mm:ss```* ```yyyy-MM-dd HH:mm:ss.FFF```* ```yyyy-MM-ddTHH:mm:ss```* ```yyyy-MM-ddTHH:mm:ss.FFF```_Note:_ __ShipmentDate__ and __ShipmentDate__ are __mutually inclusive__. |
shipmentDateCondition |
string |
☐ |
|
This value represents the condition to be applied when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __ShipmentDate__ and __ShipmentDateCondition__ are __mutually inclusive__. |
shipmentType |
string |
☐ |
|
Filter by Shipment Type (Values: Issue, DropShip, Transfer) |
status |
string |
☐ |
|
Values: Open, Hold, Completed, Cancelled, Confirmed, Invoiced, Receipted, AutoGenerated, PartiallyInvoiced. |
Columns of Table Function
The columns of the table function ShipmentDetailLines are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
alternateID |
string |
Alternate ID |
☐ |
|
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
container |
boolean |
{res:itgen_vnet_container} |
☐ |
Delivery settings tab > Intrastat section > Container > This check box indicates (if selected) that the shipment gets marked as shipped in container for Intrastat reporting purposes. |
controlQuantity |
double |
Control Quantity |
☐ |
The top part > Control quantity > The control value, which you manually enter as a value equal to the shipped quantity if the Validate shipment total on confirmation check box has been selected in the Sales orders preferences (SO101000) window. |
currencyId |
string |
Currency ID |
☐ |
Delivery settings tab > Freight currency > By default, it is the currency of the sales order, but you can change it if needed. |
customDateTimeUTC1_2 |
datetime |
{res:itgen_vnet_customdatetimeutc1_2} |
☐ |
A free custom colum of type DateTime - in UTC timezone |
customDateTimeUTC1 |
datetime |
{res:itgen_vnet_customdatetimeutc1} |
☐ |
A free custom colum of type DateTime - in UTC timezone |
customDec1_2 |
double |
{res:itgen_vnet_customdec1_2} |
☐ |
A free custom colum of type decimal with max 4 decimals. |
customDec1 |
double |
{res:itgen_vnet_customdec1} |
☐ |
A free custom colum of type decimal with max 4 decimals. |
customDec2_2 |
double |
{res:itgen_vnet_customdec2_2} |
☐ |
A free custom colum of type decimal with max 4 decimals. |
customDec2 |
double |
{res:itgen_vnet_customdec2} |
☐ |
A free custom colum of type decimal with max 4 decimals. |
customer_internalId |
int32 |
Customer Internal ID |
☐ |
|
customer_name |
string |
Customer Name |
☐ |
The name of the particular destination of the selected type. |
customer_number |
string |
Customer Number |
☐ |
The identifier of the particular destination of the selected type. |
customInt1_2 |
int32 |
{res:itgen_vnet_customint1_2} |
☐ |
A free custom colum of type int |
customInt1 |
int32 |
{res:itgen_vnet_customint1} |
☐ |
A free custom colum of type int |
customInt2_2 |
int32 |
{res:itgen_vnet_customint2_2} |
☐ |
A free custom colum of type int |
customInt2 |
int32 |
{res:itgen_vnet_customint2} |
☐ |
A free custom colum of type int |
customStr1_2 |
string |
{res:itgen_vnet_customstr1_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr1 |
string |
{res:itgen_vnet_customstr1} |
☐ |
A free custom colum of type string with max length 100. |
customStr2_2 |
string |
{res:itgen_vnet_customstr2_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr2 |
string |
{res:itgen_vnet_customstr2} |
☐ |
A free custom colum of type string with max length 100. |
customStr3_2 |
string |
{res:itgen_vnet_customstr3_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr3 |
string |
{res:itgen_vnet_customstr3} |
☐ |
A free custom colum of type string with max length 100. |
customStr4_2 |
string |
{res:itgen_vnet_customstr4_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr4 |
string |
{res:itgen_vnet_customstr4} |
☐ |
A free custom colum of type string with max length 100. |
customStr5_2 |
string |
{res:itgen_vnet_customstr5_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr5 |
string |
{res:itgen_vnet_customstr5} |
☐ |
A free custom colum of type string with max length 100. |
deliveryAddress_addressId |
int32 |
Delivery Address ID |
☐ |
|
deliveryAddress_addressLine1 |
string |
Delivery Address Line 1 |
☐ |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. |
deliveryAddress_addressLine2 |
string |
Delivery Address Line 2 |
☐ |
Address 2 > The second line of the address. |
deliveryAddress_addressLine3 |
string |
Delivery Address Line 3 |
☐ |
Address 3 > The third line of the address. |
deliveryAddress_city |
string |
Delivery Address City |
☐ |
City > The city. |
deliveryAddress_country_errorInfo |
string |
{res:itgen_vnet_deliveryaddress_country_errorinfo} |
☐ |
|
deliveryAddress_country_id |
string |
Delivery Address Country ID |
☐ |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. |
deliveryAddress_country_metadata_maxPageSize |
int64 |
{res:itgen_vnet_deliveryaddress_country_metadata_maxpagesize} |
☐ |
|
deliveryAddress_country_metadata_totalCount |
int64 |
{res:itgen_vnet_deliveryaddress_country_metadata_totalcount} |
☐ |
|
deliveryAddress_country_name |
string |
Delivery Address Country Name |
☐ |
Mandatory field: Country name* > The complete name of the country. |
deliveryAddress_county_id |
string |
Delivery Address County ID |
☐ |
Click the magnifier > The identifier |
deliveryAddress_county_name |
string |
Delivery Address County Name |
☐ |
Click the magnifier > The displayed name |
deliveryAddress_overrideAddress |
boolean |
{res:itgen_vnet_deliveryaddress_overrideaddress} |
☐ |
Override address > A check box that you select to not include the default address information and to type new address information. |
deliveryAddress_postalCode |
string |
Delivery Address Postal Code |
☐ |
Postcode > The postcode. |
deliveryContact_attention |
string |
Delivery Contact Attention |
☐ |
Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person. |
deliveryContact_contactId |
int32 |
Delivery Contact ID |
☐ |
|
deliveryContact_email |
string |
Delivery Contact Email Address |
☐ |
Email > The email address of the customer/supplier/company as a business entity. |
deliveryContact_fax |
string |
Delivery Contact Fax |
☐ |
Fax > The fax number. |
deliveryContact_name |
string |
Delivery Contact Name |
☐ |
Name > The legal name of to appear on the documents. |
deliveryContact_overrideContact |
boolean |
{res:itgen_vnet_deliverycontact_overridecontact} |
☐ |
Override contact > A check box that you select to not use+ the default contact information and to type new contact information. |
deliveryContact_phone1 |
string |
Delivery Contact Phone 1 |
☐ |
Phone 1 > The default phone number. |
deliveryContact_phone2 |
string |
Delivery Contact Phone 2 |
☐ |
Phone 2 > An additional phone number. |
deliveryContact_web |
string |
Delivery Contact Website |
☐ |
Web > The website of the company, if one exists. |
description |
string |
Description |
☐ |
Document details tab > Description > A short description for the shipment. |
errorInfo |
string |
Error Message |
☐ |
|
expirationDate |
datetime |
Expiration Date |
☐ |
Document details tab > Expiration date > The expiration date of the item, if it is traced for this item ID. |
externalLink |
string |
{res:itgen_vnet_externallink} |
☐ |
|
fobPoint_description |
string |
FOB Point Description |
☐ |
Click on the magnifier. > The description. |
fobPoint_id |
string |
FOB Point ID |
☐ |
Click on the magnifier. > The identifier. |
freeItem |
boolean |
Free Item |
☐ |
Document details tab > Free item > The free item earned by the customer, if applicable. (This column does not appear for transfer.) |
freightAmt |
double |
{res:itgen_vnet_freightamt} |
☐ |
Delivery settings tab > Shipping information section > Freight amt. > The amount of freight the customer will be charged for the shipment. |
freightCost |
double |
{res:itgen_vnet_freightcost} |
☐ |
Delivery settings tab > Shipping information section > Freight cost > The freight cost of the shipment. |
fromWarehouse_description |
string |
{res:itgen_vnet_fromwarehouse_description} |
☐ |
Click on the magnifier. > The description. |
fromWarehouse_id |
string |
{res:itgen_vnet_fromwarehouse_id} |
☐ |
Click on the magnifier. > The identifier. |
hold |
boolean |
Hold |
☐ |
The top part > Hold > This check box indicates (if selected) that the documents cannot be processed further until the check box is cleared. |
insurance |
boolean |
Insurance |
☐ |
Delivery settings tab > Shipping information section > Insurance > This check box indicates (if selected) that insurance is required for the shipment. |
inventoryNumber |
string |
Inventory Number |
☐ |
Document details tab > Item ID > The ID of the item being shipped. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information. |
lineNumber |
int32 |
Line Number |
☐ |
Document details tab > The line number indicating sequence. |
location_countryId_2 |
string |
Location Country ID 2 |
☐ |
Location*. |
location_countryId |
string |
Location Country ID |
☐ |
Location*. |
location_id_2 |
string |
Location ID 2 |
☐ |
Click the magnifier > The identifier |
location_id |
string |
Location ID |
☐ |
Click the magnifier > The identifier |
location_name_2 |
string |
Location Name 2 |
☐ |
Click the magnifier > The displayed name |
location_name |
string |
Location Name |
☐ |
Click the magnifier > The displayed name |
lotSerialNbr |
string |
{res:itgen_vnet_lotserialnbr} |
☐ |
Document details tab > Lot/serial no. > The lot or serial number of particular items of the item. |
metadata_maxPageSize |
int64 |
Metadata Max Pagesize |
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
modeOfTrasport_description |
string |
{res:itgen_vnet_modeoftrasport_description} |
☐ |
Click on the magnifier. > The description. |
modeOfTrasport_id |
int32 |
{res:itgen_vnet_modeoftrasport_id} |
☐ |
Click on the magnifier. > The identifier. |
note_2 |
string |
Note 2 |
☐ |
|
note |
string |
Note |
☐ |
|
openQty |
double |
Open Quantity |
☐ |
Document details tab > Open qty. > The number of items with the specified quantities still to be shipped. |
operation |
string |
Operation |
☐ |
The top part > Operation > The operation to be performed in the Inventory workspace for this shipment: Issue or Receipt. |
orderedQty |
double |
{res:itgen_vnet_orderedqty} |
☐ |
Document details tab > Ordered qty. > The quantity of the item ordered with the specified properties. |
orderLineNbr |
int32 |
{res:itgen_vnet_orderlinenbr} |
☐ |
Document details tab > Order line no. > Read only. The order's line number that matches this shipment line. |
orderNbr |
string |
Order Number |
☐ |
Document details tab > Order no. > The reference number of the document. |
orderType |
string |
Order Type |
☐ |
Document details tab > The type of the document, which is one of the predefined order types or a custom order type. |
owner_id |
guid |
Owner ID |
☐ |
Click the magnifier > The identifier |
owner_name |
string |
Owner Name |
☐ |
Click the magnifier > The displayed name |
packages |
int32 |
Packages |
☐ |
The top part > Packages > The number of boxes included in this shipment. |
packagesVolume |
double |
{res:itgen_vnet_packagesvolume} |
☐ |
The top part > Package volume > The total volume of the shipment that includes the volume of boxes (for boxes determined automatically). |
packagesWeight |
double |
Packages Weight |
☐ |
The top part > Package weight > The total weight of the shipment that includes the weight of boxes (for boxes determined automatically). |
reasonCode |
string |
Reason Code |
☐ |
Document details tab > Reason code > The reason code used for shipments. |
residentialDelivery |
boolean |
Residential Delivery |
☐ |
Delivery settings tab > Shipping information section > Residential delivery > This check box indicates (if selected) that the shipping address is a residential one. |
saturdayDelivery |
boolean |
Saturday Delivery |
☐ |
Delivery settings tab > Shipping information section > Saturday delivery > This check box indicates delivery on saturday. |
shipmentDate |
datetime |
Shipment Date |
☐ |
Mandatory field: The top part > Shipment date* > The date when the document has been created. |
shipmentNumber |
string |
Shipment Number |
☐ |
The top part > Shipment no > The unique reference number of the document, which is automatically generated by the system. |
shipmentType |
string |
Shipment Type |
☐ |
The top part > Type > The type of the shipment document, which can be one of the following options: Shipment, Transfer. |
shippedQty |
double |
Shipped Quantity |
☐ |
Document details tab > Shipped qty. > The quantity of the item shipped with the specified properties. |
shippedQuantity |
double |
{res:itgen_vnet_shippedquantity} |
☐ |
The top part > Shipped quantity > The quantity of goods shipped. |
shippedVolume |
double |
Shipped Volume |
☐ |
The top part > Shipped volume > The total volume of the items in the shipment. |
shippedWeight |
double |
Shipped Weight |
☐ |
The top part > Shipped weight > The weight of the goods shipped. |
shippingTerms_description |
string |
Shipping Terms Description |
☐ |
Click on the magnifier. > The description. |
shippingTerms_id |
string |
Shipping Terms ID |
☐ |
Click on the magnifier. > The identifier. |
shippingZone_description |
string |
Shipping Zone Description |
☐ |
Click on the magnifier. > The description. |
shippingZone_id |
string |
Shipping Zone ID |
☐ |
Click on the magnifier. > The identifier. |
shipVia_description |
string |
Ship via Description |
☐ |
Click on the magnifier. > The description. |
shipVia_id |
string |
Ship via ID |
☐ |
Click on the magnifier. > The identifier. |
status |
string |
Status |
☐ |
The top part > Status > The status of the document. |
timeStamp |
byte[] |
Timestamp |
☐ |
|
toWarehouse_description |
string |
To Warehouse Description |
☐ |
Click on the magnifier. > The description. |
toWarehouse_id |
string |
To Warehouse ID |
☐ |
Click on the magnifier. > The identifier. |
transactionType_description |
string |
Transaction Type Description |
☐ |
Click on the magnifier. > The description. |
transactionType_id |
int32 |
Transaction Type ID |
☐ |
Click on the magnifier. > The identifier. |
uom |
string |
Unit of Measure |
☐ |
Document details tab > UoM > The unit of measure used for the item in shipment. |
useCustomerAccount |
boolean |
{res:itgen_vnet_usecustomeraccount} |
☐ |
|
warehouse_description |
string |
Warehouse Description |
☐ |
Click on the magnifier. > The description. |
warehouse_id |
string |
Warehouse ID |
☐ |
Click on the magnifier. > The identifier. |
23-06-2025 19:16 Version 24.1.116-BETA+5455
Visma.net Financials API Data Model