Please enable JavaScript to view this site.

Visma.net Financials Data Model

Navigation: Schema: PurchaseOrderBasic > Tables

PurchaseOrderLinesBasicByOrderNumber

Contents Previous Home Next More

Get a specific Purchase Order

Catalog: VismaNet

Schema: PurchaseOrderBasic

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/purchaseorderbasic/{orderNbr}

Insert Visma.net API URL: /controller/api/v1/purchaseorderbasic/{orderNbr}

Update Visma.net API URL: /controller/api/v1/purchaseorderbasic/{orderNbr}

Delete Visma.net API URL: /controller/api/v1/purchaseorderbasic/{orderNbr}

Field Selection Method: NotRequired

Base Path: lines[*]

Select Visma.net API Operation: get /controller/api/v1/purchaseorderbasic/{orderNbr}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function PurchaseOrderLinesBasicByOrderNumber. 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

Default Value

Documentation

COMPANY_CODE

string

 

Partition to retrieve data from.

orderNbr

string

 

Identifies the Purchase Order

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

account_description

string

Account Description

Name of item/description

account_number

string

Account Number

Number of item

account_type

string

Account Type

 

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.

branch_name

string

Branch Name

Click the magnifier. > The name.

branch_name_1

string

 

Click the magnifier. > The name.

branch_number

string

Branch Number

Click the magnifier. > The identifier.

branch_number_1

string

 

Click the magnifier. > The identifier.

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

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.

discountCode_description

string

Discount Code Description

Name of item/description

discountCode_number

string

Discount Code Number

Number of item

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.

errorInfo

string

Error Message

 

exchangeRate

double

Exchange Rate

 

extCost

double

 

Ext. cost > The extended cost of the item, which is the unit cost multiplied by the quantity.

hold

boolean

Hold

The top part > Hold > A check box that you select to give the purchase order the On hold status.

inventory_description

string

Inventory Description

Name of item/description

inventory_number

string

Inventory Number

Number of item

lastModifiedDateTime

datetime

Last Modified

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.

location_id

int32

Location ID

Click the magnifier > The identifier

location_name

string

Location Name

Click the magnifier > The displayed name

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.

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

owner_id

string

Owner ID

Click the magnifier > The identifier

owner_name

string

Owner Name

Click the magnifier > The displayed name

project_description

string

Project Description

Click on the magnifier. > The description.

project_id

string

Project ID

Click on the magnifier. > The identifier.

projectTask_description

string

Project Task Description

Click on the magnifier. > The description.

projectTask_id

string

Project Task ID

Click on the magnifier. > The identifier.

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.

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.

sub_active

boolean

 

Active > The status of the identifier.

sub_description

string

 

Description > The description of the identifier.

sub_errorInfo

string

 

 

sub_lastModifiedDateTime

datetime

 

System generated information.

sub_metadata_maxPageSize

int64

 

 

sub_metadata_totalCount

int64

 

 

sub_subaccountId

int32

 

SubID > The identifier of the subaccount.

sub_subaccountNumber

string

 

Mandatory field: Subaccount* > The subaccount number. Format 9-XX.

supplier_internalId

int32

Supplier Internal ID

 

supplier_name

string

Supplier Name

The name of the particular destination of the selected type.

supplier_number

string

Supplier Number

The identifier of the particular destination of the selected type.

supplierRef

string

Supplier Reference

The top part > Supplier ref. > The reference number of the supplier document related to this purchase order.

taxCategory_description

string

 

Name of item/description

taxCategory_number

string

 

Number of item

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.

warehouse_description

string

Warehouse Description

Click on the magnifier. > The description.

warehouse_id

string

Warehouse ID

Click on the magnifier. > The identifier.

 

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