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: taxDetails[*]
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 PurchaseOrderTaxDetailsBasicByOrderNumber. 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 PurchaseOrderTaxDetailsBasicByOrderNumber are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
branch_name |
string |
Branch Name |
☐ |
Click the magnifier. > The name. |
branch_number |
string |
Branch Number |
☐ |
Click the magnifier. > The identifier. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
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. |
errorInfo |
string |
Error Message |
☐ |
|
exchangeRate |
double |
Exchange Rate |
☐ |
|
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. |
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. |
location_id |
int32 |
Location ID |
☐ |
Click the magnifier > The identifier |
location_name |
string |
Location Name |
☐ |
Click the magnifier > The displayed name |
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
note |
string |
Note |
☐ |
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. |
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 |
☐ |
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 |
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. |
recordId |
int32 |
Record ID |
☐ |
The id as stored in the database. It can be used when we want to update a VAT record. |
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. |
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. |
taxableAmount |
double |
Taxable Amount |
☐ |
Taxable amount > The taxable amount for the VAT, which is calculated at the document level. |
taxId |
string |
Tax ID |
☐ |
Mandatory field: VAT ID* > The ID of the VAT applied to the document. |
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. |
vatAmount |
double |
VAT Amount |
☐ |
VAT > The VAT amount for the specific VAT, which is calculated at the document level. |
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. |
vatId_description |
string |
|
☐ |
Name of item/description |
vatId_number |
string |
|
☐ |
Number of item |
vatRate |
double |
|
☐ |
VAT rate > The rate of the VAT. |
12-12-2020 18:42 Version 20.1.301-BETA+3023
