invantive documentation
Invantive Support ForumsLog In / Sign Up

ShipmentOrderLinesByNumber: Visma.net Financials Shipment Order Lines by Number

read only REST

  • Catalog: VismaNet
  • Schema: Shipment
  • Label: Shipment Order Lines by Number

Get a specific Shipment Data for a single Shipment. The response headers include an ETag after a successful GET operation.

Can only retrieve data.

Summary

Data for a single Shipment.

The response headers include an ETag after a successful GET operation.

API Source

  • Endpoint: /v1/shipment/{shipmentNbr}
  • Operation: get /v1/shipment/{shipmentNbr}

Performance Characteristics

Characteristic Value
Average access latency (ms) 155
Full scan rows per minute 29,100
Point query rows per minute 387

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
includeCustomFreeFields `` Optional parameter to request custom free fields.
shipmentNbr `` Identifies the Shipment

Table Columns

The columns of the table ShipmentOrderLinesByNumber 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_CODE varchar2(30) Company Code writable Partition code, segmenting the data.
COMPANY_NAME varchar2(240) Company Name writable Name of the partition.
container char itgen_vnet_container filters on the platform, writable, ::ancestor.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 filters on the platform, writable, ::ancestor.controlQuantity 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 varchar2 Currency ID filters on the platform, writable, ::ancestor.currencyId Delivery settings tab > Freight currency > By default, it is the currency of the sales order, but you can change it if needed.
customDateTimeUTC1 datetime itgen_vnet_customdatetimeutc1 filters on the platform, writable, ::ancestor.customDateTimeUTC1 A free custom colum of type DateTime - in UTC timezone
customDec1 double itgen_vnet_customdec1 filters on the platform, writable, ::ancestor.customDec1 A free custom colum of type decimal with max 4 decimals.
customDec2 double itgen_vnet_customdec2 filters on the platform, writable, ::ancestor.customDec2 A free custom colum of type decimal with max 4 decimals.
customInt1 int32 itgen_vnet_customint1 filters on the platform, writable, ::ancestor.customInt1 A free custom colum of type int
customInt2 int32 itgen_vnet_customint2 filters on the platform, writable, ::ancestor.customInt2 A free custom colum of type int
customStr1 varchar2 itgen_vnet_customstr1 filters on the platform, writable, ::ancestor.customStr1 A free custom colum of type string with max length 100.
customStr2 varchar2 itgen_vnet_customstr2 filters on the platform, writable, ::ancestor.customStr2 A free custom colum of type string with max length 100.
customStr3 varchar2 itgen_vnet_customstr3 filters on the platform, writable, ::ancestor.customStr3 A free custom colum of type string with max length 100.
customStr4 varchar2 itgen_vnet_customstr4 filters on the platform, writable, ::ancestor.customStr4 A free custom colum of type string with max length 100.
customStr5 varchar2 itgen_vnet_customstr5 filters on the platform, writable, ::ancestor.customStr5 A free custom colum of type string with max length 100.
customer_internalId int32 Customer Internal ID filters on the platform, writable, ::ancestor.customer.internalId
customer_name varchar2 Customer Name filters on the platform, writable, ::ancestor.customer.name The name of the particular destination of the selected type.
customer_number varchar2 Customer Number filters on the platform, writable, ::ancestor.customer.number The identifier of the particular destination of the selected type.
deliveryAddress_addressId int32 Delivery Address ID filters on the platform, writable, ::ancestor.deliveryAddress.addressId
deliveryAddress_addressLine1 varchar2 Delivery Address Line 1 filters on the platform, writable, ::ancestor.deliveryAddress.addressLine1 Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
deliveryAddress_addressLine2 varchar2 Delivery Address Line 2 filters on the platform, writable, ::ancestor.deliveryAddress.addressLine2 Address 2 > The second line of the address.
deliveryAddress_addressLine3 varchar2 Delivery Address Line 3 filters on the platform, writable, ::ancestor.deliveryAddress.addressLine3 Address 3 > The third line of the address.
deliveryAddress_city varchar2 Delivery Address City filters on the platform, writable, ::ancestor.deliveryAddress.city City > The city.
deliveryAddress_country_errorInfo varchar2 itgen_vnet_deliveryaddress_country_errorinfo filters on the platform, writable, ::ancestor.deliveryAddress.country.errorInfo
deliveryAddress_country_id varchar2 Delivery Address Country ID filters on the platform, writable, ::ancestor.deliveryAddress.country.id Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
deliveryAddress_country_metadata_maxPageSize int64 itgen_vnet_deliveryaddress_country_metadata_maxpagesize filters on the platform, writable, ::ancestor.deliveryAddress.country.metadata.maxPageSize
deliveryAddress_country_metadata_totalCount int64 itgen_vnet_deliveryaddress_country_metadata_totalcount filters on the platform, writable, ::ancestor.deliveryAddress.country.metadata.totalCount
deliveryAddress_country_name varchar2 Delivery Address Country Name filters on the platform, writable, ::ancestor.deliveryAddress.country.name Mandatory field: Country name* > The complete name of the country.
deliveryAddress_county_id varchar2 Delivery Address County ID filters on the platform, writable, ::ancestor.deliveryAddress.county.id Click the magnifier > The identifier
deliveryAddress_county_name varchar2 Delivery Address County Name filters on the platform, writable, ::ancestor.deliveryAddress.county.name Click the magnifier > The displayed name
deliveryAddress_overrideAddress char itgen_vnet_deliveryaddress_overrideaddress filters on the platform, writable, ::ancestor.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 varchar2 Delivery Address Postal Code filters on the platform, writable, ::ancestor.deliveryAddress.postalCode Postcode > The postcode.
deliveryContact_attention varchar2 Delivery Contact Attention filters on the platform, writable, ::ancestor.deliveryContact.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 filters on the platform, writable, ::ancestor.deliveryContact.contactId
deliveryContact_email varchar2 Delivery Contact Email Address filters on the platform, writable, ::ancestor.deliveryContact.email Email > The email address of the customer/supplier/company as a business entity.
deliveryContact_fax varchar2 Delivery Contact Fax filters on the platform, writable, ::ancestor.deliveryContact.fax Fax > The fax number.
deliveryContact_name varchar2 Delivery Contact Name filters on the platform, writable, ::ancestor.deliveryContact.name Name > The legal name of to appear on the documents.
deliveryContact_overrideContact char itgen_vnet_deliverycontact_overridecontact filters on the platform, writable, ::ancestor.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 varchar2 Delivery Contact Phone 1 filters on the platform, writable, ::ancestor.deliveryContact.phone1 Phone 1 > The default phone number.
deliveryContact_phone2 varchar2 Delivery Contact Phone 2 filters on the platform, writable, ::ancestor.deliveryContact.phone2 Phone 2 > An additional phone number.
deliveryContact_web varchar2 Delivery Contact Website filters on the platform, writable, ::ancestor.deliveryContact.web Web > The website of the company, if one exists.
errorInfo varchar2 Error Message filters on the platform, writable, ::ancestor.errorInfo
fobPoint_description varchar2 FOB Point Description filters on the platform, writable, ::ancestor.fobPoint.description Click on the magnifier. > The description.
fobPoint_id varchar2 FOB Point ID filters on the platform, writable, ::ancestor.fobPoint.id Click on the magnifier. > The identifier.
freightAmt double itgen_vnet_freightamt filters on the platform, writable, ::ancestor.freightAmt Delivery settings tab > Shipping information section > Freight amt. > The amount of freight the customer will be charged for the shipment in base currency.
freightCost double itgen_vnet_freightcost filters on the platform, writable, ::ancestor.freightCost Delivery settings tab > Shipping information section > Freight cost > The freight cost of the shipment in base currency.
freightCurAmt double itgen_vnet_freightcuramt filters on the platform, writable, ::ancestor.freightCurAmt Delivery settings tab > Shipping information section > Freight amt. > The amount of freight the customer will be charged for the shipment in freight currency.
freightCurCost double itgen_vnet_freightcurcost filters on the platform, writable, ::ancestor.freightCurCost Delivery settings tab > Shipping information section > Freight cost > The freight cost of the shipment in freight currency.
fromWarehouse_description varchar2 itgen_vnet_fromwarehouse_description filters on the platform, writable, ::ancestor.fromWarehouse.description Click on the magnifier. > The description.
fromWarehouse_id varchar2 itgen_vnet_fromwarehouse_id filters on the platform, writable, ::ancestor.fromWarehouse.id Click on the magnifier. > The identifier.
hold char Hold filters on the platform, writable, ::ancestor.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 char Insurance filters on the platform, writable, ::ancestor.insurance Delivery settings tab > Shipping information section > Insurance > This check box indicates (if selected) that insurance is required for the shipment.
inventoryDocType varchar2 itgen_vnet_inventorydoctype writable, inventoryDocType Orders tab > Inventory doc. type > The type of the inventory document that lists the items for this shipment.
inventoryRefNbr varchar2 itgen_vnet_inventoryrefnbr writable, inventoryRefNbr Orders tab > Inventory ref. no. > The reference number of the inventory document that lists the items for this shipment.
invoiceNbr varchar2 Invoice Number writable, invoiceNbr Orders tab > Invoice no. > The reference number of the invoice for the goods shipped.
invoiceType varchar2 itgen_vnet_invoicetype writable, invoiceType Orders tab > Invoice type > The type of invoice for the goods shipped for the sales order.
lastModifiedDateTime datetime Last Modified filters on the platform, writable, ::ancestor.lastModifiedDateTime System generated information.
location_countryId varchar2 Location Country ID filters on the platform, writable, ::ancestor.location.countryId Location*.
location_id varchar2 Location ID filters on the platform, writable, ::ancestor.location.id Click the magnifier > The identifier
location_name varchar2 Location Name filters on the platform, writable, ::ancestor.location.name Click the magnifier > The displayed name
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, ::ancestor.metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, ::ancestor.metadata.totalCount
modeOfTrasport_description varchar2 itgen_vnet_modeoftrasport_description filters on the platform, writable, ::ancestor.modeOfTrasport.description Click on the magnifier. > The description.
modeOfTrasport_id int32 itgen_vnet_modeoftrasport_id filters on the platform, writable, ::ancestor.modeOfTrasport.id Click on the magnifier. > The identifier.
note varchar2 Note writable, note
note_2 varchar2 Note 2 filters on the platform, writable, ::ancestor.note
operation varchar2 Operation filters on the platform, writable, ::ancestor.operation The top part > Operation > The operation to be performed in the Inventory workspace for this shipment: Issue or Receipt.
orderNbr varchar2 Order Number writable, orderNbr Orders tab > Order no. > The reference number of the sales or transfer order.
orderType varchar2 Order Type writable, orderType Orders tab > Order typer > The type of the order.
owner_id guid Owner ID filters on the platform, writable, ::ancestor.owner.id Click the magnifier > The identifier
owner_name varchar2 Owner Name filters on the platform, writable, ::ancestor.owner.name Click the magnifier > The displayed name
packages int32 Packages filters on the platform, writable, ::ancestor.packages The top part > Packages > The number of boxes included in this shipment.
packagesVolume double itgen_vnet_packagesvolume filters on the platform, writable, ::ancestor.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 filters on the platform, writable, ::ancestor.packagesWeight The top part > Package weight > The total weight of the shipment that includes the weight of boxes (for boxes determined automatically).
residentialDelivery char Residential Delivery filters on the platform, writable, ::ancestor.residentialDelivery Delivery settings tab > Shipping information section > Residential delivery > This check box indicates (if selected) that the shipping address is a residential one.
saturdayDelivery char Saturday Delivery filters on the platform, writable, ::ancestor.saturdayDelivery Delivery settings tab > Shipping information section > Saturday delivery > This check box indicates delivery on saturday.
shipVia_description varchar2 Ship via Description filters on the platform, writable, ::ancestor.shipVia.description Click on the magnifier. > The description.
shipVia_id varchar2 Ship via ID filters on the platform, writable, ::ancestor.shipVia.id Click on the magnifier. > The identifier.
shipmentDate datetime Shipment Date filters on the platform, writable, ::ancestor.shipmentDate Mandatory field: The top part > Shipment date* > The date when the document has been created.
shipmentNumber varchar2 Shipment Number filters on the platform, writable, ::ancestor.shipmentNumber The top part > Shipment no > The unique reference number of the document, which is automatically generated by the system.
shipmentType varchar2 Shipment Type filters on the platform, writable, ::ancestor.shipmentType The top part > Type > The type of the shipment document, which can be one of the following options: Shipment, Transfer.
shippedQty double Shipped Quantity writable, shippedQty Orders tab > Shipped qty. > The quantity of goods shipped in accordance with the order.
shippedQuantity double itgen_vnet_shippedquantity filters on the platform, writable, ::ancestor.shippedQuantity The top part > Shipped quantity > The quantity of goods shipped.
shippedVolume double Shipped Volume writable, shippedVolume Orders tab > Shipped volume > The volume of the goods shipped in accordance with the sales or transfer order.
shippedVolume_2 double itgen_vnet_shippedvolume_2 filters on the platform, writable, ::ancestor.shippedVolume The top part > Shipped volume > The total volume of the items in the shipment.
shippedWeight double Shipped Weight writable, shippedWeight Orders tab > Shipped weight > The weight of the goods shipped in accordance with the order.
shippedWeight_2 double itgen_vnet_shippedweight_2 filters on the platform, writable, ::ancestor.shippedWeight The top part > Shipped weight > The weight of the goods shipped.
shippingTerms_description varchar2 Shipping Terms Description filters on the platform, writable, ::ancestor.shippingTerms.description Click on the magnifier. > The description.
shippingTerms_id varchar2 Shipping Terms ID filters on the platform, writable, ::ancestor.shippingTerms.id Click on the magnifier. > The identifier.
shippingZone_description varchar2 Shipping Zone Description filters on the platform, writable, ::ancestor.shippingZone.description Click on the magnifier. > The description.
shippingZone_id varchar2 Shipping Zone ID filters on the platform, writable, ::ancestor.shippingZone.id Click on the magnifier. > The identifier.
status varchar2 Status filters on the platform, writable, ::ancestor.status The top part > Status > The status of the document.
timeStamp blob Timestamp filters on the platform, writable, ::ancestor.timeStamp
toWarehouse_description varchar2 To Warehouse Description filters on the platform, writable, ::ancestor.toWarehouse.description Click on the magnifier. > The description.
toWarehouse_id varchar2 To Warehouse ID filters on the platform, writable, ::ancestor.toWarehouse.id Click on the magnifier. > The identifier.
transactionType_description varchar2 Transaction Type Description filters on the platform, writable, ::ancestor.transactionType.description Click on the magnifier. > The description.
transactionType_id int32 Transaction Type ID filters on the platform, writable, ::ancestor.transactionType.id Click on the magnifier. > The identifier.
useCustomerAccount char itgen_vnet_usecustomeraccount filters on the platform, writable, ::ancestor.useCustomerAccount

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: