invantive documentation
Invantive Support ForumsLog In / Sign Up

TransferOrderShipmentsByTypeOrderId: Visma.net Financials itgen_vnet_transferordershipmentsbytypeorderid_plural

read only REST

  • Catalog: NgSalesOrders
  • Schema: TransferOrders
  • Label: itgen_vnet_transferordershipmentsbytypeorderid_plural

Gets the shipments of a single transfer order A transfer order with lines from several source warehouses has one shipment per source warehouse.

Sample request:

GET /transferorders/TR/000100/shipment

Can only retrieve data.

Summary

A transfer order with lines from several source warehouses has one shipment per source warehouse.

Sample request:

GET /transferorders/TR/000100/shipment

API Source

  • Endpoint: /api/v3/TransferOrders/{type}/{orderId}/shipment
  • Operation: get /api/v3/TransferOrders/{type}/{orderId}/shipment

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
orderId `` The id of the transfer order
type `` The transfer order type, TR or a custom order type derived from it

Table Columns

The columns of the table TransferOrderShipmentsByTypeOrderId 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.
date datetime Date filters on the platform, writable, date The date of the shipment
id varchar2 ID filters on the platform, writable, id The id of the shipment
inventoryCorrectionDocumentType varchar2 itgen_vnet_inventorycorrectiondocumenttype filters on the platform, writable, inventoryCorrectionDocumentType The type of inventory correction document created for the shipment
inventoryCorrectionReferenceId varchar2 itgen_vnet_inventorycorrectionreferenceid filters on the platform, writable, inventoryCorrectionReferenceId The id of the inventory correction document created for the shipment
inventoryDocumentType varchar2 itgen_vnet_inventorydocumenttype filters on the platform, writable, inventoryDocumentType The type of inventory document created for the shipment
inventoryReferenceId varchar2 itgen_vnet_inventoryreferenceid filters on the platform, writable, inventoryReferenceId The id of the inventory document created for the shipment
operation varchar2 Operation filters on the platform, writable, operation The operation of the shipment
quantity double Quantity filters on the platform, writable, quantity The quantity of goods on the shipment
sourceWarehouse_description varchar2 itgen_vnet_sourcewarehouse_description filters on the platform, writable, sourceWarehouse.description The description
sourceWarehouse_id varchar2 itgen_vnet_sourcewarehouse_id filters on the platform, writable, sourceWarehouse.id The id
status varchar2 Status filters on the platform, writable, status The status of the shipment
type varchar2 Type filters on the platform, writable, type The type of the shipment
volume double itgen_vnet_volume filters on the platform, writable, volume The volume of the shipped goods
weight double Weight filters on the platform, writable, weight The weight of the shipped goods

Release Notes

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