invantive documentation
Invantive Support ForumsLog In / Sign Up

BasicPurchaseOrders: Visma.net Financials Basic Purchase Orders

insert REST

  • Catalog: VismaNet
  • Schema: PurchaseOrderBasic
  • Label: Basic Purchase Orders

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 retrieve data and change data using insert.

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 BasicPurchaseOrders 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.
branch_name varchar2 Branch Name filters on the platform, writable, branch.name Click the magnifier. > The name.
branch_number varchar2 Branch Number filters on the platform, writable, branch.number Click the magnifier. > The identifier.
controlTotal double Total for Control filters on the platform, writable, 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, 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, currency The top part > Currency > The currency the purchase order will be paid in.
customDateTimeUTC1 datetime itgen_vnet_customdatetimeutc1 filters on the platform, writable, customDateTimeUTC1 A free custom colum of type DateTime - in UTC timezone
customDec1 double itgen_vnet_customdec1 filters on the platform, writable, customDec1 A free custom colum of type decimal with max 4 decimals.
customDec2 double itgen_vnet_customdec2 filters on the platform, writable, customDec2 A free custom colum of type decimal with max 4 decimals.
customInt1 int32 itgen_vnet_customint1 filters on the platform, writable, customInt1 A free custom colum of type int
customInt2 int32 itgen_vnet_customint2 filters on the platform, writable, customInt2 A free custom colum of type int
customStr1 varchar2 itgen_vnet_customstr1 filters on the platform, writable, customStr1 A free custom colum of type string with max length 100.
customStr2 varchar2 itgen_vnet_customstr2 filters on the platform, writable, customStr2 A free custom colum of type string with max length 100.
customStr3 varchar2 itgen_vnet_customstr3 filters on the platform, writable, customStr3 A free custom colum of type string with max length 100.
customStr4 varchar2 itgen_vnet_customstr4 filters on the platform, writable, customStr4 A free custom colum of type string with max length 100.
customStr5 varchar2 itgen_vnet_customstr5 filters on the platform, writable, customStr5 A free custom colum of type string with max length 100.
date datetime Date filters on the platform, writable, date Mandatory field: The top part > Date* > The date when the purchase order was created.
description varchar2 Description filters on the platform, writable, description The top part > Description > A brief description of the purchase order.
errorInfo varchar2 Error Message filters on the platform, writable, errorInfo
exchangeRate double Exchange Rate filters on the platform, writable, exchangeRate
hold char Hold filters on the platform, writable, hold The top part > Hold > A check box that you select to give the purchase order the On hold status.
lastModifiedDateTime datetime Last Modified filters on the platform, writable, lastModifiedDateTime System generated information.
lineTotal double Line Total filters on the platform, writable, 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, 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.
location_id int32 Location ID filters on the platform, writable, location.id Click the magnifier > The identifier
location_name varchar2 Location Name filters on the platform, writable, location.name Click the magnifier > The displayed name
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, metadata.totalCount
note varchar2 Note filters on the platform, writable, 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, 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.
orderTotal double Order Total filters on the platform, writable, 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, 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 filters on the platform, writable, 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, owner.id Click the magnifier > The identifier
owner_name varchar2 Owner Name filters on the platform, writable, owner.name Click the magnifier > The displayed name
promisedOn datetime Promised on filters on the platform, writable, 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.
status varchar2 Status filters on the platform, writable, 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.
supplierRef varchar2 Supplier Reference filters on the platform, writable, 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, supplier.internalId
supplier_name varchar2 Supplier Name filters on the platform, writable, supplier.name The name of the particular destination of the selected type.
supplier_number varchar2 Supplier Number filters on the platform, writable, supplier.number The identifier of the particular destination of the selected type.
taxTotal double Tax Total filters on the platform, writable, 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, 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, timeStamp
vatExemptTotal double VAT Exempt Total filters on the platform, writable, 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, 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.

Keys

Key Column Refers to Kind Description
BasicPurchaseOrders_branch_number_fk branch_number Branches.number Key
BasicPurchaseOrders_supplier_internalId_fk supplier_internalId Suppliers.internalId Key
BasicPurchaseOrders_supplier_number_fk supplier_number Suppliers.number Key

Release Notes

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