invantive documentation
Invantive Support ForumsLog In / Sign Up

ShipmentDetailLineAllocations: Visma.net Financials Shipment Detail Line Allocations

read only REST

  • Catalog: VismaNet
  • Schema: Shipment
  • Label: Shipment Detail Line Allocations

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) 5,440
Full scan rows per minute 104,000
Point query rows per minute 387

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
customerId ``
customerNumber ``
greaterThanValue `` This field has been deprecated and will be removed in future versions. The GreaterThanValue parameter has no effect on the result.
includeCustomFreeFields `` 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 `` 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 `` 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.
shipmentDate `` Shipment Date 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: ShipmentDate and ShipmentDate are mutually inclusive.
shipmentDateCondition `` 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 `` 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 ShipmentDetailLineAllocations 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.
alternateID varchar2 Alternate ID writable, ::ancestor.alternateID
container char itgen_vnet_container filters on the platform, writable, ::ancestor.::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.::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.::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 writable, ::ancestor.customDateTimeUTC1 A free custom colum of type DateTime - in UTC timezone
customDateTimeUTC1_2 datetime itgen_vnet_customdatetimeutc1_2 filters on the platform, writable, ::ancestor.::ancestor.customDateTimeUTC1 A free custom colum of type DateTime - in UTC timezone
customDec1 double itgen_vnet_customdec1 writable, ::ancestor.customDec1 A free custom colum of type decimal with max 4 decimals.
customDec1_2 double itgen_vnet_customdec1_2 filters on the platform, writable, ::ancestor.::ancestor.customDec1 A free custom colum of type decimal with max 4 decimals.
customDec2 double itgen_vnet_customdec2 writable, ::ancestor.customDec2 A free custom colum of type decimal with max 4 decimals.
customDec2_2 double itgen_vnet_customdec2_2 filters on the platform, writable, ::ancestor.::ancestor.customDec2 A free custom colum of type decimal with max 4 decimals.
customInt1 int32 itgen_vnet_customint1 writable, ::ancestor.customInt1 A free custom colum of type int
customInt1_2 int32 itgen_vnet_customint1_2 filters on the platform, writable, ::ancestor.::ancestor.customInt1 A free custom colum of type int
customInt2 int32 itgen_vnet_customint2 writable, ::ancestor.customInt2 A free custom colum of type int
customInt2_2 int32 itgen_vnet_customint2_2 filters on the platform, writable, ::ancestor.::ancestor.customInt2 A free custom colum of type int
customStr1 varchar2 itgen_vnet_customstr1 writable, ::ancestor.customStr1 A free custom colum of type string with max length 100.
customStr1_2 varchar2 itgen_vnet_customstr1_2 filters on the platform, writable, ::ancestor.::ancestor.customStr1 A free custom colum of type string with max length 100.
customStr2 varchar2 itgen_vnet_customstr2 writable, ::ancestor.customStr2 A free custom colum of type string with max length 100.
customStr2_2 varchar2 itgen_vnet_customstr2_2 filters on the platform, writable, ::ancestor.::ancestor.customStr2 A free custom colum of type string with max length 100.
customStr3 varchar2 itgen_vnet_customstr3 writable, ::ancestor.customStr3 A free custom colum of type string with max length 100.
customStr3_2 varchar2 itgen_vnet_customstr3_2 filters on the platform, writable, ::ancestor.::ancestor.customStr3 A free custom colum of type string with max length 100.
customStr4 varchar2 itgen_vnet_customstr4 writable, ::ancestor.customStr4 A free custom colum of type string with max length 100.
customStr4_2 varchar2 itgen_vnet_customstr4_2 filters on the platform, writable, ::ancestor.::ancestor.customStr4 A free custom colum of type string with max length 100.
customStr5 varchar2 itgen_vnet_customstr5 writable, ::ancestor.customStr5 A free custom colum of type string with max length 100.
customStr5_2 varchar2 itgen_vnet_customstr5_2 filters on the platform, writable, ::ancestor.::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.::ancestor.customer.internalId
customer_name varchar2 Customer Name filters on the platform, writable, ::ancestor.::ancestor.customer.name The name of the particular destination of the selected type.
customer_number varchar2 Customer Number filters on the platform, writable, ::ancestor.::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.::ancestor.deliveryAddress.addressId
deliveryAddress_addressLine1 varchar2 Delivery Address Line 1 filters on the platform, writable, ::ancestor.::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.::ancestor.deliveryAddress.addressLine2 Address 2 > The second line of the address.
deliveryAddress_addressLine3 varchar2 Delivery Address Line 3 filters on the platform, writable, ::ancestor.::ancestor.deliveryAddress.addressLine3 Address 3 > The third line of the address.
deliveryAddress_city varchar2 Delivery Address City filters on the platform, writable, ::ancestor.::ancestor.deliveryAddress.city City > The city.
deliveryAddress_country_errorInfo varchar2 itgen_vnet_deliveryaddress_country_errorinfo filters on the platform, writable, ::ancestor.::ancestor.deliveryAddress.country.errorInfo
deliveryAddress_country_id varchar2 Delivery Address Country ID filters on the platform, writable, ::ancestor.::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.::ancestor.deliveryAddress.country.metadata.maxPageSize
deliveryAddress_country_metadata_totalCount int64 itgen_vnet_deliveryaddress_country_metadata_totalcount filters on the platform, writable, ::ancestor.::ancestor.deliveryAddress.country.metadata.totalCount
deliveryAddress_country_name varchar2 Delivery Address Country Name filters on the platform, writable, ::ancestor.::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.::ancestor.deliveryAddress.county.id Click the magnifier > The identifier
deliveryAddress_county_name varchar2 Delivery Address County Name filters on the platform, writable, ::ancestor.::ancestor.deliveryAddress.county.name Click the magnifier > The displayed name
deliveryAddress_overrideAddress char itgen_vnet_deliveryaddress_overrideaddress filters on the platform, writable, ::ancestor.::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.::ancestor.deliveryAddress.postalCode Postcode > The postcode.
deliveryContact_attention varchar2 Delivery Contact Attention filters on the platform, writable, ::ancestor.::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.::ancestor.deliveryContact.contactId
deliveryContact_email varchar2 Delivery Contact Email Address filters on the platform, writable, ::ancestor.::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.::ancestor.deliveryContact.fax Fax > The fax number.
deliveryContact_name varchar2 Delivery Contact Name filters on the platform, writable, ::ancestor.::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.::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.::ancestor.deliveryContact.phone1 Phone 1 > The default phone number.
deliveryContact_phone2 varchar2 Delivery Contact Phone 2 filters on the platform, writable, ::ancestor.::ancestor.deliveryContact.phone2 Phone 2 > An additional phone number.
deliveryContact_web varchar2 Delivery Contact Website filters on the platform, writable, ::ancestor.::ancestor.deliveryContact.web Web > The website of the company, if one exists.
description varchar2 Description writable, description Description > The description of the stock item.
description_2 varchar2 Description 2 writable, ::ancestor.description Document details tab > Description > A short description for the shipment.
errorInfo varchar2 Error Message filters on the platform, writable, ::ancestor.::ancestor.errorInfo
expirationDate datetime Expiration Date writable, expirationDate Expiration date > The expiration date of the specified quantity of the stock item.
expirationDate_2 datetime itgen_vnet_expirationdate_2 writable, ::ancestor.expirationDate Document details tab > Expiration date > The expiration date of the item, if it is traced for this item ID.
externalLink varchar2 itgen_vnet_externallink writable, ::ancestor.externalLink
fobPoint_description varchar2 FOB Point Description filters on the platform, writable, ::ancestor.::ancestor.fobPoint.description Click on the magnifier. > The description.
fobPoint_id varchar2 FOB Point ID filters on the platform, writable, ::ancestor.::ancestor.fobPoint.id Click on the magnifier. > The identifier.
freeItem char Free Item writable, ::ancestor.freeItem Document details tab > Free item > The free item earned by the customer, if applicable. (This column does not appear for transfer.)
freightAmt double itgen_vnet_freightamt filters on the platform, writable, ::ancestor.::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.::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.::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.::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.::ancestor.fromWarehouse.description Click on the magnifier. > The description.
fromWarehouse_id varchar2 itgen_vnet_fromwarehouse_id filters on the platform, writable, ::ancestor.::ancestor.fromWarehouse.id Click on the magnifier. > The identifier.
hold char Hold filters on the platform, writable, ::ancestor.::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.::ancestor.insurance Delivery settings tab > Shipping information section > Insurance > This check box indicates (if selected) that insurance is required for the shipment.
inventoryNumber varchar2 Inventory Number writable, ::ancestor.inventoryNumber Document details tab > Item ID > The ID of the item being shipped.
itemId varchar2 Item ID writable, itemId ItemId > The id of the item.
lastModifiedDateTime datetime Last Modified filters on the platform, writable, ::ancestor.::ancestor.lastModifiedDateTime System generated information.
lineNbr int32 itgen_vnet_linenbr writable, lineNbr Line no. > The line of the purchase order that contains the selected item.
lineNumber int32 Line Number writable, ::ancestor.lineNumber Document details tab > The line number indicating sequence.
location_countryId varchar2 Location Country ID writable, location.countryId Location*.
location_countryId_2 varchar2 Location Country ID 2 writable, ::ancestor.location.countryId Location*.
location_countryId_3 varchar2 itgen_vnet_location_countryid_3 filters on the platform, writable, ::ancestor.::ancestor.location.countryId Location*.
location_id varchar2 Location ID writable, location.id Click the magnifier > The identifier
location_id_2 varchar2 Location ID 2 writable, ::ancestor.location.id Click the magnifier > The identifier
location_id_3 varchar2 itgen_vnet_location_id_3 filters on the platform, writable, ::ancestor.::ancestor.location.id Click the magnifier > The identifier
location_name varchar2 Location Name writable, location.name Click the magnifier > The displayed name
location_name_2 varchar2 Location Name 2 writable, ::ancestor.location.name Click the magnifier > The displayed name
location_name_3 varchar2 itgen_vnet_location_name_3 filters on the platform, writable, ::ancestor.::ancestor.location.name Click the magnifier > The displayed name
lotSerialNbr varchar2 itgen_vnet_lotserialnbr writable, ::ancestor.lotSerialNbr Document details tab > Lot/serial no. > The lot or serial number of particular items of the item.
lotSerialNumber varchar2 Lot Serial Number writable, lotSerialNumber Lot/Serial no. > The lot or serial number of the item.
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, ::ancestor.::ancestor.metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, ::ancestor.::ancestor.metadata.totalCount
modeOfTrasport_description varchar2 itgen_vnet_modeoftrasport_description filters on the platform, writable, ::ancestor.::ancestor.modeOfTrasport.description Click on the magnifier. > The description.
modeOfTrasport_id int32 itgen_vnet_modeoftrasport_id filters on the platform, writable, ::ancestor.::ancestor.modeOfTrasport.id Click on the magnifier. > The identifier.
note varchar2 Note writable, ::ancestor.note
note_2 varchar2 Note 2 filters on the platform, writable, ::ancestor.::ancestor.note
openQty double Open Quantity writable, ::ancestor.openQty Document details tab > Open qty. > The number of items with the specified quantities still to be shipped.
operation varchar2 Operation filters on the platform, writable, ::ancestor.::ancestor.operation The top part > Operation > The operation to be performed in the Inventory workspace for this shipment: Issue or Receipt.
orderLineNbr int32 itgen_vnet_orderlinenbr writable, ::ancestor.orderLineNbr Document details tab > Order line no. > Read only. The order's line number that matches this shipment line.
orderNbr varchar2 Order Number writable, ::ancestor.orderNbr Document details tab > Order no. > The reference number of the document.
orderType varchar2 Order Type writable, ::ancestor.orderType Document details tab > The type of the document, which is one of the predefined order types or a custom order type.
orderedQty double itgen_vnet_orderedqty writable, ::ancestor.orderedQty Document details tab > Ordered qty. > The quantity of the item ordered with the specified properties.
owner_id guid Owner ID filters on the platform, writable, ::ancestor.::ancestor.owner.id Click the magnifier > The identifier
owner_name varchar2 Owner Name filters on the platform, writable, ::ancestor.::ancestor.owner.name Click the magnifier > The displayed name
packages int32 Packages filters on the platform, writable, ::ancestor.::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.::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.::ancestor.packagesWeight The top part > Package weight > The total weight of the shipment that includes the weight of boxes (for boxes determined automatically).
quantity double Quantity writable, quantity Quantity > The quantity of the stock item with the same lot number. It is 1 for items with serial numbers.
reasonCode varchar2 Reason Code writable, ::ancestor.reasonCode Document details tab > Reason code > The reason code used for shipments.
residentialDelivery char Residential Delivery filters on the platform, writable, ::ancestor.::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.::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.::ancestor.shipVia.description Click on the magnifier. > The description.
shipVia_id varchar2 Ship via ID filters on the platform, writable, ::ancestor.::ancestor.shipVia.id Click on the magnifier. > The identifier.
shipmentDate datetime Shipment Date filters on the platform, writable, ::ancestor.::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.::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.::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, ::ancestor.shippedQty Document details tab > Shipped qty. > The quantity of the item shipped with the specified properties.
shippedQuantity double itgen_vnet_shippedquantity filters on the platform, writable, ::ancestor.::ancestor.shippedQuantity The top part > Shipped quantity > The quantity of goods shipped.
shippedVolume double Shipped Volume filters on the platform, writable, ::ancestor.::ancestor.shippedVolume The top part > Shipped volume > The total volume of the items in the shipment.
shippedWeight double Shipped Weight filters on the platform, writable, ::ancestor.::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.::ancestor.shippingTerms.description Click on the magnifier. > The description.
shippingTerms_id varchar2 Shipping Terms ID filters on the platform, writable, ::ancestor.::ancestor.shippingTerms.id Click on the magnifier. > The identifier.
shippingZone_description varchar2 Shipping Zone Description filters on the platform, writable, ::ancestor.::ancestor.shippingZone.description Click on the magnifier. > The description.
shippingZone_id varchar2 Shipping Zone ID filters on the platform, writable, ::ancestor.::ancestor.shippingZone.id Click on the magnifier. > The identifier.
status varchar2 Status filters on the platform, writable, ::ancestor.::ancestor.status The top part > Status > The status of the document.
timeStamp blob Timestamp filters on the platform, writable, ::ancestor.::ancestor.timeStamp
toWarehouse_description varchar2 To Warehouse Description filters on the platform, writable, ::ancestor.::ancestor.toWarehouse.description Click on the magnifier. > The description.
toWarehouse_id varchar2 To Warehouse ID filters on the platform, writable, ::ancestor.::ancestor.toWarehouse.id Click on the magnifier. > The identifier.
transactionType_description varchar2 Transaction Type Description filters on the platform, writable, ::ancestor.::ancestor.transactionType.description Click on the magnifier. > The description.
transactionType_id int32 Transaction Type ID filters on the platform, writable, ::ancestor.::ancestor.transactionType.id Click on the magnifier. > The identifier.
uom varchar2 Unit of Measure writable, uom UoM > The unit of measure for the specified quantity of the inventory item.
uom_2 varchar2 itgen_vnet_uom_2 writable, ::ancestor.uom Document details tab > UoM > The unit of measure used for the item in shipment.
useCustomerAccount char itgen_vnet_usecustomeraccount filters on the platform, writable, ::ancestor.::ancestor.useCustomerAccount
warehouse_description varchar2 Warehouse Description writable, ::ancestor.warehouse.description Click on the magnifier. > The description.
warehouse_id varchar2 Warehouse ID writable, ::ancestor.warehouse.id Click on the magnifier. > The identifier.

Keys

Key Column Refers to Kind Description
ShipmentDetailLineAllocations_currencyId_fk currencyId Currencies.id Key
ShipmentDetailLineAllocations_fromWarehouse_id_fk fromWarehouse_id Warehouses.warehouseID Key
ShipmentDetailLineAllocations_location_countryId_fk location_countryId Countries.id Key
ShipmentDetailLineAllocations_toWarehouse_id_fk toWarehouse_id Warehouses.warehouseID Key
ShipmentDetailLineAllocations_warehouse_id_fk warehouse_id Warehouses.warehouseID Key

Release Notes

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