ShipmentOrderLines: Visma.net Financials Shipment Order Lines
popular read only REST
- Catalog:
VismaNet - Schema:
Shipment - Label: Shipment Order Lines
Get a range of SO Shipments - ScreenId=SO302000 Request 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
Can only retrieve data.
API Source
- Endpoint:
/v1/shipment - Operation:
get /v1/shipment
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 353 |
| Full scan rows per minute | 23,100 |
| Point query rows per minute | 387 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
customer |
`` | |||
customer |
`` | |||
greater |
`` | This field has been deprecated and will be removed in future versions. The GreaterThanValue parameter has no effect on the result. | ||
include |
`` | Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set | ||
last |
`` | 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- * yyyy- * yyyy- * yyyy- * yyyy- Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive. |
||
last |
`` | 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. | ||
shipment |
`` | Shipment Date Accepted format: * yyyy- * yyyy- * yyyy- * yyyy- * yyyy- Note: ShipmentDate and ShipmentDate are mutually inclusive. |
||
shipment |
`` | 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. | ||
shipment |
`` | Filter by Shipment Type (Values: Issue, DropShip, Transfer) | ||
status |
`` | Values: Open, Hold, Completed, Cancelled, Confirmed, Invoiced, Receipted, AutoGenerated, PartiallyInvoiced. |
Table Columns
The columns of the table ShipmentOrderLines are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
COMPANY_ |
varchar2 |
Company Code | writable | Partition code, segmenting the data. | |
COMPANY_ |
varchar2 |
Company Name | writable | Name of the partition. | |
container |
char |
itgen_vnet_container | filters on the platform, writable, ::ancestor. |
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. | |
control |
double |
Control Quantity | filters on the platform, writable, ::ancestor. |
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. | |
currency |
varchar2 |
Currency ID | filters on the platform, writable, ::ancestor. |
Delivery settings tab > Freight currency > By default, it is the currency of the sales order, but you can change it if needed. | |
custom |
datetime |
itgen_vnet_customdatetimeutc1 | filters on the platform, writable, ::ancestor. |
A free custom colum of type DateTime - in UTC timezone | |
custom |
double |
itgen_vnet_customdec1 | filters on the platform, writable, ::ancestor. |
A free custom colum of type decimal with max 4 decimals. | |
custom |
double |
itgen_vnet_customdec2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type decimal with max 4 decimals. | |
custom |
int32 |
itgen_vnet_customint1 | filters on the platform, writable, ::ancestor. |
A free custom colum of type int | |
custom |
int32 |
itgen_vnet_customint2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type int | |
custom |
varchar2 |
itgen_vnet_customstr1 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customstr2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customstr3 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customstr4 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customstr5 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
customer_ |
int32 |
Customer Internal ID | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Name | filters on the platform, writable, ::ancestor. |
The name of the particular destination of the selected type. | |
customer_ |
varchar2 |
Customer Number | filters on the platform, writable, ::ancestor. |
The identifier of the particular destination of the selected type. | |
delivery |
int32 |
Delivery Address ID | filters on the platform, writable, ::ancestor. |
||
delivery |
varchar2 |
Delivery Address Line 1 | filters on the platform, writable, ::ancestor. |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. | |
delivery |
varchar2 |
Delivery Address Line 2 | filters on the platform, writable, ::ancestor. |
Address 2 > The second line of the address. | |
delivery |
varchar2 |
Delivery Address Line 3 | filters on the platform, writable, ::ancestor. |
Address 3 > The third line of the address. | |
delivery |
varchar2 |
Delivery Address City | filters on the platform, writable, ::ancestor. |
City > The city. | |
delivery |
varchar2 |
itgen_vnet_deliveryaddress_country_errorinfo | filters on the platform, writable, ::ancestor. |
||
delivery |
varchar2 |
Delivery Address Country ID | filters on the platform, writable, ::ancestor. |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. | |
delivery |
int64 |
itgen_vnet_deliveryaddress_country_metadata_maxpagesize | filters on the platform, writable, ::ancestor. |
||
delivery |
int64 |
itgen_vnet_deliveryaddress_country_metadata_totalcount | filters on the platform, writable, ::ancestor. |
||
delivery |
varchar2 |
Delivery Address Country Name | filters on the platform, writable, ::ancestor. |
Mandatory field: Country name* > The complete name of the country. | |
delivery |
varchar2 |
Delivery Address County ID | filters on the platform, writable, ::ancestor. |
Click the magnifier > The identifier | |
delivery |
varchar2 |
Delivery Address County Name | filters on the platform, writable, ::ancestor. |
Click the magnifier > The displayed name | |
delivery |
char |
itgen_vnet_deliveryaddress_overrideaddress | filters on the platform, writable, ::ancestor. |
Override address > A check box that you select to not include the default address information and to type new address information. | |
delivery |
varchar2 |
Delivery Address Postal Code | filters on the platform, writable, ::ancestor. |
Postcode > The postcode. | |
delivery |
varchar2 |
Delivery Contact Attention | filters on the platform, writable, ::ancestor. |
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. | |
delivery |
int32 |
Delivery Contact ID | filters on the platform, writable, ::ancestor. |
||
delivery |
varchar2 |
Delivery Contact Email Address | filters on the platform, writable, ::ancestor. |
Email > The email address of the customer/supplier/company as a business entity. | |
delivery |
varchar2 |
Delivery Contact Fax | filters on the platform, writable, ::ancestor. |
Fax > The fax number. | |
delivery |
varchar2 |
Delivery Contact Name | filters on the platform, writable, ::ancestor. |
Name > The legal name of to appear on the documents. | |
delivery |
char |
itgen_vnet_deliverycontact_overridecontact | filters on the platform, writable, ::ancestor. |
Override contact > A check box that you select to not use+ the default contact information and to type new contact information. | |
delivery |
varchar2 |
Delivery Contact Phone 1 | filters on the platform, writable, ::ancestor. |
Phone 1 > The default phone number. | |
delivery |
varchar2 |
Delivery Contact Phone 2 | filters on the platform, writable, ::ancestor. |
Phone 2 > An additional phone number. | |
delivery |
varchar2 |
Delivery Contact Website | filters on the platform, writable, ::ancestor. |
Web > The website of the company, if one exists. | |
error |
varchar2 |
Error Message | filters on the platform, writable, ::ancestor. |
||
fob |
varchar2 |
FOB Point Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
fob |
varchar2 |
FOB Point ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
freight |
double |
itgen_vnet_freightamt | filters on the platform, writable, ::ancestor. |
Delivery settings tab > Shipping information section > Freight amt. > The amount of freight the customer will be charged for the shipment in base currency. | |
freight |
double |
itgen_vnet_freightcost | filters on the platform, writable, ::ancestor. |
Delivery settings tab > Shipping information section > Freight cost > The freight cost of the shipment in base currency. | |
freight |
double |
itgen_vnet_freightcuramt | filters on the platform, writable, ::ancestor. |
Delivery settings tab > Shipping information section > Freight amt. > The amount of freight the customer will be charged for the shipment in freight currency. | |
freight |
double |
itgen_vnet_freightcurcost | filters on the platform, writable, ::ancestor. |
Delivery settings tab > Shipping information section > Freight cost > The freight cost of the shipment in freight currency. | |
from |
varchar2 |
itgen_vnet_fromwarehouse_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
from |
varchar2 |
itgen_vnet_fromwarehouse_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
hold |
char |
Hold | filters on the platform, writable, ::ancestor. |
The top part > Hold > This check box indicates (if selected) that the documents cannot be processed further until the check box is cleared. | |
insurance |
char |
Insurance | filters on the platform, writable, ::ancestor. |
Delivery settings tab > Shipping information section > Insurance > This check box indicates (if selected) that insurance is required for the shipment. | |
inventory |
varchar2 |
itgen_vnet_inventorydoctype | writable, inventory |
Orders tab > Inventory doc. type > The type of the inventory document that lists the items for this shipment. | |
inventory |
varchar2 |
itgen_vnet_inventoryrefnbr | writable, inventory |
Orders tab > Inventory ref. no. > The reference number of the inventory document that lists the items for this shipment. | |
invoice |
varchar2 |
Invoice Number | writable, invoice |
Orders tab > Invoice no. > The reference number of the invoice for the goods shipped. | |
invoice |
varchar2 |
itgen_vnet_invoicetype | writable, invoice |
Orders tab > Invoice type > The type of invoice for the goods shipped for the sales order. | |
last |
datetime |
Last Modified | filters on the platform, writable, ::ancestor. |
System generated information. | |
location_ |
varchar2 |
Location Country ID | filters on the platform, writable, ::ancestor. |
Location*. | |
location_ |
varchar2 |
Location ID | filters on the platform, writable, ::ancestor. |
Click the magnifier > The identifier | |
location_ |
varchar2 |
Location Name | filters on the platform, writable, ::ancestor. |
Click the magnifier > The displayed name | |
metadata_ |
int64 |
Metadata Max Pagesize | filters on the platform, writable, ::ancestor. |
||
metadata_ |
int64 |
Total Count | filters on the platform, writable, ::ancestor. |
||
mode |
varchar2 |
itgen_vnet_modeoftrasport_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
mode |
int32 |
itgen_vnet_modeoftrasport_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
note |
varchar2 |
Note | writable, note |
||
note_2 |
varchar2 |
Note 2 | filters on the platform, writable, ::ancestor. |
||
operation |
varchar2 |
Operation | filters on the platform, writable, ::ancestor. |
The top part > Operation > The operation to be performed in the Inventory workspace for this shipment: Issue or Receipt. | |
order |
varchar2 |
Order Number | writable, order |
Orders tab > Order no. > The reference number of the sales or transfer order. | |
order |
varchar2 |
Order Type | writable, order |
Orders tab > Order typer > The type of the order. | |
owner_ |
guid |
Owner ID | filters on the platform, writable, ::ancestor. |
Click the magnifier > The identifier | |
owner_ |
varchar2 |
Owner Name | filters on the platform, writable, ::ancestor. |
Click the magnifier > The displayed name | |
packages |
int32 |
Packages | filters on the platform, writable, ::ancestor. |
The top part > Packages > The number of boxes included in this shipment. | |
packages |
double |
itgen_vnet_packagesvolume | filters on the platform, writable, ::ancestor. |
The top part > Package volume > The total volume of the shipment that includes the volume of boxes (for boxes determined automatically). | |
packages |
double |
Packages Weight | filters on the platform, writable, ::ancestor. |
The top part > Package weight > The total weight of the shipment that includes the weight of boxes (for boxes determined automatically). | |
residential |
char |
Residential Delivery | filters on the platform, writable, ::ancestor. |
Delivery settings tab > Shipping information section > Residential delivery > This check box indicates (if selected) that the shipping address is a residential one. | |
saturday |
char |
Saturday Delivery | filters on the platform, writable, ::ancestor. |
Delivery settings tab > Shipping information section > Saturday delivery > This check box indicates delivery on saturday. | |
ship |
varchar2 |
Ship via Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
ship |
varchar2 |
Ship via ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
shipment |
datetime |
Shipment Date | filters on the platform, writable, ::ancestor. |
Mandatory field: The top part > Shipment date* > The date when the document has been created. | |
shipment |
varchar2 |
Shipment Number | filters on the platform, writable, ::ancestor. |
The top part > Shipment no > The unique reference number of the document, which is automatically generated by the system. | |
shipment |
varchar2 |
Shipment Type | filters on the platform, writable, ::ancestor. |
The top part > Type > The type of the shipment document, which can be one of the following options: Shipment, Transfer. | |
shipped |
double |
Shipped Quantity | writable, shipped |
Orders tab > Shipped qty. > The quantity of goods shipped in accordance with the order. | |
shipped |
double |
itgen_vnet_shippedquantity | filters on the platform, writable, ::ancestor. |
The top part > Shipped quantity > The quantity of goods shipped. | |
shipped |
double |
Shipped Volume | writable, shipped |
Orders tab > Shipped volume > The volume of the goods shipped in accordance with the sales or transfer order. | |
shipped |
double |
itgen_vnet_shippedvolume_2 | filters on the platform, writable, ::ancestor. |
The top part > Shipped volume > The total volume of the items in the shipment. | |
shipped |
double |
Shipped Weight | writable, shipped |
Orders tab > Shipped weight > The weight of the goods shipped in accordance with the order. | |
shipped |
double |
itgen_vnet_shippedweight_2 | filters on the platform, writable, ::ancestor. |
The top part > Shipped weight > The weight of the goods shipped. | |
shipping |
varchar2 |
Shipping Terms Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
shipping |
varchar2 |
Shipping Terms ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
shipping |
varchar2 |
Shipping Zone Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
shipping |
varchar2 |
Shipping Zone ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
status |
varchar2 |
Status | filters on the platform, writable, ::ancestor. |
The top part > Status > The status of the document. | |
time |
blob |
Timestamp | filters on the platform, writable, ::ancestor. |
||
to |
varchar2 |
To Warehouse Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
to |
varchar2 |
To Warehouse ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
transaction |
varchar2 |
Transaction Type Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
transaction |
int32 |
Transaction Type ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
use |
char |
itgen_vnet_usecustomeraccount | filters on the platform, writable, ::ancestor. |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Shipment |
currency |
Currencies.id |
Key | |
Shipment |
from |
Warehouses. |
Key | |
Shipment |
location_ |
Countries.id |
Key | |
Shipment |
to |
Warehouses. |
Key |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: