invantive documentation
Invantive Support ForumsLog In / Sign Up

PurchaseReceiptV2Transfers_LinesAllocations: Visma.net Financials itgen_vnet_purchasereceiptv2transfers_linesallocations_plural

read only REST

  • Catalog: VismaNet
  • Schema: PurchaseReceiptV2
  • Label: itgen_vnet_purchasereceiptv2transfers_linesallocations_plural

Get the transfer orders and shipments that can be received as a Transfer Receipt - ScreenId=PO302000, Add Transfer. One candidate is one transfer order within one confirmed shipment with stock still in transit; the same order can be listed with several shipments. Set expandLines=true to include the lines PO302000 would add, with remaining quantities, lot/serial allocations, line description and note (default false); add includeCustomFreeFields=true to read the custom free fields of the transfer order line and of its shipment line onto each line. Availability is a snapshot.

Can only retrieve data.

API Source

  • Endpoint: /v2/PurchaseReceipt/transfers
  • Operation: get /v2/PurchaseReceipt/transfers

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
expandLines `` Include the lines PO302000 would add for each candidate, with remaining quantities and lot/serial allocations. Default false: only headers are returned and the lines property is omitted.
fromWarehouse `` Exact code of the shipping warehouse (the transfer order's source warehouse).
includeCustomFreeFields `` Include the custom free fields of the transfer order line (salesOrderLineCustomStr1..5, salesOrderLineCustomDec1..2, salesOrderLineCustomInt1..2, salesOrderLineCustomDateTimeUTC1) and of its shipment line (shipmentLineCustomStr1..5, shipmentLineCustomDec1..2, shipmentLineCustomInt1..2, shipmentLineCustomDateTimeUTC1) on each expanded line. Default false. Only meaningful together with expandLines=true.
orderNbr `` Exact transfer order number.
orderType `` Transfer order type. Candidates always originate from transfer-behaviour order types, for example TransferOrder. (Values: CreditNote, DebitNote, Invoice, QuoteOrder, RMAOrder, SalesOrder, StandardOrder, TransferOrder)
shipmentNbr `` Exact shipment number. One order can be listed with several shipments; this narrows the result to one of them.
toWarehouse `` Exact code of the receiving warehouse (the warehouse of the Transfer Receipt to create).

Table Columns

The columns of the table PurchaseReceiptV2Transfers_LinesAllocations 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.
baseQuantity double itgen_vnet_basequantity writable, ::ancestor.baseQuantity Remaining receivable quantity in the inventory item's base UOM.
date datetime Date filters on the platform, writable, ::ancestor.::ancestor.date Date of the inventory transfer.
description varchar2 Description writable, ::ancestor.description Description of the source transfer line; PO302000 copies it onto the receipt line (transactionDescription on create).
description_2 varchar2 Description 2 filters on the platform, writable, ::ancestor.::ancestor.description Description of the inventory transfer.
errorInfo varchar2 Error Message filters on the platform, writable, ::ancestor.::ancestor.errorInfo
expirationDate datetime Expiration Date writable, expirationDate Expiration date of the lot/serial: the source transfer line date when it has one, otherwise the item lot date; omitted when neither applies.
fromWarehouse_description varchar2 itgen_vnet_fromwarehouse_description filters on the platform, writable, ::ancestor.::ancestor.fromWarehouse.description Click on the magnifier. > The description.
fromWarehouse_id varchar2 itgen_vnet_fromwarehouse_id filters on the platform, writable, ::ancestor.::ancestor.fromWarehouse.id Click on the magnifier. > The identifier.
inventoryItem_description varchar2 itgen_vnet_inventoryitem_description writable, ::ancestor.inventoryItem.description Name of item/description
inventoryItem_number varchar2 itgen_vnet_inventoryitem_number writable, ::ancestor.inventoryItem.number Number of item
location_countryId varchar2 Location Country ID writable, location.countryId Location*.
location_countryId_2 varchar2 Location Country ID 2 writable, ::ancestor.location.countryId Location*.
location_id varchar2 Location ID writable, location.id Click the magnifier > The identifier
location_id_2 varchar2 Location ID 2 writable, ::ancestor.location.id Click the magnifier > The identifier
location_name varchar2 Location Name writable, location.name Click the magnifier > The displayed name
location_name_2 varchar2 Location Name 2 writable, ::ancestor.location.name Click the magnifier > The displayed name
lotSerialNumber varchar2 Lot Serial Number writable, lotSerialNumber Lot/serial number of the allocated stock; omitted for items without lot/serial tracking.
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, ::ancestor.::ancestor.metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, ::ancestor.::ancestor.metadata.totalCount
note varchar2 Note writable, ::ancestor.note Note of the source transfer line; omitted when the line has none. PO302000 does not copy it onto the receipt line.
orderLineNbr int32 itgen_vnet_orderlinenbr writable, ::ancestor.orderLineNbr Transfer order line number; use it as transferOrderLineNbr when creating the receipt line.
orderNbr varchar2 Order Number filters on the platform, writable, ::ancestor.::ancestor.orderNbr Transfer order number; use it as transferOrderNbr when creating the receipt line.
orderType varchar2 Order Type filters on the platform, writable, ::ancestor.::ancestor.orderType Transfer order type; use it as transferOrderType when creating the receipt line.
quantity double Quantity writable, quantity Remaining receivable quantity of this allocation, in the inventory item's base UOM.
quantity_2 double itgen_vnet_quantity_2 writable, ::ancestor.quantity Remaining receivable quantity in the source line UOM.
salesOrderLineCustomDateTimeUTC1 datetime itgen_vnet_salesorderlinecustomdatetimeutc1 writable, ::ancestor.salesOrderLineCustomDateTimeUTC1 A free custom column of type DateTime - in UTC timezone. Read from the transfer order line; present only with includeCustomFreeFields=true.
salesOrderLineCustomDec1 double itgen_vnet_salesorderlinecustomdec1 writable, ::ancestor.salesOrderLineCustomDec1 A free custom column of type decimal with max 4 decimals. Read from the transfer order line; present only with includeCustomFreeFields=true.
salesOrderLineCustomDec2 double itgen_vnet_salesorderlinecustomdec2 writable, ::ancestor.salesOrderLineCustomDec2 A free custom column of type decimal with max 4 decimals. Read from the transfer order line; present only with includeCustomFreeFields=true.
salesOrderLineCustomInt1 int32 itgen_vnet_salesorderlinecustomint1 writable, ::ancestor.salesOrderLineCustomInt1 A free custom column of type int. Read from the transfer order line; present only with includeCustomFreeFields=true.
salesOrderLineCustomInt2 int32 itgen_vnet_salesorderlinecustomint2 writable, ::ancestor.salesOrderLineCustomInt2 A free custom column of type int. Read from the transfer order line; present only with includeCustomFreeFields=true.
salesOrderLineCustomStr1 varchar2 itgen_vnet_salesorderlinecustomstr1 writable, ::ancestor.salesOrderLineCustomStr1 A free custom column of type string with max length 100. Read from the transfer order line; present only with includeCustomFreeFields=true.
salesOrderLineCustomStr2 varchar2 itgen_vnet_salesorderlinecustomstr2 writable, ::ancestor.salesOrderLineCustomStr2 A free custom column of type string with max length 100. Read from the transfer order line; present only with includeCustomFreeFields=true.
salesOrderLineCustomStr3 varchar2 itgen_vnet_salesorderlinecustomstr3 writable, ::ancestor.salesOrderLineCustomStr3 A free custom column of type string with max length 100. Read from the transfer order line; present only with includeCustomFreeFields=true.
salesOrderLineCustomStr4 varchar2 itgen_vnet_salesorderlinecustomstr4 writable, ::ancestor.salesOrderLineCustomStr4 A free custom column of type string with max length 100. Read from the transfer order line; present only with includeCustomFreeFields=true.
salesOrderLineCustomStr5 varchar2 itgen_vnet_salesorderlinecustomstr5 writable, ::ancestor.salesOrderLineCustomStr5 A free custom column of type string with max length 100. Read from the transfer order line; present only with includeCustomFreeFields=true.
shipmentLineCustomDateTimeUTC1 datetime itgen_vnet_shipmentlinecustomdatetimeutc1 writable, ::ancestor.shipmentLineCustomDateTimeUTC1 A free custom column of type DateTime - in UTC timezone. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineCustomDec1 double itgen_vnet_shipmentlinecustomdec1 writable, ::ancestor.shipmentLineCustomDec1 A free custom column of type decimal with max 4 decimals. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineCustomDec2 double itgen_vnet_shipmentlinecustomdec2 writable, ::ancestor.shipmentLineCustomDec2 A free custom column of type decimal with max 4 decimals. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineCustomInt1 int32 itgen_vnet_shipmentlinecustomint1 writable, ::ancestor.shipmentLineCustomInt1 A free custom column of type int. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineCustomInt2 int32 itgen_vnet_shipmentlinecustomint2 writable, ::ancestor.shipmentLineCustomInt2 A free custom column of type int. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineCustomStr1 varchar2 itgen_vnet_shipmentlinecustomstr1 writable, ::ancestor.shipmentLineCustomStr1 A free custom column of type string with max length 100. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineCustomStr2 varchar2 itgen_vnet_shipmentlinecustomstr2 writable, ::ancestor.shipmentLineCustomStr2 A free custom column of type string with max length 100. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineCustomStr3 varchar2 itgen_vnet_shipmentlinecustomstr3 writable, ::ancestor.shipmentLineCustomStr3 A free custom column of type string with max length 100. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineCustomStr4 varchar2 itgen_vnet_shipmentlinecustomstr4 writable, ::ancestor.shipmentLineCustomStr4 A free custom column of type string with max length 100. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineCustomStr5 varchar2 itgen_vnet_shipmentlinecustomstr5 writable, ::ancestor.shipmentLineCustomStr5 A free custom column of type string with max length 100. Read from the shipment line of the transfer order; present only with includeCustomFreeFields=true.
shipmentLineNbr int32 itgen_vnet_shipmentlinenbr writable, ::ancestor.shipmentLineNbr Shipment line number.
shipmentNbr varchar2 itgen_vnet_shipmentnbr filters on the platform, writable, ::ancestor.::ancestor.shipmentNbr Confirmed shipment number that moved the stock into transit.
subitem varchar2 itgen_vnet_subitem writable, subitem Subitem code of the allocated stock; omitted when the item has no subitems.
subitem_2 varchar2 itgen_vnet_subitem_2 writable, ::ancestor.subitem Subitem code when all allocations share one subitem; otherwise omitted.
toWarehouse_description varchar2 To Warehouse Description filters on the platform, writable, ::ancestor.::ancestor.toWarehouse.description Click on the magnifier. > The description.
toWarehouse_id varchar2 To Warehouse ID filters on the platform, writable, ::ancestor.::ancestor.toWarehouse.id Click on the magnifier. > The identifier.
transferLineNbr int32 itgen_vnet_transferlinenbr writable, ::ancestor.transferLineNbr Line number on the inventory transfer, not a receipt line number.
transferNbr varchar2 itgen_vnet_transfernbr writable, ::ancestor.transferNbr Reference number of the inventory transfer holding the transit stock.
transferNbr_2 varchar2 itgen_vnet_transfernbr_2 filters on the platform, writable, ::ancestor.::ancestor.transferNbr Reference number of the released inventory transfer created by the shipment.
uom varchar2 Unit of Measure writable, uom Inventory base UOM, as used by receipt allocations.
uom_2 varchar2 itgen_vnet_uom_2 writable, ::ancestor.uom Unit of measure of the source transfer line.
warehouse_description varchar2 Warehouse Description writable, ::ancestor.warehouse.description Click on the magnifier. > The description.
warehouse_id varchar2 Warehouse ID writable, ::ancestor.warehouse.id Click on the magnifier. > The identifier.

Release Notes

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