TransferOrderLineAllocationsByTypeOrderId: Visma.net Financials itgen_vnet_transferorderlineallocationsbytypeorderid_plural
read only REST
- Catalog:
NgSalesOrders - Schema:
TransferOrders - Label: itgen_vnet_transferorderlineallocationsbytypeorderid_plural
Gets information about a single transfer order A transfer order moves goods from the source warehouse of each line to the destination warehouse of the order. The API exposes no customer, prices, discounts or taxes for it. In storage the customer is the business account of the branch that owns the destination warehouse.
Sample request:
GET /transferorders/TR/000100?expand=lines
Can only retrieve data.
Summary
A transfer order moves goods from the source warehouse of each line to the destination warehouse of the order. The API exposes no customer, prices, discounts or taxes for it. In storage the customer is the business account of the branch that owns the destination warehouse.
Sample request:
GET /transferorders/TR/000100?expand=lines
API Source
- Endpoint:
/api/v3/TransferOrders/{type}/{orderId} - Operation:
get /api/v3/TransferOrders/{type}/{orderId}
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 |
|---|---|---|---|---|
order |
`` | The id of the transfer order to get | ||
type |
`` | The transfer order type, TR or a custom order type derived from it |
Table Columns
The columns of the table TransferOrderLineAllocationsByTypeOrderId 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. | |
allocated |
char |
Allocated | writable, allocated |
||
base |
double |
itgen_vnet_baseorderquantity | writable, ::ancestor. |
The base order quantity for this line | |
billing_ |
varchar2 |
itgen_vnet_billing_address_city | filters on the platform, writable, ::ancestor. |
The city | |
billing_ |
varchar2 |
itgen_vnet_billing_address_country_id | filters on the platform, writable, ::ancestor. |
The id | |
billing_ |
varchar2 |
itgen_vnet_billing_address_country_name | filters on the platform, writable, ::ancestor. |
The name | |
billing_ |
varchar2 |
itgen_vnet_billing_address_county_id | filters on the platform, writable, ::ancestor. |
The id | |
billing_ |
varchar2 |
itgen_vnet_billing_address_county_name | filters on the platform, writable, ::ancestor. |
The name | |
billing_ |
int32 |
itgen_vnet_billing_address_id | filters on the platform, writable, ::ancestor. |
The address id | |
billing_ |
varchar2 |
itgen_vnet_billing_address_line1 | filters on the platform, writable, ::ancestor. |
Address line 1 | |
billing_ |
varchar2 |
itgen_vnet_billing_address_line2 | filters on the platform, writable, ::ancestor. |
Address line 2 | |
billing_ |
varchar2 |
itgen_vnet_billing_address_line3 | filters on the platform, writable, ::ancestor. |
Address line 3 | |
billing_ |
char |
itgen_vnet_billing_address_overridesdefault | filters on the platform, writable, ::ancestor. |
Whether this address overrides the default address | |
billing_ |
varchar2 |
itgen_vnet_billing_address_postalcode | filters on the platform, writable, ::ancestor. |
The postal code | |
billing_ |
varchar2 |
itgen_vnet_billing_contact_attention | filters on the platform, writable, ::ancestor. |
Any attention for the contact | |
billing_ |
varchar2 |
itgen_vnet_billing_contact_email | filters on the platform, writable, ::ancestor. |
The e-mail address of the contact | |
billing_ |
varchar2 |
itgen_vnet_billing_contact_fax | filters on the platform, writable, ::ancestor. |
The fax number of the contact | |
billing_ |
int32 |
itgen_vnet_billing_contact_id | filters on the platform, writable, ::ancestor. |
The id of the contact | |
billing_ |
varchar2 |
itgen_vnet_billing_contact_name | filters on the platform, writable, ::ancestor. |
The name of the contact | |
billing_ |
char |
itgen_vnet_billing_contact_overridesdefault | filters on the platform, writable, ::ancestor. |
Whether this overrides the default contact | |
billing_ |
varchar2 |
itgen_vnet_billing_contact_phone1 | filters on the platform, writable, ::ancestor. |
The phone number of the contact | |
billing_ |
varchar2 |
itgen_vnet_billing_contact_phone2 | filters on the platform, writable, ::ancestor. |
The secondary phone number of the contact | |
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 | |
cancel |
datetime |
Cancel by | filters on the platform, writable, ::ancestor. |
The cancel date for the order | |
completed |
char |
Completed | writable, completed |
||
completed_ |
char |
itgen_vnet_completed_2 | writable, ::ancestor. |
Whether the line is completed | |
created |
varchar2 |
itgen_vnet_createdby | filters on the platform, writable, ::ancestor. |
The user name of the creator of the order. If the order was created by an API call this field will be null or empty. | |
currency |
varchar2 |
Currency ID | filters on the platform, writable, ::ancestor. |
The currency of 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, ::ancestor. |
A free custom colum of type DateTime - in UTC timezone | |
custom |
datetime |
itgen_vnet_customfields_customdatetimeutc1_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type DateTime - in UTC timezone | |
custom |
double |
itgen_vnet_customfields_customdec1 | writable, ::ancestor. |
A free custom colum of type decimal with max 4 decimals. | |
custom |
double |
itgen_vnet_customfields_customdec1_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type decimal with max 4 decimals. | |
custom |
double |
itgen_vnet_customfields_customdec2 | writable, ::ancestor. |
A free custom colum of type decimal with max 4 decimals. | |
custom |
double |
itgen_vnet_customfields_customdec2_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type decimal with max 4 decimals. | |
custom |
int32 |
itgen_vnet_customfields_customint1 | writable, ::ancestor. |
A free custom colum of type int | |
custom |
int32 |
itgen_vnet_customfields_customint1_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type int | |
custom |
int32 |
itgen_vnet_customfields_customint2 | writable, ::ancestor. |
A free custom colum of type int | |
custom |
int32 |
itgen_vnet_customfields_customint2_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type int | |
custom |
varchar2 |
itgen_vnet_customfields_customstr1 | writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr1_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr2 | writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr2_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr3 | writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr3_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr4 | writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr4_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr5 | writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customfields_customstr5_2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
date |
datetime |
Date | filters on the platform, writable, ::ancestor. |
Date the order was submitted | |
description |
varchar2 |
Description | writable, ::ancestor. |
The description of the line | |
description_ |
varchar2 |
Description 2 | filters on the platform, writable, ::ancestor. |
Description of 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 | |
expiration |
datetime |
Expiration Date | writable, expiration |
||
external |
varchar2 |
itgen_vnet_externallink | writable, ::ancestor. |
An external link attached to the line | |
inventory |
varchar2 |
itgen_vnet_inventoryalternateid | writable, ::ancestor. |
The alternate id of the inventory item | |
inventory |
varchar2 |
Inventory ID | writable, inventory |
||
inventory_ |
varchar2 |
itgen_vnet_inventory_baseunit | writable, ::ancestor. |
||
inventory_ |
varchar2 |
Inventory Description | writable, ::ancestor. |
The description | |
inventory_ |
varchar2 |
itgen_vnet_inventory_id | writable, ::ancestor. |
The id | |
last |
datetime |
Last Modified | filters on the platform, writable, ::ancestor. |
Date the order was last modified | |
lineId |
int32 |
Line Identifier | writable, ::ancestor. |
The line number of the transfer order line | |
line |
varchar2 |
Line Type | writable, ::ancestor. |
The type of transfer order line. A non-stock item is stored as a miscellaneous line. | |
lot |
varchar2 |
Lot Serial Number | writable, lot |
||
note |
varchar2 |
Note | writable, ::ancestor. |
Any notes on the line | |
note_2 |
varchar2 |
Note 2 | filters on the platform, writable, ::ancestor. |
Any notes on the order | |
open |
double |
itgen_vnet_openquantity | writable, ::ancestor. |
The quantity that is not shipped yet | |
operation |
varchar2 |
Operation | writable, ::ancestor. |
The type of operation the line represents to the order | |
order |
varchar2 |
itgen_vnet_orderid | filters on the platform, writable, ::ancestor. |
The unique identifier of the order | |
order |
double |
Order Quantity | filters on the platform, writable, ::ancestor. |
The total quantity of inventory items in the order | |
overship |
double |
itgen_vnet_overshipthreshold | writable, ::ancestor. |
The overship threshold value (%) | |
owner_ |
varchar2 |
Owner ID | filters on the platform, writable, ::ancestor. |
The identifier of the employee | |
owner_ |
varchar2 |
Owner Internal ID | filters on the platform, writable, ::ancestor. |
The internal unique identifier of the employee | |
purchase |
double |
itgen_vnet_purchaseorderlinequantity | writable, purchase |
||
purchase |
varchar2 |
itgen_vnet_purchaseordernumber | writable, purchase |
||
purchase |
varchar2 |
itgen_vnet_purchaseordersource | writable, ::ancestor. |
The purchase order source of a line marked for purchase order: purchase or drop |
|
purchase |
varchar2 |
itgen_vnet_purchasereceiptnumber | writable, purchase |
||
quantity |
double |
Quantity | writable, quantity |
||
quantity |
double |
itgen_vnet_quantityonshipments | writable, ::ancestor. |
The quantity on shipments | |
quantity_ |
double |
itgen_vnet_quantity_2 | writable, ::ancestor. |
The quantity of unit of measure this line represents | |
reason |
varchar2 |
Reason Code | writable, ::ancestor. |
The reason code of the line | |
received |
double |
itgen_vnet_receivedquantity | writable, received |
||
request |
datetime |
itgen_vnet_requestdate | writable, ::ancestor. |
The date the line is requested | |
request |
datetime |
Request On | filters on the platform, writable, ::ancestor. |
Date the order was requested | |
sales |
varchar2 |
itgen_vnet_salesaccountid | writable, ::ancestor. |
The sales account of the line | |
ship |
datetime |
itgen_vnet_shipdate | writable, ship |
||
ship |
datetime |
itgen_vnet_shipdate_2 | writable, ::ancestor. |
The date the line is scheduled to ship | |
shipment |
varchar2 |
Shipment Number | writable, shipment |
||
shipped |
double |
itgen_vnet_shippedquantity | writable, shipped |
||
shipping |
varchar2 |
itgen_vnet_shippingrule | writable, ::ancestor. |
The shipping rule of the line | |
shipping_ |
varchar2 |
itgen_vnet_shipping_address_city | filters on the platform, writable, ::ancestor. |
The city | |
shipping_ |
varchar2 |
itgen_vnet_shipping_address_country_id | filters on the platform, writable, ::ancestor. |
The id | |
shipping_ |
varchar2 |
itgen_vnet_shipping_address_country_name | filters on the platform, writable, ::ancestor. |
The name | |
shipping_ |
varchar2 |
itgen_vnet_shipping_address_county_id | filters on the platform, writable, ::ancestor. |
The id | |
shipping_ |
varchar2 |
itgen_vnet_shipping_address_county_name | filters on the platform, writable, ::ancestor. |
The name | |
shipping_ |
int32 |
itgen_vnet_shipping_address_id | filters on the platform, writable, ::ancestor. |
The address id | |
shipping_ |
varchar2 |
itgen_vnet_shipping_address_line1 | filters on the platform, writable, ::ancestor. |
Address line 1 | |
shipping_ |
varchar2 |
itgen_vnet_shipping_address_line2 | filters on the platform, writable, ::ancestor. |
Address line 2 | |
shipping_ |
varchar2 |
itgen_vnet_shipping_address_line3 | filters on the platform, writable, ::ancestor. |
Address line 3 | |
shipping_ |
char |
itgen_vnet_shipping_address_overridesdefault | filters on the platform, writable, ::ancestor. |
Whether this address overrides the default address | |
shipping_ |
varchar2 |
itgen_vnet_shipping_address_postalcode | filters on the platform, writable, ::ancestor. |
The postal code | |
shipping_ |
varchar2 |
itgen_vnet_shipping_contact_attention | filters on the platform, writable, ::ancestor. |
Any attention for the contact | |
shipping_ |
varchar2 |
itgen_vnet_shipping_contact_email | filters on the platform, writable, ::ancestor. |
The e-mail address of the contact | |
shipping_ |
varchar2 |
itgen_vnet_shipping_contact_fax | filters on the platform, writable, ::ancestor. |
The fax number of the contact | |
shipping_ |
int32 |
itgen_vnet_shipping_contact_id | filters on the platform, writable, ::ancestor. |
The id of the contact | |
shipping_ |
varchar2 |
itgen_vnet_shipping_contact_name | filters on the platform, writable, ::ancestor. |
The name of the contact | |
shipping_ |
char |
itgen_vnet_shipping_contact_overridesdefault | filters on the platform, writable, ::ancestor. |
Whether this overrides the default contact | |
shipping_ |
varchar2 |
itgen_vnet_shipping_contact_phone1 | filters on the platform, writable, ::ancestor. |
The phone number of the contact | |
shipping_ |
varchar2 |
itgen_vnet_shipping_contact_phone2 | filters on the platform, writable, ::ancestor. |
The secondary phone number of the contact | |
shipping_ |
varchar2 |
itgen_vnet_shipping_fobpoint_description | filters on the platform, writable, ::ancestor. |
The description | |
shipping_ |
varchar2 |
itgen_vnet_shipping_fobpoint_id | filters on the platform, writable, ::ancestor. |
The id | |
shipping_ |
char |
itgen_vnet_shipping_insurance | filters on the platform, writable, ::ancestor. |
Whether insurance applies to this shipping | |
shipping_ |
varchar2 |
itgen_vnet_shipping_intrastattransactiontype_description | filters on the platform, writable, ::ancestor. |
The description | |
shipping_ |
int32 |
itgen_vnet_shipping_intrastattransactiontype_id | filters on the platform, writable, ::ancestor. |
The id | |
shipping_ |
varchar2 |
itgen_vnet_shipping_preferredwarehouse_description | filters on the platform, writable, ::ancestor. |
The description | |
shipping_ |
varchar2 |
itgen_vnet_shipping_preferredwarehouse_id | filters on the platform, writable, ::ancestor. |
The id | |
shipping_ |
int32 |
itgen_vnet_shipping_priority | filters on the platform, writable, ::ancestor. |
Priority of the order | |
shipping_ |
char |
itgen_vnet_shipping_residentialdelivery | filters on the platform, writable, ::ancestor. |
Whether this is residential delivery | |
shipping_ |
varchar2 |
itgen_vnet_shipping_rule | filters on the platform, writable, ::ancestor. |
The shipping rule | |
shipping_ |
char |
itgen_vnet_shipping_saturdaydelivery | filters on the platform, writable, ::ancestor. |
Whether this is a saturday delivery | |
shipping_ |
datetime |
itgen_vnet_shipping_scheduleddate | filters on the platform, writable, ::ancestor. |
The shipping scheduled date | |
shipping_ |
char |
itgen_vnet_shipping_shipseparately | filters on the platform, writable, ::ancestor. |
Whether this order can/is shipped separately | |
shipping_ |
varchar2 |
itgen_vnet_shipping_shipvia_description | filters on the platform, writable, ::ancestor. |
The description | |
shipping_ |
varchar2 |
itgen_vnet_shipping_shipvia_id | filters on the platform, writable, ::ancestor. |
The id | |
shipping_ |
varchar2 |
itgen_vnet_shipping_terms_description | filters on the platform, writable, ::ancestor. |
The description | |
shipping_ |
varchar2 |
itgen_vnet_shipping_terms_id | filters on the platform, writable, ::ancestor. |
The id | |
shipping_ |
varchar2 |
itgen_vnet_shipping_zone_description | filters on the platform, writable, ::ancestor. |
The description | |
shipping_ |
varchar2 |
itgen_vnet_shipping_zone_id | filters on the platform, writable, ::ancestor. |
The id | |
sort |
int32 |
itgen_vnet_sortorder | writable, ::ancestor. |
Used to apply sort order to a set of lines | |
split |
int32 |
itgen_vnet_splitlinenumber | writable, split |
||
status_ |
char |
itgen_vnet_status_cancelled | filters on the platform, writable, ::ancestor. |
Whether this order is in a cancelled state | |
status_ |
varchar2 |
itgen_vnet_status_description | filters on the platform, writable, ::ancestor. |
The status name for the order | |
status_ |
char |
itgen_vnet_status_hold | filters on the platform, writable, ::ancestor. |
Whether this order is in a held state | |
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, ::ancestor. |
The currency of the supplier selected for the order line | |
supplier_ |
varchar2 |
itgen_vnet_supplier_id | writable, ::ancestor. |
The id of the supplier selected for the order line | |
supplier_ |
varchar2 |
Supplier Name | writable, ::ancestor. |
The name of the supplier selected for the order line | |
supplier_ |
double |
itgen_vnet_supplier_price | writable, ::ancestor. |
The supplier price of the supplier selected for the order line | |
supplier_ |
varchar2 |
itgen_vnet_supplier_unitofmeasure | writable, ::ancestor. |
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, TR or a custom order type derived from it |
|
undership |
double |
itgen_vnet_undershipthreshold | writable, ::ancestor. |
The undership threshold value (%) | |
unit |
varchar2 |
itgen_vnet_unitofmeasure | writable, unit |
||
unit |
varchar2 |
itgen_vnet_unitofmeasure_2 | writable, ::ancestor. |
The unit of measure (UOM) for the transfer order line | |
version |
blob |
itgen_vnet_version | filters on the platform, writable, ::ancestor. |
An internal order version used for detecting concurrent updates to an order | |
warehouse |
varchar2 |
Warehouse ID | writable, ::ancestor. |
The source warehouse the goods are transferred from | |
warehouse |
varchar2 |
itgen_vnet_warehouselocation_description | writable, ::ancestor. |
The description | |
warehouse |
varchar2 |
itgen_vnet_warehouselocation_id | writable, ::ancestor. |
The id |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: