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 |
|---|---|---|---|---|
destination |
`` | The destination warehouse for which to retrieve orders. If omitted or empty, orders for all destination warehouses are included. | ||
modified |
`` | 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_ |
varchar2 |
Company Code | writable | Partition code, segmenting the data. | |
COMPANY_ |
varchar2 |
Company Name | writable | Name of the partition. | |
base |
double |
itgen_vnet_baseorderquantity | writable, base |
The base order quantity for this line | |
branch_ |
varchar2 |
itgen_vnet_branch_description | filters on the platform, writable, ::ancestor. |
The description | |
branch_ |
varchar2 |
itgen_vnet_branch_id | filters on the platform, writable, ::ancestor. |
The id | |
c_ |
varchar2 |
itgen_vnet_c_links | writable | Links applicable for the dto The JSON text of the nested object. | |
cancel |
datetime |
Cancel by | filters on the platform, writable, ::ancestor. |
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. |
The currency id for the order. Read only. | |
currency |
double |
itgen_vnet_currencyrate | filters on the platform, writable, ::ancestor. |
The currency rate of the order. Read only. | |
custom |
datetime |
itgen_vnet_customfields_customdatetimeutc1 | writable, custom |
A free custom colum of type DateTime - in UTC timezone | |
custom |
double |
itgen_vnet_customfields_customdec1 | writable, custom |
A free custom colum of type decimal with max 4 decimals. | |
custom |
double |
itgen_vnet_customfields_customdec2 | writable, custom |
A free custom colum of type decimal with max 4 decimals. | |
custom |
int32 |
itgen_vnet_customfields_customint1 | writable, custom |
A free custom colum of type int | |
custom |
int32 |
itgen_vnet_customfields_customint2 | writable, custom |
A free custom colum of type int | |
custom |
varchar2 |
itgen_vnet_customfields_customstr1 | writable, custom |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr2 | writable, custom |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr3 | writable, custom |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr4 | writable, custom |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr5 | writable, custom |
A free custom colum of type string with max length 100. | |
date |
datetime |
Date | filters on the platform, writable, ::ancestor. |
The order date | |
description |
varchar2 |
Description | writable, description |
The description of the line | |
description_ |
varchar2 |
Description 2 | filters on the platform, writable, ::ancestor. |
Any description on the order | |
destination |
varchar2 |
itgen_vnet_destinationwarehouse_description | filters on the platform, writable, ::ancestor. |
The description | |
destination |
varchar2 |
itgen_vnet_destinationwarehouse_id | filters on the platform, writable, ::ancestor. |
The id | |
external |
varchar2 |
itgen_vnet_externallink | writable, external |
An external link attached to the line | |
inventory |
varchar2 |
itgen_vnet_inventoryalternateid | writable, inventory |
The alternate id of the inventory item | |
inventory_ |
varchar2 |
itgen_vnet_inventory_baseunit | writable, inventory. |
||
inventory_ |
varchar2 |
Inventory Description | writable, inventory. |
The description | |
inventory_ |
varchar2 |
itgen_vnet_inventory_id | writable, inventory. |
The id | |
last |
datetime |
Last Modified | filters on the platform, writable, ::ancestor. |
The date and time the order was last modified | |
lineId |
int32 |
Line Identifier | writable, lineId |
The line number of the transfer order line | |
line |
varchar2 |
Line Type | writable, line |
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 | |
open |
double |
itgen_vnet_openquantity | writable, open |
The quantity that is not shipped yet | |
operation |
varchar2 |
Operation | writable, operation |
The type of operation the line represents to the order | |
order |
varchar2 |
itgen_vnet_orderid | filters on the platform, writable, ::ancestor. |
The order id for the order | |
order |
double |
Order Quantity | filters on the platform, writable, ::ancestor. |
The total number of items on the order | |
overship |
double |
itgen_vnet_overshipthreshold | writable, overship |
The overship threshold value (%) | |
purchase |
varchar2 |
itgen_vnet_purchaseordersource | writable, purchase |
The purchase order source of a line marked for purchase order: purchase or drop |
|
quantity |
double |
Quantity | writable, quantity |
The quantity of unit of measure this line represents | |
quantity |
double |
itgen_vnet_quantityonshipments | writable, quantity |
The quantity on shipments | |
reason |
varchar2 |
Reason Code | writable, reason |
The reason code of the line | |
request |
datetime |
itgen_vnet_requestdate | writable, request |
The date the line is requested | |
request |
datetime |
Request On | filters on the platform, writable, ::ancestor. |
The date the order is requested | |
sales |
varchar2 |
itgen_vnet_salesaccountid | writable, sales |
The sales account of the line | |
ship |
datetime |
itgen_vnet_shipdate | writable, ship |
The date the line is scheduled to ship | |
shipping |
varchar2 |
itgen_vnet_shippingrule | writable, shipping |
The shipping rule of the line | |
shipping |
datetime |
itgen_vnet_shippingscheduleddate | filters on the platform, writable, ::ancestor. |
The date shipment is scheduled | |
sort |
int32 |
itgen_vnet_sortorder | writable, sort |
Used to apply sort order to a set of lines | |
status |
varchar2 |
Status | filters on the platform, writable, ::ancestor. |
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_ |
varchar2 |
itgen_vnet_supplier_currencyid | writable, supplier. |
The currency of the supplier selected for the order line | |
supplier_ |
varchar2 |
itgen_vnet_supplier_id | writable, supplier. |
The id of the supplier selected for the order line | |
supplier_ |
varchar2 |
Supplier Name | writable, supplier. |
The name of the supplier selected for the order line | |
supplier_ |
double |
itgen_vnet_supplier_price | writable, supplier. |
The supplier price of the supplier selected for the order line | |
supplier_ |
varchar2 |
itgen_vnet_supplier_unitofmeasure | writable, supplier. |
The unit of measure used by the supplier for this line | |
type |
varchar2 |
Type | filters on the platform, writable, ::ancestor. |
The transfer order type code | |
undership |
double |
itgen_vnet_undershipthreshold | writable, undership |
The undership threshold value (%) | |
unit |
varchar2 |
itgen_vnet_unitofmeasure | writable, unit |
The unit of measure (UOM) for the transfer order line | |
warehouse |
varchar2 |
Warehouse ID | writable, warehouse |
The source warehouse the goods are transferred from | |
warehouse |
varchar2 |
itgen_vnet_warehouselocation_description | writable, warehouse |
The description | |
warehouse |
varchar2 |
itgen_vnet_warehouselocation_id | writable, warehouse |
The id |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: