BasicPurchaseOrderReceiptsByPurchaseOrderNumber: Visma.net Financials Basic Purchase Order Receipts by Purchase Order Number
read only REST
- Catalog:
VismaNet - Schema:
PurchaseOrderBasic - Label: Basic Purchase Order Receipts by Purchase Order Number
Get a specific Purchase Order Data for a single Purchase Order Basic. The response headers include an ETag after a successful GET operation.
Can only retrieve data.
Summary
Data for a single Purchase Order Basic.
The response headers include an ETag after a successful GET operation.
API Source
- Endpoint:
/v1/purchaseorderbasic/{purchaseOrderNumber} - Operation:
get /v1/purchaseorderbasic/{purchaseOrderNumber}
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 |
|---|---|---|---|---|
include |
`` | Optional parameter to request custom free fields. | ||
purchase |
`` | Identifies the Purchase Order |
Table Columns
The columns of the table BasicPurchaseOrderReceiptsByPurchaseOrderNumber 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_ |
varchar2 |
Company Code | writable | Partition code, segmenting the data. | |
COMPANY_ |
varchar2 |
Company Name | writable | Name of the partition. | |
branch_ |
varchar2 |
Branch Name | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The name. | |
branch_ |
varchar2 |
Branch Number | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The identifier. | |
control |
double |
Total for Control | filters on the platform, writable, ::ancestor. |
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. | |
control |
double |
itgen_vnet_controltotalinbasecurrency | filters on the platform, writable, ::ancestor. |
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 | writable, currency |
The top part > Currency > The currency the supplier uses for invoicing. | |
currency_ |
varchar2 |
itgen_vnet_currency_2 | filters on the platform, writable, ::ancestor. |
The top part > Currency > The currency the purchase order will be paid in. | |
custom |
datetime |
itgen_vnet_customdatetimeutc1 | filters on the platform, writable, ::ancestor. |
A free custom colum of type DateTime - in UTC timezone | |
custom |
double |
itgen_vnet_customdec1 | filters on the platform, writable, ::ancestor. |
A free custom colum of type decimal with max 4 decimals. | |
custom |
double |
itgen_vnet_customdec2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type decimal with max 4 decimals. | |
custom |
int32 |
itgen_vnet_customint1 | filters on the platform, writable, ::ancestor. |
A free custom colum of type int | |
custom |
int32 |
itgen_vnet_customint2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type int | |
custom |
varchar2 |
itgen_vnet_customstr1 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customstr2 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customstr3 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customstr4 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
custom |
varchar2 |
itgen_vnet_customstr5 | filters on the platform, writable, ::ancestor. |
A free custom colum of type string with max length 100. | |
date |
datetime |
Date | filters on the platform, writable, ::ancestor. |
Mandatory field: The top part > Date* > The date when the purchase order was created. | |
description |
varchar2 |
Description | filters on the platform, writable, ::ancestor. |
The top part > Description > A brief description of the purchase order. | |
error |
varchar2 |
Error Message | filters on the platform, writable, ::ancestor. |
||
exchange |
double |
Exchange Rate | filters on the platform, writable, ::ancestor. |
||
hold |
char |
Hold | filters on the platform, writable, ::ancestor. |
The top part > Hold > A check box that you select to give the purchase order the On hold status. | |
last |
datetime |
Last Modified | filters on the platform, writable, ::ancestor. |
System generated information. | |
line |
double |
Line Total | filters on the platform, writable, ::ancestor. |
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. | |
line |
double |
itgen_vnet_linetotalinbasecurrency | filters on the platform, writable, ::ancestor. |
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_ |
int32 |
Location ID | filters on the platform, writable, ::ancestor. |
Click the magnifier > The identifier | |
location_ |
varchar2 |
Location Name | filters on the platform, writable, ::ancestor. |
Click the magnifier > The displayed name | |
metadata_ |
int64 |
Metadata Max Pagesize | filters on the platform, writable, ::ancestor. |
||
metadata_ |
int64 |
Total Count | filters on the platform, writable, ::ancestor. |
||
note |
varchar2 |
Note | filters on the platform, writable, ::ancestor. |
Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document. | |
order |
varchar2 |
Order Number | filters on the platform, writable, ::ancestor. |
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. | |
order |
double |
Order Total | filters on the platform, writable, ::ancestor. |
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. | |
order |
double |
itgen_vnet_ordertotalinbasecurrency | filters on the platform, writable, ::ancestor. |
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. | |
order |
varchar2 |
Order Type | filters on the platform, writable, ::ancestor. |
The top part > Type > The type of the purchase order, which can be one of these options: Normal, Drop-ship, Blanket, Default | |
owner_ |
guid |
Owner ID | filters on the platform, writable, ::ancestor. |
Click the magnifier > The identifier | |
owner_ |
varchar2 |
Owner Name | filters on the platform, writable, ::ancestor. |
Click the magnifier > The displayed name | |
promised |
datetime |
Promised on | filters on the platform, writable, ::ancestor. |
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. | |
receipt |
varchar2 |
Receipt Number | writable, receipt |
The top part > Receipt no. > The unique reference number of the purchase receipt, transfer receipt, or return, which the system automatically assigns according to its number series. | |
status |
varchar2 |
Status | writable, status |
The top part > Status > The current status of the purchase or transfer receipt, or return, which the system assigns automatically. | |
status_ |
varchar2 |
itgen_vnet_status_2 | filters on the platform, writable, ::ancestor. |
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 |
varchar2 |
itgen_vnet_suppliername | writable, supplier |
The top part > Supplier > The supplier from which the items have been received or to which they will be returned. | |
supplier |
varchar2 |
Supplier Reference | filters on the platform, writable, ::ancestor. |
The top part > Supplier ref. > The reference number of the supplier document related to this purchase order. | |
supplier_ |
int32 |
Supplier Internal ID | filters on the platform, writable, ::ancestor. |
||
supplier_ |
varchar2 |
Supplier Name | filters on the platform, writable, ::ancestor. |
The name of the particular destination of the selected type. | |
supplier_ |
varchar2 |
Supplier Number | filters on the platform, writable, ::ancestor. |
The identifier of the particular destination of the selected type. | |
tax |
double |
Tax Total | filters on the platform, writable, ::ancestor. |
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. | |
tax |
double |
itgen_vnet_taxtotalinbasecurrency | filters on the platform, writable, ::ancestor. |
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. | |
time |
blob |
Timestamp | filters on the platform, writable, ::ancestor. |
||
total |
double |
Total Amount | writable, total |
The top part > Total amt. > The total amount calculated for items received from or returned to the supplier; the sum of all amounts of all stock items listed on the Document details tab. | |
total |
double |
Total Quantity | writable, total |
The top part > Total qty. > The total quantity of items received from or returned to the supplier; the sum of all quantities of all stock items listed on the Document details tab. | |
type |
varchar2 |
Type | writable, type |
The top part > Type > The type of the document, which can be Receipt, Return, or Transfer receipt. | |
vat |
double |
VAT Exempt Total | filters on the platform, writable, ::ancestor. |
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. | |
vat |
double |
itgen_vnet_vatexempttotalinbasecurrency | filters on the platform, writable, ::ancestor. |
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. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: