invantive documentation
Invantive Support ForumsLog In / Sign Up

TransferOrdersByType: Visma.net Financials itgen_vnet_transferordersbytype_plural

read only REST

  • Catalog: NgSalesOrders
  • Schema: TransferOrders
  • Label: itgen_vnet_transferordersbytype_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 TransferOrdersByType 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.
branch_description varchar2 itgen_vnet_branch_description filters on the platform, writable, branch.description The description
branch_id varchar2 itgen_vnet_branch_id filters on the platform, writable, 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, cancelBy The cancel date for the order
currency varchar2 Currency filters on the platform, writable, currency The currency id for the order. Read only.
currencyRate double itgen_vnet_currencyrate filters on the platform, writable, currencyRate The currency rate of the order. Read only.
date datetime Date filters on the platform, writable, date The order date
description varchar2 Description filters on the platform, writable, description Any description on the order
destinationWarehouse_description varchar2 itgen_vnet_destinationwarehouse_description filters on the platform, writable, destinationWarehouse.description The description
destinationWarehouse_id varchar2 itgen_vnet_destinationwarehouse_id filters on the platform, writable, destinationWarehouse.id The id
lastModified datetime Last Modified filters on the platform, writable, lastModified The date and time the order was last modified
orderId varchar2 itgen_vnet_orderid filters on the platform, writable, orderId The order id for the order
orderQty double Order Quantity filters on the platform, writable, orderQty The total number of items on the order
requestOn datetime Request On filters on the platform, writable, requestOn The date the order is requested
shippingScheduledDate datetime itgen_vnet_shippingscheduleddate filters on the platform, writable, shippingScheduledDate The date shipment is scheduled
status varchar2 Status filters on the platform, writable, status The current status of the order
type varchar2 Type filters on the platform, writable, type The transfer order type code

Release Notes

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