Visma.net Financials Data Model

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Schema: PurchaseOrder > Tables

PurchaseOrderOrder_LinesSubSegments

Get a range of Purchase Order - ScreenId=PO301000Request 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 sizeChange log:2020-May:Added forced pagination

Catalog: VismaNet

Schema: PurchaseOrder

The data in this table is partitioned per value of the COMPANY_CODE column.

This is a read-only table function. The Visma.net API may not support changing the data or the Invantive SQL driver for Visma.net does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net API.

Select Visma.net API URL: /controller/api/v1/purchaseorder

Insert Visma.net API URL: /controller/api/v1/purchaseorder

Update Visma.net API URL: /controller/api/v1/purchaseorder

Delete Visma.net API URL: /controller/api/v1/purchaseorder

Field Selection Method: NotRequired

Base Path: lines[*].sub.segments[*]

Select Visma.net API Operation: get /controller/api/v1/purchaseorder

Table Function Parameters

The following parameters can be used to control the behaviour of the table function PurchaseOrderOrder_LinesSubSegments. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Documentation
COMPANY_CODE	string	☐	Partition to retrieve data from.
greaterThanValue	string	☐	Filter on order no. and forward
lastModifiedDateTime	string	☐	System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present.
lastModifiedDateTimeCondition	string	☐	System retrieved information for state/condition.
numberToRead	int32	☐	This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
orderStatus	string	☐	Select and filter on Status. (Values: Balanced, Cancelled, Closed, Hold, Open, PendingEmail, PendingPrint, Printed, Voided)
orderType	string	☐	Select and filter on Type. (Values: RegularOrder, DropShip, Blanket, StandardBlanket)
pageNumber	int32	☐	Pagination parameter. Page number.
pageSize	int32	☐	Pagination parameter. Number of items to be collected.
skipRecords	int32	☐	This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
supplier	string	☐	Filter on Supplier.

Table Function Columns

The columns of the table function PurchaseOrderOrder_LinesSubSegments are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
active	boolean	Active	☐	Active > The status of the identifier.
alternateId	string	Alternate ID	☐	Alternate ID > The alternate ID used for this stock item-subitem pair by the supplier.
amount	double	Amount	☐	Amount > The amount calculated (after the discount has been taken) for the item.
canceled	boolean	Canceled	☐	Cancelled > A check box that indicates (if selected) that this line of the purchase order has been cancelled.
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
completed	boolean	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.
completeOn	double		☐	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).
controlTotal	double	Total for Control	☐	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		☐	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	string	Currency	☐	The top part > Currency > The currency the purchase order will be paid in.
date	datetime	Date	☐	Mandatory field: The top part > Date* > The date when the purchase order was created.
description	string	Description	☐	Description > The description of the identifier.
description_1	string		☐	The top part > Description > A brief description of the purchase order.
discountAmount	double		☐	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.
discountPercent	double	Discount Percent	☐	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.
dontEmail	boolean	Don't Email	☐	Other information > Do not email > A check box that indicates (if selected) indicates that the purchase order should not be emailed.
dontPrint	boolean	Don't Print	☐	Other information > Do not print > A check box that indicates (if selected) that the current purchase order should not be printed.
emailed	boolean	Emailed	☐	Other information > Emailed > A check box that indicates (if selected) indicates that the current purchase order was emailed.
errorInfo	string	Error Message	☐
errorInfo_1	string		☐
exchangeRate	double	Exchange Rate	☐
extCost	double		☐	Ext. cost > The extended cost of the item, which is the unit cost multiplied by the quantity.
fobPoint	string		☐	Delivery instructions tab > The Delivery instructions section > FOB point > The FOB point where the title of goods (listed on this purchase order) is transferred from the supplier to the company.
hold	boolean	Hold	☐	The top part > Hold > A check box that you select to give the purchase order the On hold status.
lastModifiedDateTime	datetime	Last Modified	☐	System generated information.
lastModifiedDateTime_1	datetime		☐	System generated information.
lineDescription	string	Line Description	☐	A description of the order line, which is copied from the item's description.
lineNbr	int32		☐	The line number
lineTotal	double	Line Total	☐	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		☐	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	string	Line Type	☐	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.
manualDiscount	boolean		☐	Manual discount > A check box that indicates (if selected) that the discount has been applied manually.
maxReceipt	double		☐	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_totalCount	int64	Total Count	☐
minReceipt	double		☐	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	string	Note	☐	Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order.
note_1	string		☐	Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document.
openBalance	double	Open Balance	☐	Other information > Open amount > The amount of these items that are ordered but not received.
openQuantity	double		☐	Other information > Open Quantity > The difference between the quantities of ordered and received items.
orderNbr	string	Order Number	☐	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	string	Order Number	☐	Order no. > The reference number of the blanket or standard order (for normal orders based on blanket or standard orders).
orderQty	double	Order Quantity	☐	Order qty. > The quantity of the item that has been ordered.
orderTotal	double	Order Total	☐	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		☐	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	string	Order Type	☐	Order type > The order type this order is related to (for normal orders based on blanket or standard orders).
orderType_1	string		☐	The top part > Type > The type of the purchase order, which can be one of these options: Normal, Drop-ship, Blanket, Default
paymentRefNbr	string	Payment Reference Number	☐	Other information tab > Prepayment ref. no. > The reference number of the prepayment request linked to this purchase order, if any.
printed	boolean	Printed	☐	Other information > Printed > A check box that indicates (if selected) that the current purchase order was printed.
promised	datetime	Promised	☐	Promised > The date when the item's deliver was promised.
promisedOn	datetime	Promised on	☐	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		☐	Qty. on receipts > The quantity of the item that has been received according to all receipts, including the unreleased ones.
receiptAction	string		☐	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	☐	Received amt. > The amount received on this purchase order for this item.
requested	datetime	Requested	☐	Requested > The date when the item was requested.
requisitionRefNbr	string		☐	Other information tab > Requisition ref. no. > The reference number of the requisition document associated with the purchase order, if any.
salesOrderNbr	string		☐	Other information tab > Sales order no. > The ID of the sales order associated with the purchase order.
salesOrderType	string		☐	Other information tab > Sales order type > The type of the sales order associated with the purchase order.
segmentDescription	string		☐	The Segment values window > The Top part > The description of the segment.
segmentId	int32	Segment ID	☐	The Segment values window > The Top part > The ID of the segment.
segmentValue	string	Segment Value	☐	The Segment values window > The table > The value of the segment, alphanumeric.
segmentValueDescription	string	Segment Value Description	☐	The Segment values window > The table > The description of the segment value.
shippingDestinationType	string		☐	Shipping instructions tab > The Delivery address section > Shipping destination type > The type of the shipping destination, which is one of the following options: Branch location (meaning a branch of your company), Customer, Supplier, and Warehouse.
shipTerms	string		☐	Delivery instructions tab > The Delivery instructions section > Shipping terms > The shipping terms for the purchase order.
shipVia	string	Ship Via	☐	Delivery instructions tab > The Delivery instructions section > Ship via > The carrier selected to ship the goods for the purchase order.
status	string	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.
subaccountId	int32		☐	SubID > The identifier of the subaccount.
subaccountNumber	string		☐	Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
supplierRef	string	Supplier Reference	☐	The top part > Supplier ref. > The reference number of the supplier document related to this purchase order.
taxTotal	double	Tax Total	☐	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		☐	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.
unitCost	double	Unit Cost	☐	Unit cost > The cost per UoM of the stock item.
unitCostInBaseCurrency	double		☐	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	string	Unit of Measure	☐	UoM > The unit of measure (UoM) in which the quantity of the item is specified.
vatExemptTotal	double	VAT Exempt Total	☐	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		☐	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.
workgroupID	int32		☐	Other information tab > Work group ID > The work group to which the purchase order was assigned for processing.

12-12-2020 18:42 Version 20.1.301-BETA+3023

Please enable JavaScript to view this site.

Visma.net Financials Data Model

Table Function Parameters

Table Function Columns