IntegrationHTTP-methodResourceDTDSchemaExample
Get purchase order listGETpurchaseorderlist.nv  Download
Get purchase orderGETgetpurchaseorder.nv  Download
Import purchase order
POST
purchaseorder.nv

purchaseorder.xsd
Download
Get product quality list
GET
getproductqualitylist.nv
 
Download
Import product qualities
POST
productquality.nv

productquality.xsd
Download
Get vendorGETgetvendor.nv   
Import vendor
POST
vendor.nv




DescriptionSchema
Netvisor general typesnetvisorgeneraltypes.xsd
Purchase general types
purchasegeneraltypes.xsd

Get purchase order list

Resource: purchaseorderlist.nv

Querystring parameters:

ParameterOccursDescriptionExample
limitstartordernumber0...1Export orders from number1000
limitendordernumber0...1Export orders up till number1100
limitbegindate0...1Export orders from date2018-01-01
limitenddate0...1Export orders up till date2018-06-30
limitorderstatus0...1Status of the order
proposal = Purchase proposal
approved = approved
senttovendor = Sent to vendor
waitinginvoice = Link delivery and invoice
archived = Archived
approved
searchcomment0...1
Limit by comment or private comment
 
limitvendor0...1Identification type
integer treated as netvisor key
organizationidentifier treated as organization identifier
other strings treated as vendor code
123456
lastmodifiedstart0...1Returns purchase orders that have been changed since the given date. Date is given as yyyy-MM-ddTHH:mm:ss2019-05-15T12:00:00
lastmodifiedend0...1Returns purchase orders that have been changed before the given date. Date is given as yyyy-MM-ddTHH:mm:ss2019-05-15T12:00:=0

Response: 

LevelElement nameTypeOccursDescriptionExample
rootRootAggr.1  
1PurchaseOrderListAggr.1  
2PurchaseOrderAggr.1  
3NetvisorKeyNumeric1Netvisor key of purchase order123
3OrderNumberNumeric1Number of purchase order11228
3OrderDateDate1Date of purchase order2018-06-01
Attr.formatText1Date format, always ansiansi
3OrderStatusText1status of purchase orderapproved
3VendorNameText1VendorNetvisor Oy
3AmountNumeric1Amount1000,34
3UriText1Netvisor URI to the order/getpurchaseorder.nv?netvisorkey=123

Get purchase order

Resource: getpurchaseorder.nv

Fetch detailed information of certain purchaseorder.

Querystring parameters:

ParameterOccursDescriptionExample
netvisorkey1ID of the order to export123
NetvisorKeyList0...1Can be used to get the details of several orders with given id. Max. 500 identifiers1,2,3

Response:

LevelElement nameTypeOccursDescriptionExample
RootRootAggr.1  
1PurchaseOrderAggr.1  
2NetvisorKeyNumeric 1Purchase order Netvisor key
1
2OrderNumberNumeric 1Purchase order number
1
2OrderDstatusText 1Purchase order stateproposal
approved
senttovendor
archived
2OrderDateText1Purchase order date
2017-1-1
2VendorNameText1Purchase order vendorOy Firma Ab
2VendorAddressLineText0...1Purchase order vendor address
Firmatie 1
2
VendorPostNumberNumeric0...1Purchase order vendor post number
00100
2VendorCityText0...1Purchase order vendor city
Helsinki
2VendorCountryText1Purchase order vendor country
Finland
Attr.typeText1Country type, always ISO-3166ISO-3166
2DeliveryTermText0...1Terms of deliveryAccordin to the agreement
2DeliveryMethodText0...1Delivery method
Installed
2DeliveryNameText0...1Delivery name
Yritys Oy
2DeliveryAddressLineText0...1Delivery address
Yritystie 1
2DeliveryPostNumberNumeric0...1Delivery post number00500
2DeliveryCityText0...1Delivery cityHelsinki
2DeliveryCountryText1Delivery country
Finland
Attr.typeText1Country type, always ISO-3166ISO-3166
2PrivateComment
Text0...1Internal comment, not shown on printed version, max. 1000 chars
 
2CommentText0...1Comment, max. 1000 charsComment
2OurReferenceText0...1Our reference, max. 50 chars
Our reference
2PaymentTermText0...1Payment term
14 days net
2AmountNumeric1Final amount
10000
Attr.currencycodeText1Final amount currency
EUR
Attr.typeText1Currency code, always ISO-4217
ISO-4217
2PurchaseOrderLinesAggr.1  
3PurchaseOrderProductLineAggr.1  
4NetvisorKeyNumeric1Purchase order line Netvisor key
1
4ProductCodeText0...1Product code
123
4ProductName
Text0...1Product name, if product added from Netvisor productlist, in other case suppliers product name
Product
4VendorProductCodeText0...1Vendor code123
4OrderedAmountNumeric1Ordered amount10
4DeliveredAmountNumeric1Delivered amount
0
4UnitPriceNumeric1Unitprice100
4VatPercentNumeric1VAT %
24
4LineSumNumeric1Line sum
100
4FreightRateNumeric0...1Freight rate
0
4DeliveryDateDate1Delivery date2017-01-01
Attr.formatText1Date typeansi
4InventoryPlaceText0...1WarehouseTest warehouse
4DimensionAggr.0...1

5DimensionNameText
1
Dimension nameProjects
5DimensionItemText1Dimension item
Project X
3PurchaseOrderCommentLineAggr.0...1

4NetvisorKeyNumeric1Comment line ID1
4CommentText
1Order line comment
Free Text
3LinkedPurchaseInvoicesAggr.0...1Linked Purchaseinvoices  
 
4PurchaseInvoiceAggr.1..n  
5InvoiceNumberNumeric1Invoice number
1001
5NetvisorKeyNumeric1Invoice Netvisor key
10
5UriText1Netvisor URI to invoice
/getpurchaseinvoice.nv?netvisorkey=1001e

Import purchase order

Resource: purchaseorder.nv

Purchase orders can be imported over the API to Netvisor. Required information is order number, order date and vendor information. If product lines are included, product code and amount are required, and commentlines require the comment text.

Things to note:

  • When editing an order, all existing product- and comment lines are not needed, give only edited and/or new data in the XML.
  • Setting currency for a purchase order is not yet supported, any values entered into the currency or exchange rate attributes will not cause an error, but will be ignored for now.
  • Payment term, delivery term and delivery method are searched with the given information, if not found, a new one is created

Querystring parameters: 

ParameterFormatRequiredDescriptionExample
methodStringAlwaysAdd Import as new order
Edit Edit an existing order

idNumericIf method is editID of the order to edit

Things to note when using Purchaseorderproductline:

MethodDescription
editIf used, do not include purchase order productline partial delivery information (purchaseorderproductlinepartialdelivery) and can include only elements which will be edited
deleteIf used, purchase order productline must be empty
partialdeliverUsed for importing partial delivery rows. If used, must include at least two partial delivery rows (purchaseorderproductlinepartialdeliverycontent). In partial delivery information (purchaseorderproductlinepartialdeliverycontent) the amount of ordered products (orderedamount) must correspond to the ordered amount of the targeted productline amount, which was ordered. 
addtopartialdeliverygroupUsed for adding partial delivery rows. If used, must include at least one partial delivery row (purchaseorderproductlinepartialdeliverycontent). 
If editing erroneous amount of partially delivered product, you must add new partial delivery row for the rest of the amounts and update some partial delivery row amount with the delivered amount. Partially delivered product amount must correspond to the original purchase order line's product amount.
ParamateresDescription
netvisorkeyMandatory if using other methods than add

The following describes the XML message to import (POST) a purchase order into Netvisor:
When reading documentation:
* - When creating new purchase order, mandatory
** - When creating new product line, mandatory

LevelElementFormatOccursDescriptionExample
RootrootAggr.1  
1purchaseorderAggr.1Main order information 
2ordernumberInteger1Number of the order141128
2orderstatusString1Status of the order
proposal 
- Purchase proposal
approved - Approved
senttovendor - Sent to vendor
waitinginvoice - Link delivery and invoice
archived - Archive
approved
2orderdateDate1Date of the order28.11.2014
Attr.formatString1Format of the date, always ansiansi
2vendoridentifierString1Vendor identification information101714
Attr.typeString1Identification type
netvisor - Netvisor key
code - Vendor code
organisationidentifier - Vendor's organisation identifie
code
2purchaseordervendordetails
Aggr.0...1Vendor details
3
addressString1Vendor's address 
3postnumberString1Vendor's post number 
3
cityString1Vendor's post office 
3countryString0...1Vendor's country's code 
Attr.typeString1Country code's type, always ISO-3166 
2deliverytermString0...1Term of delivery 
2deliverymethodString0...1Method of delivery 
2purchaseorderdeliverydetails
String0...1Delivery details
3nameString0...1Recipient of the delivery 
3addressString0...1Address of the delivery 
3postnumberString0...1Post number of the delivery 
3
deliverycityString0...1Post office of the delivery 
3deliverycountryString0...1Country code of the delivery 
Attr.typeString1Type of the country code, always ISO-3166 
2privatecommentString0...1Free private comment text. Will not show on printed order 
2commentString0...1Free comment text, will show on printed order 
2ourreferenceString0...1Our reference1411281
2currencycodeString0...1Order's currency code USD
Attr.typeString1Type of the currency code, always ISO-4217
ISO-4217
2purchaseorderpaymenttermAggr.0...1Payment term information 
3netdaysInteger1Payment term net days14
3discountdaysInteger1Payment term cash discount days10
3discountpercentDecimal1Payment term discount percentage7,5
2purchaseorderlinesAggr.0...1*Order's product lines 
3purchaseorderproductlineAggr.0...nOrder's product line 
Attr.methodString0...1Product line method
add - Add new line (default)
edit - Edit line
delete - Delete line
partialdeliver - Partial delivery for line
addtopartialdeliverygroup - Add new line for partial delivery group
add
(read instructions above)
Attr.netvisorkeyInteger0...1*ID of the product line
 
4purchaseorderproductlinepartialdeliveryAggr.0...1Partial delivery information
 
5purchaseorderproductlinepartialdeliverycontentAggr.1...nPartial delivery
 
6orderedamountDecimal1Amount of ordered products10,00
6deliveredamountDecimal1Amount of delivered products
5,00
6deliveryreceiveddateDate1Product delivery date2017-12-28
Attr.formatString1Date format, always ansiansi
6deliverymanuallyconfirmedString0...1Delivery manually confirmed, even if divergent amounttrue
or
false
6deliveredproductqualityInteger0...1Delivered product quality 1
6inventorybatchnumber
Integer0...1Delivered product inventory batch number
1234
6inventorymanufacturedate
Date0...1Delivered product's manufacture date2021-05-31
Attr.formatString1Date format, always ansi
ansi
6inventorypackagingdate
Date0...1Delivered product's packaging date2021-06-01
Attr.formatString1Date format, always ansi
ansi
6inventorybestbeforedate
Date0...1Delivered product's best before date2021-10-25
Attr.formatString1Date format, always ansi
ansi
6inventoryexpirydate
Date0...1
Delivered product's expiry date2021-10-25
Attr.formatString1Date format, always ansi
ansi
4productcodeString0...1**Product id, if type attribute not given, line can't be linked to product1017
Attr.typeString0...1Type of indentifier
netvisor -Netvisor Key
customer - Product code
customer
4vendorproductcodeString0...1Supplier code for productA100Ah
4orderedamountDecimal0...1**Ordered amount of product10,00
4unitpriceDecimal0...1Product unit price, VAT excluded52,50
4vatpercentDecimal0...1**Product VAT percentage24
4freightrateDecimal0...1Shipping costs, freight rate22,50
4linecommentString0...1Line comment (max. 255 chars.) 
4deliverydateDate0...1**Product line product's delivery date2017.12.9
Attr.formatString1Date format, always ansiansi
4purchaseorderproductlinedeliverydetailsAggr.0...1Purchase order product line delivery details 
5deliveredamountDecimal1Received/Delivered product amount5,0
5deliveryreceiveddateDate1Received/Delivered delivery date 
Attr.formatString1Date format, always ansiansi
5deliverymanuallyconfirmedString0...1Delivery manually confirmed, even if divergent amounttrue
or
false
5deliveredproductqualityInteger0...1Quality of delivered product 
4inventoryplaceString0...1ID/name of the used warehouse12
Attr.typeString1Type of warehouse indentifier
netvisor - Warehouse NetvisorKey
customer - Name of the warehouse
netvisor
4purchaseorderproductlinedimensionsAggr.0...1Purchase order product line dimension details 
5dimensionAggr.0...nProductline dimension 
6dimensionnameString1Dimension headerHankinta
6dimensionitemString1Dimension item
Tarvikkeet
3purchaseordercommentlineString0...1Purchase order comment line 
Attr.methodString1Comment line method
add - Add new line
edit - Edit current comment
delete - Delete line
 
Attr.netvisorkeyInteger0...1ID of the commentline
Mandatory, if method
edit
or
delete
4commentString0...1Comment textThis is an order

Please note:

ElementMethodDescription
purchaseordercommentlinedeleteIf used, element purchaseordercommentline comment must be empty

Get product quality list

Resource: getproductqualitylist.nv

Quality resources will ONLY work if quality handling is activated in Netvisor. This concerns also purchaseorder.nv resource where you can define product quality.

Response:

LevelElementTypeOccursDescriptionExample
RootrootAggr.1  
1ProductQualitiesAggr.1  
2ProductQualityAggr.1  
3NameText1Name of quality classHyvää tuotetta
3NetvisorKeyNumeric1Netvisor ID of quality class
1
3IsQualityDeviationText1Is this handled as quality exeptionFalse


Import product quality classes

Resource: productquality.nv

Quality resources will ONLY work if quality handling is activated in Netvisor. This concerns also purchaseorder.nv resource where you can define product quality.

ParameterOccursDescriptionExample
method1Add - add quality class
add

 

LevelElementTypeOccursDescriptionExample
RootrootAggr.1  
1productqualityAggr.1  
2isqualitydeviationText1Will be handled as quality exeptionTrue
or
False
2nameText1Name in Finnish (Default)
Hyvä laatu
2name_enText0...1Name in English
Good quality
2name_seText0...1Name in Swedish
God kvalitet




Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.