invantive documentation
Invantive Support ForumsLog In / Sign Up

TransferOrderLinesByType: Visma.net Financials itgen_vnet_transferorderlinesbytype_plural

read only REST

  • Catalog: NgSalesOrders
  • Schema: TransferOrders
  • Label: itgen_vnet_transferorderlinesbytype_plural

Gets a paged list with transfer orders of a specific transfer order type Sample requests:

GET /transferorders/TR

GET /transferorders/TR?destinationWarehouseId=MAIN&status=Open&pageSize=10

GET /transferorders/TR?orderBy=lastModified%20desc&expand=lines

Can only retrieve data.

Summary

Sample requests:

GET /transferorders/TR

GET /transferorders/TR?destinationWarehouseId=MAIN&status=Open&pageSize=10

GET /transferorders/TR?orderBy=lastModified%20desc&expand=lines

API Source

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

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
destinationWarehouseId `` The destination warehouse for which to retrieve orders. If omitted or empty, orders for all destination warehouses are included.
modifiedSince `` A date/time value for filtering when a transfer order last changed. Unless a specific time zone offset is included (e.g. '2012-12-24T12:15:14+02:00'), the date is considered to be in the UTC time zone.
status `` The order status to include in the result. If omitted or empty, orders with any status are included.
type `` The transfer order type, TR or a custom order type derived from it

Table Columns

The columns of the table TransferOrderLinesByType 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.
baseOrderQuantity double itgen_vnet_baseorderquantity writable, baseOrderQuantity The base order quantity for this line
branch_description varchar2 itgen_vnet_branch_description filters on the platform, writable, ::ancestor.branch.description The description
branch_id varchar2 itgen_vnet_branch_id filters on the platform, writable, ::ancestor.branch.id The id
c_links varchar2 itgen_vnet_c_links writable Links applicable for the dto The JSON text of the nested object.
cancelBy datetime Cancel by filters on the platform, writable, ::ancestor.cancelBy The cancel date for the order
completed char Completed writable, completed Whether the line is completed
currency varchar2 Currency filters on the platform, writable, ::ancestor.currency The currency id for the order. Read only.
currencyRate double itgen_vnet_currencyrate filters on the platform, writable, ::ancestor.currencyRate The currency rate of the order. Read only.
customFields_customDateTimeUtc1 datetime itgen_vnet_customfields_customdatetimeutc1 writable, customFields.customDateTimeUtc1 A free custom colum of type DateTime - in UTC timezone
customFields_customDec1 double itgen_vnet_customfields_customdec1 writable, customFields.customDec1 A free custom colum of type decimal with max 4 decimals.
customFields_customDec2 double itgen_vnet_customfields_customdec2 writable, customFields.customDec2 A free custom colum of type decimal with max 4 decimals.
customFields_customInt1 int32 itgen_vnet_customfields_customint1 writable, customFields.customInt1 A free custom colum of type int
customFields_customInt2 int32 itgen_vnet_customfields_customint2 writable, customFields.customInt2 A free custom colum of type int
customFields_customStr1 varchar2 itgen_vnet_customfields_customstr1 writable, customFields.customStr1 A free custom colum of type string with max length 100.
customFields_customStr2 varchar2 itgen_vnet_customfields_customstr2 writable, customFields.customStr2 A free custom colum of type string with max length 100.
customFields_customStr3 varchar2 itgen_vnet_customfields_customstr3 writable, customFields.customStr3 A free custom colum of type string with max length 100.
customFields_customStr4 varchar2 itgen_vnet_customfields_customstr4 writable, customFields.customStr4 A free custom colum of type string with max length 100.
customFields_customStr5 varchar2 itgen_vnet_customfields_customstr5 writable, customFields.customStr5 A free custom colum of type string with max length 100.
date datetime Date filters on the platform, writable, ::ancestor.date The order date
description varchar2 Description writable, description The description of the line
description_2 varchar2 Description 2 filters on the platform, writable, ::ancestor.description Any description on the order
destinationWarehouse_description varchar2 itgen_vnet_destinationwarehouse_description filters on the platform, writable, ::ancestor.destinationWarehouse.description The description
destinationWarehouse_id varchar2 itgen_vnet_destinationwarehouse_id filters on the platform, writable, ::ancestor.destinationWarehouse.id The id
externalLink varchar2 itgen_vnet_externallink writable, externalLink An external link attached to the line
inventoryAlternateId varchar2 itgen_vnet_inventoryalternateid writable, inventoryAlternateId The alternate id of the inventory item
inventory_baseUnit varchar2 itgen_vnet_inventory_baseunit writable, inventory.baseUnit
inventory_description varchar2 Inventory Description writable, inventory.description The description
inventory_id varchar2 itgen_vnet_inventory_id writable, inventory.id The id
lastModified datetime Last Modified filters on the platform, writable, ::ancestor.lastModified The date and time the order was last modified
lineId int32 Line Identifier writable, lineId The line number of the transfer order line
lineType varchar2 Line Type writable, lineType The type of transfer order line. A non-stock item is stored as a miscellaneous line.
note varchar2 Note writable, note Any notes on the line
openQuantity double itgen_vnet_openquantity writable, openQuantity The quantity that is not shipped yet
operation varchar2 Operation writable, operation The type of operation the line represents to the order
orderId varchar2 itgen_vnet_orderid filters on the platform, writable, ::ancestor.orderId The order id for the order
orderQty double Order Quantity filters on the platform, writable, ::ancestor.orderQty The total number of items on the order
overshipThreshold double itgen_vnet_overshipthreshold writable, overshipThreshold The overship threshold value (%)
purchaseOrderSource varchar2 itgen_vnet_purchaseordersource writable, purchaseOrderSource The purchase order source of a line marked for purchase order: purchaseToOrder or dropShip
quantity double Quantity writable, quantity The quantity of unit of measure this line represents
quantityOnShipments double itgen_vnet_quantityonshipments writable, quantityOnShipments The quantity on shipments
reasonCode varchar2 Reason Code writable, reasonCode The reason code of the line
requestDate datetime itgen_vnet_requestdate writable, requestDate The date the line is requested
requestOn datetime Request On filters on the platform, writable, ::ancestor.requestOn The date the order is requested
salesAccountId varchar2 itgen_vnet_salesaccountid writable, salesAccountId The sales account of the line
shipDate datetime itgen_vnet_shipdate writable, shipDate The date the line is scheduled to ship
shippingRule varchar2 itgen_vnet_shippingrule writable, shippingRule The shipping rule of the line
shippingScheduledDate datetime itgen_vnet_shippingscheduleddate filters on the platform, writable, ::ancestor.shippingScheduledDate The date shipment is scheduled
sortOrder int32 itgen_vnet_sortorder writable, sortOrder Used to apply sort order to a set of lines
status varchar2 Status filters on the platform, writable, ::ancestor.status The current status of the order
subaccount varchar2 Sub Account writable The subaccount of the line, by segment The JSON text of the nested object.
supplier_currencyId varchar2 itgen_vnet_supplier_currencyid writable, supplier.currencyId The currency of the supplier selected for the order line
supplier_id varchar2 itgen_vnet_supplier_id writable, supplier.id The id of the supplier selected for the order line
supplier_name varchar2 Supplier Name writable, supplier.name The name of the supplier selected for the order line
supplier_price double itgen_vnet_supplier_price writable, supplier.price The supplier price of the supplier selected for the order line
supplier_unitOfMeasure varchar2 itgen_vnet_supplier_unitofmeasure writable, supplier.unitOfMeasure The unit of measure used by the supplier for this line
type varchar2 Type filters on the platform, writable, ::ancestor.type The transfer order type code
undershipThreshold double itgen_vnet_undershipthreshold writable, undershipThreshold The undership threshold value (%)
unitOfMeasure varchar2 itgen_vnet_unitofmeasure writable, unitOfMeasure The unit of measure (UOM) for the transfer order line
warehouseId varchar2 Warehouse ID writable, warehouseId The source warehouse the goods are transferred from
warehouseLocation_description varchar2 itgen_vnet_warehouselocation_description writable, warehouseLocation.description The description
warehouseLocation_id varchar2 itgen_vnet_warehouselocation_id writable, warehouseLocation.id The id

Release Notes

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