invantive documentation
Invantive Support ForumsLog In / Sign Up

TransferOrderByTypeOrderId: Visma.net Financials itgen_vnet_transferorderbytypeorderid_plural

read only REST

  • Catalog: NgSalesOrders
  • Schema: TransferOrders
  • Label: itgen_vnet_transferorderbytypeorderid_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
orderId `` 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 TransferOrderByTypeOrderId 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.
billing_address_city varchar2 itgen_vnet_billing_address_city filters on the platform, writable, billing.address.city The city
billing_address_country_id varchar2 itgen_vnet_billing_address_country_id filters on the platform, writable, billing.address.country.id The id
billing_address_country_name varchar2 itgen_vnet_billing_address_country_name filters on the platform, writable, billing.address.country.name The name
billing_address_county_id varchar2 itgen_vnet_billing_address_county_id filters on the platform, writable, billing.address.county.id The id
billing_address_county_name varchar2 itgen_vnet_billing_address_county_name filters on the platform, writable, billing.address.county.name The name
billing_address_id int32 itgen_vnet_billing_address_id filters on the platform, writable, billing.address.id The address id
billing_address_line1 varchar2 itgen_vnet_billing_address_line1 filters on the platform, writable, billing.address.line1 Address line 1
billing_address_line2 varchar2 itgen_vnet_billing_address_line2 filters on the platform, writable, billing.address.line2 Address line 2
billing_address_line3 varchar2 itgen_vnet_billing_address_line3 filters on the platform, writable, billing.address.line3 Address line 3
billing_address_overridesDefault char itgen_vnet_billing_address_overridesdefault filters on the platform, writable, billing.address.overridesDefault Whether this address overrides the default address
billing_address_postalCode varchar2 itgen_vnet_billing_address_postalcode filters on the platform, writable, billing.address.postalCode The postal code
billing_contact_attention varchar2 itgen_vnet_billing_contact_attention filters on the platform, writable, billing.contact.attention Any attention for the contact
billing_contact_email varchar2 itgen_vnet_billing_contact_email filters on the platform, writable, billing.contact.email The e-mail address of the contact
billing_contact_fax varchar2 itgen_vnet_billing_contact_fax filters on the platform, writable, billing.contact.fax The fax number of the contact
billing_contact_id int32 itgen_vnet_billing_contact_id filters on the platform, writable, billing.contact.id The id of the contact
billing_contact_name varchar2 itgen_vnet_billing_contact_name filters on the platform, writable, billing.contact.name The name of the contact
billing_contact_overridesDefault char itgen_vnet_billing_contact_overridesdefault filters on the platform, writable, billing.contact.overridesDefault Whether this overrides the default contact
billing_contact_phone1 varchar2 itgen_vnet_billing_contact_phone1 filters on the platform, writable, billing.contact.phone1 The phone number of the contact
billing_contact_phone2 varchar2 itgen_vnet_billing_contact_phone2 filters on the platform, writable, billing.contact.phone2 The secondary phone number of the contact
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
cancelBy datetime Cancel by filters on the platform, writable, cancelBy The cancel date for the order
createdBy varchar2 itgen_vnet_createdby filters on the platform, writable, createdBy 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.
currencyId varchar2 Currency ID filters on the platform, writable, currencyId The currency of the order. Read only.
currencyRate double itgen_vnet_currencyrate filters on the platform, writable, currencyRate The currency rate of the order. Read only.
customFields_customDateTimeUtc1 datetime itgen_vnet_customfields_customdatetimeutc1 filters on the platform, writable, customFields.customDateTimeUtc1 A free custom colum of type DateTime - in UTC timezone
customFields_customDec1 double itgen_vnet_customfields_customdec1 filters on the platform, writable, customFields.customDec1 A free custom colum of type decimal with max 4 decimals.
customFields_customDec2 double itgen_vnet_customfields_customdec2 filters on the platform, writable, customFields.customDec2 A free custom colum of type decimal with max 4 decimals.
customFields_customInt1 int32 itgen_vnet_customfields_customint1 filters on the platform, writable, customFields.customInt1 A free custom colum of type int
customFields_customInt2 int32 itgen_vnet_customfields_customint2 filters on the platform, writable, customFields.customInt2 A free custom colum of type int
customFields_customStr1 varchar2 itgen_vnet_customfields_customstr1 filters on the platform, writable, customFields.customStr1 A free custom colum of type string with max length 100.
customFields_customStr2 varchar2 itgen_vnet_customfields_customstr2 filters on the platform, writable, customFields.customStr2 A free custom colum of type string with max length 100.
customFields_customStr3 varchar2 itgen_vnet_customfields_customstr3 filters on the platform, writable, customFields.customStr3 A free custom colum of type string with max length 100.
customFields_customStr4 varchar2 itgen_vnet_customfields_customstr4 filters on the platform, writable, customFields.customStr4 A free custom colum of type string with max length 100.
customFields_customStr5 varchar2 itgen_vnet_customfields_customstr5 filters on the platform, writable, customFields.customStr5 A free custom colum of type string with max length 100.
date datetime Date filters on the platform, writable, date Date the order was submitted
description varchar2 Description filters on the platform, writable, description Description of 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 Date the order was last modified
note varchar2 Note filters on the platform, writable, note Any notes on the order
orderId varchar2 itgen_vnet_orderid filters on the platform, writable, orderId The unique identifier of the order
orderQty double Order Quantity filters on the platform, writable, orderQty The total quantity of inventory items in the order
owner_id varchar2 Owner ID filters on the platform, writable, owner.id The identifier of the employee
owner_internalId varchar2 Owner Internal ID filters on the platform, writable, owner.internalId The internal unique identifier of the employee
requestOn datetime Request On filters on the platform, writable, requestOn Date the order was requested
shipping_address_city varchar2 itgen_vnet_shipping_address_city filters on the platform, writable, shipping.address.city The city
shipping_address_country_id varchar2 itgen_vnet_shipping_address_country_id filters on the platform, writable, shipping.address.country.id The id
shipping_address_country_name varchar2 itgen_vnet_shipping_address_country_name filters on the platform, writable, shipping.address.country.name The name
shipping_address_county_id varchar2 itgen_vnet_shipping_address_county_id filters on the platform, writable, shipping.address.county.id The id
shipping_address_county_name varchar2 itgen_vnet_shipping_address_county_name filters on the platform, writable, shipping.address.county.name The name
shipping_address_id int32 itgen_vnet_shipping_address_id filters on the platform, writable, shipping.address.id The address id
shipping_address_line1 varchar2 itgen_vnet_shipping_address_line1 filters on the platform, writable, shipping.address.line1 Address line 1
shipping_address_line2 varchar2 itgen_vnet_shipping_address_line2 filters on the platform, writable, shipping.address.line2 Address line 2
shipping_address_line3 varchar2 itgen_vnet_shipping_address_line3 filters on the platform, writable, shipping.address.line3 Address line 3
shipping_address_overridesDefault char itgen_vnet_shipping_address_overridesdefault filters on the platform, writable, shipping.address.overridesDefault Whether this address overrides the default address
shipping_address_postalCode varchar2 itgen_vnet_shipping_address_postalcode filters on the platform, writable, shipping.address.postalCode The postal code
shipping_contact_attention varchar2 itgen_vnet_shipping_contact_attention filters on the platform, writable, shipping.contact.attention Any attention for the contact
shipping_contact_email varchar2 itgen_vnet_shipping_contact_email filters on the platform, writable, shipping.contact.email The e-mail address of the contact
shipping_contact_fax varchar2 itgen_vnet_shipping_contact_fax filters on the platform, writable, shipping.contact.fax The fax number of the contact
shipping_contact_id int32 itgen_vnet_shipping_contact_id filters on the platform, writable, shipping.contact.id The id of the contact
shipping_contact_name varchar2 itgen_vnet_shipping_contact_name filters on the platform, writable, shipping.contact.name The name of the contact
shipping_contact_overridesDefault char itgen_vnet_shipping_contact_overridesdefault filters on the platform, writable, shipping.contact.overridesDefault Whether this overrides the default contact
shipping_contact_phone1 varchar2 itgen_vnet_shipping_contact_phone1 filters on the platform, writable, shipping.contact.phone1 The phone number of the contact
shipping_contact_phone2 varchar2 itgen_vnet_shipping_contact_phone2 filters on the platform, writable, shipping.contact.phone2 The secondary phone number of the contact
shipping_fobPoint_description varchar2 itgen_vnet_shipping_fobpoint_description filters on the platform, writable, shipping.fobPoint.description The description
shipping_fobPoint_id varchar2 itgen_vnet_shipping_fobpoint_id filters on the platform, writable, shipping.fobPoint.id The id
shipping_insurance char itgen_vnet_shipping_insurance filters on the platform, writable, shipping.insurance Whether insurance applies to this shipping
shipping_intrastatTransactionType_description varchar2 itgen_vnet_shipping_intrastattransactiontype_description filters on the platform, writable, shipping.intrastatTransactionType.description The description
shipping_intrastatTransactionType_id int32 itgen_vnet_shipping_intrastattransactiontype_id filters on the platform, writable, shipping.intrastatTransactionType.id The id
shipping_preferredWarehouse_description varchar2 itgen_vnet_shipping_preferredwarehouse_description filters on the platform, writable, shipping.preferredWarehouse.description The description
shipping_preferredWarehouse_id varchar2 itgen_vnet_shipping_preferredwarehouse_id filters on the platform, writable, shipping.preferredWarehouse.id The id
shipping_priority int32 itgen_vnet_shipping_priority filters on the platform, writable, shipping.priority Priority of the order
shipping_residentialDelivery char itgen_vnet_shipping_residentialdelivery filters on the platform, writable, shipping.residentialDelivery Whether this is residential delivery
shipping_rule varchar2 itgen_vnet_shipping_rule filters on the platform, writable, shipping.rule The shipping rule
shipping_saturdayDelivery char itgen_vnet_shipping_saturdaydelivery filters on the platform, writable, shipping.saturdayDelivery Whether this is a saturday delivery
shipping_scheduledDate datetime itgen_vnet_shipping_scheduleddate filters on the platform, writable, shipping.scheduledDate The shipping scheduled date
shipping_shipSeparately char itgen_vnet_shipping_shipseparately filters on the platform, writable, shipping.shipSeparately Whether this order can/is shipped separately
shipping_shipVia_description varchar2 itgen_vnet_shipping_shipvia_description filters on the platform, writable, shipping.shipVia.description The description
shipping_shipVia_id varchar2 itgen_vnet_shipping_shipvia_id filters on the platform, writable, shipping.shipVia.id The id
shipping_terms_description varchar2 itgen_vnet_shipping_terms_description filters on the platform, writable, shipping.terms.description The description
shipping_terms_id varchar2 itgen_vnet_shipping_terms_id filters on the platform, writable, shipping.terms.id The id
shipping_zone_description varchar2 itgen_vnet_shipping_zone_description filters on the platform, writable, shipping.zone.description The description
shipping_zone_id varchar2 itgen_vnet_shipping_zone_id filters on the platform, writable, shipping.zone.id The id
status_cancelled char itgen_vnet_status_cancelled filters on the platform, writable, status.cancelled Whether this order is in a cancelled state
status_description varchar2 itgen_vnet_status_description filters on the platform, writable, status.description The status name for the order
status_hold char itgen_vnet_status_hold filters on the platform, writable, status.hold Whether this order is in a held state
type varchar2 Type filters on the platform, writable, type The transfer order type code, TR or a custom order type derived from it
version blob itgen_vnet_version filters on the platform, writable, version An internal order version used for detecting concurrent updates to an order

Release Notes

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