ShipmentPackageLines: Visma.net Financials Shipment Package Lines

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.

boxId

string

Box ID

☐

Mandatory field: Packages tab > Box ID* > The box used for the package.

coDAmount

double

{res:itgen_vnet_codamount}

☐

Packages tab > Cost of delivery amount > The amount to be charged on delivery of the package, you can edit the value if needed.

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

confirmed

boolean

Confirmed

☐

Packages tab > Confirmed > This check box indicates (if selected) that shipping of the package specified on the line has been confirmed.

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

datetime

{res:itgen_vnet_customdatetimeutc1}

☐

A free custom colum of type DateTime - in UTC timezone

customDec1

double

{res:itgen_vnet_customdec1}

☐

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

int32

{res:itgen_vnet_customint1}

☐

A free custom colum of type int

customInt2

int32

{res:itgen_vnet_customint2}

☐

A free custom colum of type int

customRefNbr1

string

{res:itgen_vnet_customrefnbr1}

☐

Packages tab > Customer ref. no. 1 > An auxiliary reference number to appear on the carrier label for the box.

customRefNbr2

string

{res:itgen_vnet_customrefnbr2}

☐

Packages tab > Customer ref. no. 2 > An additional auxiliary reference number to appear on the carrier label for the box.

customStr1

string

{res:itgen_vnet_customstr1}

☐

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

string

{res:itgen_vnet_customstr3}

☐

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

string

{res:itgen_vnet_customstr5}

☐

A free custom colum of type string with max length 100.

declaredValue

double

Declared Value

☐

Packages tab > Declared value > The amount of the package specified for insurance, you can edit the value if needed.

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

☐

Packages tab > Description > The description of the item or description of the box contents.

errorInfo

string

Error Message

☐

fobPoint_description

string

FOB Point Description

☐

Click on the magnifier. > The description.

fobPoint_id

string

FOB Point ID

☐

Click on the magnifier. > The identifier.

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.

lastModifiedDateTime

datetime

Last Modified

☐

System generated information.

lineNumber

int32

Line Number

☐

Packages tab > Line number. The sequence of the lines.

location_countryId

string

Location Country ID

☐

Location*.

location_id

string

Location ID

☐

Click the magnifier > The identifier

location_name

string

Location Name

☐

Click the magnifier > The displayed name

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

string

Note

☐

operation

string

Operation

☐

The top part > Operation > The operation to be performed in the Inventory workspace for this shipment: Issue or Receipt.

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).

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.

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.

trackingNumber

string

{res:itgen_vnet_trackingnumber}

☐

Packages tab > Tracking number > The tracking number provided for the package by the carrier if integration with carrier is configured.

transactionType_description

string

Transaction Type Description

☐

Click on the magnifier. > The description.

transactionType_id

int32

Transaction Type ID

☐

Click on the magnifier. > The identifier.

type

string

Type

☐

Packages tab > Type > The type of package: Auto or Manual.

uom

string

Unit of Measure

☐

Packages tab > UoM > The unit of measure in which the weight of the package is specified.

useCustomerAccount

boolean

{res:itgen_vnet_usecustomeraccount}

☐

volume

double

{res:itgen_vnet_volume}

☐

Packages tab > Volume > The gross volume of the package.

volumeUOM

string

Volume UOM

☐

Packages tab > VolumeUoM > The unit of measure in which the volume of the package is specified.

weight

double

Weight

☐

Packages tab > Weight > The gross weight of the package.