invantive documentation
Invantive Support ForumsLog In / Sign Up

BasicPurchaseOrderLines: Visma.net Financials Basic Purchase Order Lines

read only REST

  • Catalog: VismaNet
  • Schema: PurchaseOrderBasic
  • Label: Basic Purchase Order Lines

Get a range of Purchase Order - ScreenId=PO301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size

Can only retrieve data.

API Source

  • Endpoint: /v1/purchaseorderbasic
  • Operation: get /v1/purchaseorderbasic

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
branch `` Filter on Branch
deliveryDate `` This value indicates the date the document is due for delivery. Use it to retrieve all records that have the delivery date since that time, up to the future. Accepted format: * yyyy-MM-dd * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd HH:mm:ss.FFF * yyyy-MM-ddTHH:mm:ss * yyyy-MM-ddTHH:mm:ss.FFF Note: DeliveryDate and DeliveryDateCondition are mutually inclusive.
deliveryDateCondition `` This value represents the condition to be applied to the Due Date when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: DeliveryDate and DeliveryDateCondition are mutually inclusive.
greaterThanValue `` Filter on order no. and forward
includeCustomFreeFields `` Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set
lastModifiedDateTime `` This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present. Accepted format: * yyyy-MM-dd * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd HH:mm:ss.FFF * yyyy-MM-ddTHH:mm:ss * yyyy-MM-ddTHH:mm:ss.FFF Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive.
lastModifiedDateTimeCondition `` This value represents the condition to be applied when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive.
orderDate `` This value indicates the order date. Use it to retrieve all records that have the order date since that time, up to the future. Accepted format: * yyyy-MM-dd * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd HH:mm:ss.FFF * yyyy-MM-ddTHH:mm:ss * yyyy-MM-ddTHH:mm:ss.FFF Note: OrderDate and OrderDateCondition are mutually inclusive.
orderDateCondition `` This value represents the condition to be applied to the order date when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: OrderDate and OrderDateCondition are mutually inclusive.
orderStatus `` Select and filter on Status. (Values: Balanced, Cancelled, Closed, Hold, Open, PendingEmail, PendingPrint, Printed, Voided)
orderType `` Select and filter on Type. (Values: RegularOrder, DropShip, Blanket, StandardBlanket)
supplier `` Filter on Supplier.

Table Columns

The columns of the table BasicPurchaseOrderLines 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.
account_description varchar2 Account Description writable, account.description Name of item/description
account_number varchar2 Account Number writable, account.number Number of item
account_type varchar2 Account Type writable, account.type
alternateId varchar2 Alternate ID writable, alternateId Alternate ID > The alternate ID used for this stock item-subitem pair by the supplier.
amount double Amount writable, amount Amount > The amount calculated (after the discount has been taken) for the item.
baseOrderQty double itgen_vnet_baseorderqty writable, baseOrderQty Base Order qty. > The base quantity of the item that has been ordered.
branch_name varchar2 Branch Name writable, branch.name Click the magnifier. > The name.
branch_name_2 varchar2 Branch Name 2 filters on the platform, writable, ::ancestor.branch.name Click the magnifier. > The name.
branch_number varchar2 Branch Number writable, branch.number Click the magnifier. > The identifier.
branch_number_2 varchar2 Branch Number 2 filters on the platform, writable, ::ancestor.branch.number Click the magnifier. > The identifier.
canceled char Canceled writable, canceled Cancelled > A check box that indicates (if selected) that this line of the purchase order has been cancelled.
completeOn double itgen_vnet_completeon writable, completeOn Complete on (%) > The minimum percentage of the ordered quantity for the stock item that must be received to complete the purchase order line (gets the default value from the Threshold receipt (%) setting of the supplier in the (AP303000) window).
completed char Completed writable, completed Completed > A check box that indicates (if selected) that the purchasing of the item requested by this line of the purchase order has been completed.
controlTotal double Total for Control filters on the platform, writable, ::ancestor.controlTotal The top part > Control total > The order's total amount (including VAT), which you must enter manually when you attempt to save the order with the Balanced status.
controlTotalInBaseCurrency double itgen_vnet_controltotalinbasecurrency filters on the platform, writable, ::ancestor.controlTotalInBaseCurrency The top part > View base > A button that recalculates the Control total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.
currency varchar2 Currency filters on the platform, writable, ::ancestor.currency The top part > Currency > The currency the purchase order will be paid in.
customDateTimeUTC1 datetime itgen_vnet_customdatetimeutc1 writable, customDateTimeUTC1 A free custom colum of type DateTime - in UTC timezone
customDateTimeUTC1_2 datetime itgen_vnet_customdatetimeutc1_2 filters on the platform, writable, ::ancestor.customDateTimeUTC1 A free custom colum of type DateTime - in UTC timezone
customDec1 double itgen_vnet_customdec1 writable, customDec1 A free custom colum of type decimal with max 4 decimals.
customDec1_2 double itgen_vnet_customdec1_2 filters on the platform, writable, ::ancestor.customDec1 A free custom colum of type decimal with max 4 decimals.
customDec2 double itgen_vnet_customdec2 writable, customDec2 A free custom colum of type decimal with max 4 decimals.
customDec2_2 double itgen_vnet_customdec2_2 filters on the platform, writable, ::ancestor.customDec2 A free custom colum of type decimal with max 4 decimals.
customInt1 int32 itgen_vnet_customint1 writable, customInt1 A free custom colum of type int
customInt1_2 int32 itgen_vnet_customint1_2 filters on the platform, writable, ::ancestor.customInt1 A free custom colum of type int
customInt2 int32 itgen_vnet_customint2 writable, customInt2 A free custom colum of type int
customInt2_2 int32 itgen_vnet_customint2_2 filters on the platform, writable, ::ancestor.customInt2 A free custom colum of type int
customStr1 varchar2 itgen_vnet_customstr1 writable, customStr1 A free custom colum of type string with max length 100.
customStr1_2 varchar2 itgen_vnet_customstr1_2 filters on the platform, writable, ::ancestor.customStr1 A free custom colum of type string with max length 100.
customStr2 varchar2 itgen_vnet_customstr2 writable, customStr2 A free custom colum of type string with max length 100.
customStr2_2 varchar2 itgen_vnet_customstr2_2 filters on the platform, writable, ::ancestor.customStr2 A free custom colum of type string with max length 100.
customStr3 varchar2 itgen_vnet_customstr3 writable, customStr3 A free custom colum of type string with max length 100.
customStr3_2 varchar2 itgen_vnet_customstr3_2 filters on the platform, writable, ::ancestor.customStr3 A free custom colum of type string with max length 100.
customStr4 varchar2 itgen_vnet_customstr4 writable, customStr4 A free custom colum of type string with max length 100.
customStr4_2 varchar2 itgen_vnet_customstr4_2 filters on the platform, writable, ::ancestor.customStr4 A free custom colum of type string with max length 100.
customStr5 varchar2 itgen_vnet_customstr5 writable, customStr5 A free custom colum of type string with max length 100.
customStr5_2 varchar2 itgen_vnet_customstr5_2 filters on the platform, writable, ::ancestor.customStr5 A free custom colum of type string with max length 100.
date datetime Date filters on the platform, writable, ::ancestor.date Mandatory field: The top part > Date* > The date when the purchase order was created.
description varchar2 Description filters on the platform, writable, ::ancestor.description The top part > Description > A brief description of the purchase order.
discountAmount double itgen_vnet_discountamount writable, discountAmount Discount amount > If the Supplier customer discounts functionality is enabled in the Enable/disable functionalities (CS100000) window, the amount of the discount that has been specified manually or calculated based on the discount percent entered manually.
discountCode_description varchar2 Discount Code Description writable, discountCode.description Name of item/description
discountCode_number varchar2 Discount Code Number writable, discountCode.number Number of item
discountPercent double Discount Percent writable, discountPercent Discount percent > If the Supplier customer discounts functionality is enabled in the Enable/disable functionalities (CS100000) window, the percent of the discount that has been entered manually or calculated based on the discount amount entered manually for this line item.
discountUnitCost double itgen_vnet_discountunitcost writable, discountUnitCost Disc. unit cost > The unit cost of the item after the line discount has been applied.
errorInfo varchar2 Error Message filters on the platform, writable, ::ancestor.errorInfo
exchangeRate double Exchange Rate filters on the platform, writable, ::ancestor.exchangeRate
extCost double Extended Cost writable, extCost Ext. cost > The extended cost of the item, which is the unit cost multiplied by the quantity.
hold char Hold filters on the platform, writable, ::ancestor.hold The top part > Hold > A check box that you select to give the purchase order the On hold status.
inventory_description varchar2 Inventory Description writable, inventory.description Name of item/description
inventory_number varchar2 Inventory Number writable, inventory.number Number of item
lastModifiedDateTime datetime Last Modified filters on the platform, writable, ::ancestor.lastModifiedDateTime System generated information.
lineDescription varchar2 Line Description writable, lineDescription A description of the order line, which is copied from the item's description.
lineNbr int32 itgen_vnet_linenbr writable, lineNbr The line number
lineTotal double Line Total filters on the platform, writable, ::ancestor.lineTotal The top part > Line total > The total sum of the Extended amount entries for all lines in the current purchase order. This value is calculated by the system and users cannot manually change it.
lineTotalInBaseCurrency double itgen_vnet_linetotalinbasecurrency filters on the platform, writable, ::ancestor.lineTotalInBaseCurrency The top part > View base > A button that recalculates the Line total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.
lineType varchar2 Line Type writable, lineType Line type > The type of the order line, which can be one of the following options: Goods for inventory, Non-stock, Service, Freight, Good for sales order, Non-stock for drop-ship, Drop-ship, Goods for RP, Description.
location_id int32 Location ID filters on the platform, writable, ::ancestor.location.id Click the magnifier > The identifier
location_name varchar2 Location Name filters on the platform, writable, ::ancestor.location.name Click the magnifier > The displayed name
manualDiscount char Manual Discount writable, manualDiscount Manual discount > A check box that indicates (if selected) that the discount has been applied manually.
maxReceipt double itgen_vnet_maxreceipt writable, maxReceipt Max. receipt (%) > The maximum quantity of the item, expressed as a percentage of the ordered quantity, that is required for the item to be accepted at the warehouse if the Receipt action is Rejected.
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, ::ancestor.metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, ::ancestor.metadata.totalCount
minReceipt double itgen_vnet_minreceipt writable, minReceipt Min. receipt (%) > The minimum quantity of the item, expressed as a percentage of the ordered quantity, that is required for the item to be accepted at the warehouse if the Receipt action is Rejected.
note varchar2 Note writable, note Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order.
note_2 varchar2 Note 2 filters on the platform, writable, ::ancestor.note Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document.
orderNbr varchar2 Order Number filters on the platform, writable, ::ancestor.orderNbr The top part > Order no. > The unique reference number of the purchase order, which the system assigns based on the number series assigned to purchase orders of this type, as specified in the PO101000 window.
orderNumber varchar2 Order Number writable, orderNumber Order no. > The reference number of the blanket or standard order (for normal orders based on blanket or standard orders).
orderQty double Order Quantity writable, orderQty Order qty. > The quantity of the item that has been ordered.
orderTotal double Order Total filters on the platform, writable, ::ancestor.orderTotal The Top part > Order total > The total sum for the purchase order, including VAT. This read-only value is the sum of the Line total and VAT total values.
orderTotalInBaseCurrency double itgen_vnet_ordertotalinbasecurrency filters on the platform, writable, ::ancestor.orderTotalInBaseCurrency The top part > View base > A button that recalculates the Order total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.
orderType varchar2 Order Type writable, orderType Order type > The order type this order is related to (for normal orders based on blanket or standard orders).
orderType_2 varchar2 itgen_vnet_ordertype_2 filters on the platform, writable, ::ancestor.orderType The top part > Type > The type of the purchase order, which can be one of these options: Normal, Drop-ship, Blanket, Default
owner_id guid Owner ID filters on the platform, writable, ::ancestor.owner.id Click the magnifier > The identifier
owner_name varchar2 Owner Name filters on the platform, writable, ::ancestor.owner.name Click the magnifier > The displayed name
projectTask_description varchar2 Project Task Description writable, projectTask.description Click on the magnifier. > The description.
projectTask_id varchar2 Project Task ID writable, projectTask.id Click on the magnifier. > The identifier.
projectTask_internalId int32 itgen_vnet_projecttask_internalid writable, projectTask.internalId The internal identifier.
project_description varchar2 Project Description writable, project.description Click on the magnifier. > The description.
project_id varchar2 Project ID writable, project.id Click on the magnifier. > The identifier.
project_internalId int32 itgen_vnet_project_internalid writable, project.internalId The internal identifier.
promised datetime Promised writable, promised Promised > The date when the item's deliver was promised.
promisedOn datetime Promised on filters on the platform, writable, ::ancestor.promisedOn The top part > Delivery date > The date when the supplier promised that the items listed in the order will be received at their destination location.
qtyOnReceipts double itgen_vnet_qtyonreceipts writable, qtyOnReceipts Qty. on receipts > The quantity of the item that has been received according to all receipts, including the unreleased ones.
receiptAction varchar2 itgen_vnet_receiptaction writable, receiptAction Receipt action > The action that should be perform when the ordered item is received if its quantity is greater than the Max. receipt value or less than the Min. receipt value calculated based on the line's ordered quantity. Values: Reject, Accept but warn, Accept.
receivedAmt double Received Amount writable, receivedAmt Received amt. > The amount received on this purchase order for this item.
requested datetime Requested writable, requested Requested > The date when the item was requested.
status varchar2 Status filters on the platform, writable, ::ancestor.status The top part > Status > The system-generated status of the purchase order, which can be one of the following options: On hold, Open, Pending approval, Rejected, Pending printing, Pending e-mail, Closed, Cancelled.
sub_active char itgen_vnet_sub_active writable, sub.active Active > The status of the identifier.
sub_description varchar2 itgen_vnet_sub_description writable, sub.description Description > The description of the identifier.
sub_errorInfo varchar2 itgen_vnet_sub_errorinfo writable, sub.errorInfo
sub_lastModifiedDateTime datetime itgen_vnet_sub_lastmodifieddatetime writable, sub.lastModifiedDateTime System generated information.
sub_metadata_maxPageSize int64 itgen_vnet_sub_metadata_maxpagesize writable, sub.metadata.maxPageSize
sub_metadata_totalCount int64 itgen_vnet_sub_metadata_totalcount writable, sub.metadata.totalCount
sub_subaccountId int32 itgen_vnet_sub_subaccountid writable, sub.subaccountId SubID > The identifier of the subaccount.
sub_subaccountNumber varchar2 itgen_vnet_sub_subaccountnumber writable, sub.subaccountNumber Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
sub_timeStamp blob itgen_vnet_sub_timestamp writable, sub.timeStamp The timestamp of the subaccount, used for concurrency control.
supplierRef varchar2 Supplier Reference filters on the platform, writable, ::ancestor.supplierRef The top part > Supplier ref. > The reference number of the supplier document related to this purchase order.
supplier_internalId int32 Supplier Internal ID filters on the platform, writable, ::ancestor.supplier.internalId
supplier_name varchar2 Supplier Name filters on the platform, writable, ::ancestor.supplier.name The name of the particular destination of the selected type.
supplier_number varchar2 Supplier Number filters on the platform, writable, ::ancestor.supplier.number The identifier of the particular destination of the selected type.
taxCategory_description varchar2 itgen_vnet_taxcategory_description writable, taxCategory.description Name of item/description
taxCategory_number varchar2 itgen_vnet_taxcategory_number writable, taxCategory.number Number of item
taxTotal double Tax Total filters on the platform, writable, ::ancestor.taxTotal The Top part > VAT total > The total VAT amount for all lines added to the current purchase order. This value, also calculated by the system, is the sum of the VAT amounts for each line.
taxTotalInBaseCurrency double itgen_vnet_taxtotalinbasecurrency filters on the platform, writable, ::ancestor.taxTotalInBaseCurrency The top part > View base > A button that recalculates the VAT total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.
timeStamp blob Timestamp filters on the platform, writable, ::ancestor.timeStamp
unitCost double Unit Cost writable, unitCost Unit cost > The cost per UoM of the stock item.
unitCostInBaseCurrency double itgen_vnet_unitcostinbasecurrency writable, unitCostInBaseCurrency Background calculation connected with the View base/View currency function in the top part. Changes the values in Unit cost, Amount, Disc. unit cost and Cost fields.
uom varchar2 Unit of Measure writable, uom UoM > The unit of measure (UoM) in which the quantity of the item is specified.
vatExemptTotal double VAT Exempt Total filters on the platform, writable, ::ancestor.vatExemptTotal The Top part > VAT exempt total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the VAT with the Include in VAT exempt total check box selected in the TX205000 window.
vatExemptTotalInBaseCurrency double itgen_vnet_vatexempttotalinbasecurrency filters on the platform, writable, ::ancestor.vatExemptTotalInBaseCurrency The top part > View base > A button that recalculates the VAT exempt total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.
warehouse_description varchar2 Warehouse Description writable, warehouse.description Click on the magnifier. > The description.
warehouse_id varchar2 Warehouse ID writable, warehouse.id Click on the magnifier. > The identifier.

Keys

Key Column Refers to Kind Description
BasicPurchaseOrderLines_account_number_fk account_number Accounts.accountCD Key
BasicPurchaseOrderLines_branch_number_fk branch_number Branches.number Key
BasicPurchaseOrderLines_inventory_number_fk inventory_number InventoryItems.inventoryNumber Key
BasicPurchaseOrderLines_supplier_internalId_fk supplier_internalId Suppliers.internalId Key
BasicPurchaseOrderLines_supplier_number_fk supplier_number Suppliers.number Key
BasicPurchaseOrderLines_warehouse_id_fk warehouse_id Warehouses.warehouseID Key

Release Notes

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