Resources - Sales invoices, orders and credit invoices

Before a sales invoice can be retrieved, a list of sales invoices must be requested for the id of the wanted invoice. With the id, specific information can be retrieved one at a time. When importing a sales invoice, it is recommended that the customer- and product registers are being up to date.

Sales invoices' handling operations are divided into the following resources:

Integration	HTTP-method	Resource	DTD	Schema	Example
Get sales invoice or order list	GET	salesinvoicelist.nv			Invoicelist Download Orderlist Download
Get sales invoice or order details	GET	getsalesinvoice.nv / getorder.nv			Invoice Download Order Download
Import sales invoice, credit invoice or order	POST	salesinvoice.nv	Download		Download
Get sales personnel list	GET	salespersonnellist.nv			Download
Delete sales invoice	GET	deletesalesinvoice.nv			-
Update sales invoice status	POST	updatesalesinvoicestatus.nv			-
Deleted sales invoices	GET	deletedsalesinvoices.nv
Deleted sales orders	GET	deletedsalesorders.nv
Invoicing and delivering sales order	POST	salesorderinvoicing.nv			Download
Import a comment into the sales order or invoice processing history	POST	salesinvoicecomment.nv			Download
Matching credit note to invoice	POST	matchcreditnote.nv			Download
Get contract invoicing report	GET	contractinvoicingreport.nv
Get payment term list	GET	paymenttermlist.nv			Download

Get sales invoice or order list

Resource: salesinvoicelist.nv

This resource can be used to retrieve a list of sales invoices and orders by changing the value of the ListType parameter.

Querystring parameters:

Parameter name	Occurs	Description	Example
listtype	0...1	Empty value if fetching sales invoice list preinvoice if fetching order list
invoicesabovenetvisorkey	0...1	Includes only invoice after given id	165
begininvoicedate	0...1	Includes only invoice after given date	2021-01-01
endinvoicedate	0...1	Includes only invoices before given date	2021-12-31
invoicenumber	0...1	Includes only invoice with given invoice number
invoicestatus	0...1	Includes only invoice with specified status, see below what is included	open
lastmodifiedstart	0...1	Finds invoices that are modified after given date	2021-10-23
lastmodifiedend	0...1	Finds invoices that are modified before given date	2021-10-24
salesinvoicebatchid	0...1	Includes only invoices with given Batch ID. See the description of the Sales Invoice Batch Handling
customercode	0...1	Limist the list with customer code	1234567
customernetvisorkey	0...1	Limits the list with customer Netvisor ID	11
secondname	0...1	Includes only invoices with company's second name	Second Name Ltd
secondnamenetvisorkey	0...1	Includes only invoices with company's second name Netvisor ID	2
invoicingcustomercontrycode	0...1	Includes only invoices with specific invoicing customer country code	DE
replyoption	0...1	Value 1 returns the internal comment of the invoice. Value 2 returns currency amount and open currency amount of the sales invoice/order. Value 3 returns all previously mentioned.	1

InvoiceStatus parameter can have the following values:

InvoiceStatus	Returns invoices with status
open	OPEN, OVERDUE, REMINDED, REQUESTED, COLLECTED
overdue	OVERDUE, REMINDED, REQUESTED, COLLECTED
paid	PAID
unsent	UNSENT
creditloss	CREDITLOSS
rejected	REJECTED

Response:

Level	Element name	Type and length	Occurs	Description	Example
root	Root	Aggr.
1	SalesInvoiceList	Aggr.	1
2	SalesInvoice	Aggr.	0...n
3	NetvisorKey	Numeric	1	Invoice identifier in Netvisor	123
3	InvoiceNumber	String	1	Invoice number	1234
3	InvoiceDate	Date	1	Invoice date	2020-11-09
Attr.	format	String	1	Always ansi	ansi
3	InvoiceStatus	String	1	Status of the invoice or order. Returns sales invoice payment status.	See table below.
Attr.	substatus	String	0...1	Invoice sub status. Will return status of receivables on the invoice: open, overdue, reminded, requested or collected. This attribute is not used for orders.	open
Attr.	isincollection	Numeric	1	Is invoice in collection or not (Intrum/Duetto)	0 or 1
3	CustomerCode	String	1	Billed customer's code
3	CustomerName	String	1	Customer's name
3	ReferenceNumber	String	1	Invoice reference number
3	InvoiceSum	Numeric	1	Invoice sum, two decimals	12,34
3	OpenSum	Numeric	1	Open sum, two decimals	12,34
3	Uri	String	1	Uri that can be used to get details of invoice or order	See below
3	AdditionalInformation	Aggr.	0...1	Added to the response if in the request have included replyoption parameter.
4	PrivateComment	String	1	Invoice's internal additional information	private comment
4	InvoiceCurrencySum	Numeric	0...1	Currency sum of invoice/order	1240
Attr.	currencycode	String	1	Currency code	USD
Attr.	type	String	1	Type, always ISO-4217	ISO-4217
4	OpenCurrencySum	Numeric	0...1	Open currency sum of invoice/order	0
Attr.	currencycode	String	1	Currency code	USD
Attr.	currencycode	String	1	Type, always ISO-4217	ISO-4217

Return value differences for orders and invoices:

	InvoiceStatus	URI
Invoice	open, creditloss, paid, rejected	/getsalesinvoice.nv?netvisorkey=123
Order	archived, undelivered, delivered, billed	/getorder.nv?netvisorkey=123

Get sales invoice details

Recourse: getsalesinvoice.nv or getorder.nv

Before a sales invoice can be retrieved, a list of sales invoices must be requested for the id of the wanted invoice. With the id, specific information can be retrieved one at a time. If user has modified the arrangement of the invoice's invoice rows in the Netvisor user interface, request retains that arrangement.

Same resource can be used to retrieve sales order. Follows same structure as salesinvoice and same parameters can be used.

Querystring parameters:

Parameter name	Occurs	Description	Example
netvisorkey	1	Invoice identifier of the salesinvoice	125
pdfimage	0...1	If the parameter is not given, the response is the same as pdfimage=lastsentprintservice lastsentprintservice  returns the image of the sales invoice as a PDF-file (element: LastSentInvoicePDFBase64Data) if the sales invoice is sent to the printing service PDF Returns the image of the sales invoice as a PDF file (element: LastSentInvoicePDFBase64Data) nopdf Doesn't return anything	pdf
showprocesshistory	0...1	Returns the sending and printing history of the sales invoice in ProcessHistory-element	1
includeattachments	0...1	Returns all the attachments in Base64-encoding	1
showcommentlines	0...1	Returns invoice's comment rows inside Invoiceline aggregate	1
netvisorkeylist	0...1	Can be used to get the full details of several invoices with given id. Max. 500 identifiers	1,2,3
includedocuments	0...1	When getting salesinvoice, returns orders related to the invoice.  When getting salesorder, returns invoices related to the order.	1

Example: getsalesinvoice.nv?netvisorkey=1234&pdfimage=pdf&showprocesshistory=1
Example: getorder.nv?netvisorkey=1234&pdfimage=pdf&showprocesshistory=1
Response:

Level	Element name	Type and legth	Occurs	Description	Example
root	Root	Aggr.	1
1	SalesInvoice	Aggr.	1
2	SalesInvoiceNetvisorKey	String	1	Invoice Netvisor ID
2	SalesInvoiceNumber	String	1	Invoice number
2	SalesInvoiceDate	Date	1	Invoice date	2021-01-27
Attr.	format	String	1	Date format, always ansi	ansi
2	SalesInvoiceEventDate	Date	1	Invoice event date	2021-02-01
Attr.	format	String	1	Event date format, always ansi	ansi
2	SalesInvoiceValueDate	Date	1	Invoice's Valuedate	2021-01-27
Attr.	format	String	1	Date format, always ansi	ansi
2	SalesInvoiceDeliveryDate	Date	1	Invoice's date of delivery	2021-01-27
Attr.	format	String	1	Always ansi	ansi
2	SalesInvoiceDueDate	Date	1	Invoice's due date	2021-01-27
Attr.	format	String	1	Always ansi	ansi
2	SalesInvoiceReferencenumber	String	1	Invoice's reference number	7659221
2	SalesInvoiceAmount	Numeric	1	Invoice total	124,50
Attr.	iso4217currencycode	String	0...1	Currency used in invoice	USD
Attr.	currencyrate	Numeric	0...1	Currency conversion rate	0,91
2	ForeignCurrencyAmount	Numeric	0...1	Currency amount	113,29
2	SalesInvoiceCollectionCost	Numeric		Collection charges	10,00
2	SellerIdentifier	String	1	Indentifier of the seller (name)	Matti Meikäläinen
Attr.	type	String	1	Always name meaning that element SellerIdentifier is name of seller	name
2	InvoiceStatus	String	1	Status of the invoice/order	Maksettu
Attr.	status	String	1	Status code of the invoice/order: Invoice: open, paid, unsent, overdue, reminded, requested, collected, creditloss or rejected Order: archived, undelivered, delivered, billed	paid
2	InvoiceVoucher	String	0...1	Invoice voucher number	27
Attr.	NetvisorKey	String	1	Voucher Netvisor ID	8000
2	SalesInvoiceFreeTextBeforeLines	String	1	Free text before invoice lines
2	SalesInvoiceFreeTextAfterLines	String	1	Free text after Invoice lines
2	SalesInvoiceOurReference	String	1	Our refence
2	SalesInvoiceYourReference	String	1	Your reference
2	SalesInvoicePrivateComment	String	1	Comment that will not be visible on the invoice
2	SalesInvoiceAgreementIdentifier	String	1	Contract ID
2	InvoicingCustomerCode	String	1	Customer's Code
2	InvoicingCustomerName	String	1	Customer's Name
2	InvoicingCustomerNameExtension	String	1	Customer's Name Extension
2	InvoicingCustomerNetvisorKey	String	1	Customer's Netvisor Key/ID
2	InvoicingCustomerOrganizationIdentifier	String	1	Customer's Organization identifier	If customer is private customer, field will be empty.
2	InvoicingCustomerAddressline	String	1	Customer's Address	PL 316
2	InvoicingCustomerAdditionalAddressLine	String	1	Customer's Adress, additional line
2	InvoicingCustomerPostnumber	String	1	Customer's Post Number	50123
2	InvoicingCustomerTown	String	1	Customer's City	Lappeenranta
2	InvoicingCustomerCountryCode	String	1	Customer's Country code	FINLAND
2	MatchPartialPaymentsByDefault	String	1	Yes or No	Yes
2	DeliveryAddressName	String	1	Name for the delivery
2	DeliveryAddressLine	String	1	Address of the delivery
2	DeliveryAddressPostnumber	String	1	Post number of the delivery
2	DeliveryAddressTown	String	1	City of the delivery
2	DeliveryAddressCountryCode	String	1	Country code for the delivery
2	DeliveryMethod	String	1	Method of delivery	Delivered
2	DeliveryTerm	String	1	Terms of delivery	Free Deliverer
2	PaymentTermNetDays	String	1	Days for the terms of payment. If payment term is due date this will return empty value	11
2	PaymentTermCashDiscountDays	String	1	Days for cash discount. If payment term is due date this will return empty value	5
2	PaymentTermCashDiscount	String	1	Amount of cash discount. If payment term is due date this will return empty value	10
Attr.	type	String	1	Always percentage	percentage
2	Waybillidentifier	String	1	Waybill number	033000050143
2	DeliveryToCustomerDate	String	0...1	Sales order delivery to customer date	2020-10-13
Attr.	format	String	1	Delivery date format, always ansi	ansi
2	DeliveryToCustomerWeek	String	0...1	Sales order delivery to customer week	42/2020
2	TaxHandlingClause	String	0...1	Sales invoice tax handling clause	AVL 8 c §, käännetty verovelvollisuus
Attr.	NetvisorKey	String	1	Tax handling clause's NetvisorID	14
2	DeliveryOfficeIdentifier	Numeric	1
2	ContactPersonNetvisorKey	Numeric	0...1	Contact person's NetvisorID	123
2	ContactPersonFirstName	String	0...1	Contact person's first name	Matti
2	ContactPersonLastName	String	0...1	Contact person's last name	Meikäläinen
2	ContactPersonPhoneNumber	Numeric	0...1	Contact person's phone number	050-1234567
2	ContactPersonEmail	String	0...1	Contact person's email address	matti.meikalainen@firma.fi
2	LastSentInvoicePDFBase64Data	Base64	0...1	PDF information of previously sent invoice	S89O3Ly1Lr59NB
2	CreditedInvoiceNetvisorKey	Numeric	0...1	Netvisorkey of the credited invoice	27
2	InvoiceLines	Aggr.	1
3	InvoiceLine	Aggr.	1
4	SalesInvoiceProductLine	Aggr.	0...n
5	NetvisorKey	String	1	Id of the product line	17536
5	ProductIdentifier	String	1	Id of the product	TEMP1
Attr.	type	String	1	Always customer	customer
5	ProductName	String	1	Name of the product	Example product
5	ProductNetvisorKey	String	1	Netvisor Key/ID of the product
5	ProductUnitPrice	Numeric	1	Unit price of the product	7,00
5	ProductPurchasePrice	Numeric	1	Purchase price of the product
5	ProductVatPercentage	String	1	VAT percentage of the product	24
Attr.	VatCode	String	1	VAT code	KOMY
5	ProductPrimaryEanCode	String	1	Primary EAN code
5	ProductSecondaryEanCode	String	1	Secondary EAN code
5	SalesInvoiceProductLineQuantity	Numeric	1	Quantity of product
5	SalesInvoiceProductLineUnit	String	1	Unit of product	kpl
5	SalesInvoiceProductLineDeliveryDate	Date	0...1	Sales order line delivery date	2021-04-16
5	SalesInvoiceProductLineDiscountPercentage	Numeric	1	Discount percentage
5	SalesInvoiceProductLineFreeText	String	1	Free text for line
5	SalesInvoiceProductLineVatSum	Numeric	1	Line vat sum rounded to two decimals	1,68
5	SalesInvoiceProductLineLinesum	Numeric	1	Line sum rounded to two decimals	8,68
5	SalesInvoiceProductLineInventoryID	Numeric	1	Warehouse ID of product	1
5	SalesInvoiceProductLineInventoryName	String	1	Warehouse name of product	Example warehouse
5	AccountingAccountSuggestion	Numeric	1	Posting suggestion, account NetvisorID	551
5	AccountingAccountSuggestionAccountNumber	Numeric	1	Posting
5	dimension	Aggr.	0...n
6	dimensionname	String	1	Dimension header	City
6	dimensionitem	String	1	Dimension name	Helsinki
5	ProvisionPercentage	Numeric	1	Provision percentage	12
4	SalesInvoiceCommentLine	Aggr.	0...n
5	Comment	String	1	Comment line	Comment
3	SalesInvoiceAttachments	Aggr.	0...1
4	SalesinvoiceAttachment	Aggr.	1...n
5	mimetype	String	1	Contents file format	image/jpeg
5	attachmentdescription	String	1	Description of attachment
5	filename	String	1	Filename	Example_picture.jpg
5	documentdata	Base64	1	Attachment in Base64-encoding	S89O3Ly1Lr59NBS89
3	documents	Aggr.	1	Invoices/orders related to the order/invoice
4	salesorder	Aggr.	1...n	Note! If getorder.nv is used, the element name is salesinvoice
4	netvisorkey	Numeric	1	Netvisor ID of order related to the invoice / Netvisor ID of invoice related to the order	12345
4	ordernumber	Numeric	1	Number of order related to the invoice / Number of invoice related to the order Note! If getorder.nv is used, the element name is invoicenumber	1001

Import sales invoice, credit invoice or order

Resource: salesinvoice.nv

The API makes it possible to add or edit a sales invoice, it's product-, sub- and comment lines, attachments, voucher lines and customer specific fields in Netvisor.

The required fields for importing a sales invoice are:

• Date of the invoice
• Sum total
• Invoice status
• Customer's linking information
• Net day of the terms of payment or due date
• At least one invoice line with the following information
  • Product linking information
  • Product name
  • Product's unit price
  • Product's VAT percentage and code
  • Product's unit count

The salesinvoice can be imported as a salesinvoice draft with status "invoicedraft". It is not possible to give invoice number or import invoice voucherlines for invoice drafts. Invoice draft can be updated to salesinvoice with the parameter edit.

Credit note is imported trough the API with the same message structure. The only difference is that unit count and sum total are set to negative numbers. Also productline vat sum and productline sum are set to negative numbers if they are given. Credit note is not automatically matched to existing sales invoice. Connecting credit note and sales invoice must be done either via API using resource matchcreditnote.nv or manually in Netvisor UI.

Netvisor rounds invoice line rowsum and invoice total sum by 2 digits when importing XML

Billing and delivery customer is focused to sales invoice by Netvisor key or by customer code. Netvisor key is database ID and customer code is individual code given in customer register by Netvisor user. These can be fetched by using customerlist.nv resource.

When only Invoicingcustomeridentifier is given in the Sales Invoice XML and no other invoicing address or delivery address details are on the XML, the API will retrieve this information automatically from customer register. In other hand if any other billing customer detail (i.e. postal address) is given, nothing is retrieved from the customer register.

If an alternative billing customer has been determined to target customer, the API will automatically retrieve the alternative customers information to the imported invoice. In this case, the billing address information in the imported material is not used.

The sales invoice can be accrued either on invoice or invoice row level using either equal division or allocation curve. Accrual can be imported for both unsent or open invoices. The accrual voucers are generated according to data on the xml after the invoice is sent or when importing open invoices, when the invoice is imported automaticallyby the system. Please note that accruing one month is possible only when the accrual is not on the same month as the invoice date. E.g. if the sales invoice date is in April the accrual can be done earliest for May or for any time after that. The accrual cannot be done to the past.

Querystring parameters:

Parameter name	Occurs	Description	Example
Method	1	add or edit. When using method edit, all original order/invoice details must be given if wish to keep them.	Add
Id	0...1	Must be defined if method = edit

The following describes the XML message to import (POST) a sales invoice into Netvisor:

Level	Element name	Type and length	Occurs	Description	Example
Root	root	Aggr.	1
1	salesinvoice	Aggr.	1
2	salesinvoicenumber	Numeric max. length 18 digits	0...1	If number is not given, Netvisor automatically picks next free number. Cannot be given for invoice drafts.	123456
2	salesinvoicedate	Date	1	Sales invoice date	2019-12-31
Attr.	format	String	1	Always ansi	ansi
2	salesinvoiceeventdate	Date	0...1	Invoice's event date. This forms the voucher date.	2020-01-01
Attr.	format	String	1	Always ansi	ansi
2	salesinvoiceduedate	Date	0...1	Sales invoice due date. Compulsory if payment term is not given. When due date is given, Netvisor sets payment term automatically to 'Due date'. The message can not include both due date and payment term, only other element is given.	2020-01-14
Attr.	format	String	1	Always ansi	ansi
2	salesinvoicevaluedate	Date	0...1	Invoice's valuedate. If given, the net days of payment term are applied to the valuedate	2019-12-31
Attr.	format	String	1	Always ansi	ansi
2	salesinvoicedeliverydate	Date	0...1	Sales invoice delivery/arrival date. Can only be given for sales orders.	2020-01-04
Attr.	format	String	1	Always ansi	ansi
2	salesinvoicedeliverytocustomerdate	Date or week number	0...1	Delivery date for customer. Date or week number. For sales order only.	2018-W12
Attr.	format	String	1	Delivery date for customer, format	ansi
Attr.	type	String	1	Delivery date for customer. date or weeknumber	weeknumber
2	salesinvoicewaybillidentifier	String, max 35 characters	0...1	Waybill number/identifier. For sales order only.	33000050143
2	salesinvoiceproductpackagepallet	Number	0...1	Sales order package. For sales order only.	2
Attr.	type	String	1	Pallet code type, GS1	GS1
Attr.	amount	String	0...1	Pallet amount	2
2	salesinvoicereferencenumber	Referece	0...1	Invoice reference number. Must be in correct format with check sum. If not given, Netvisor forms the reference number for invoice.	1070
2	salesinvoiceamount	Numeric	1	Total amount of the invoice. If given, amount is not calculated from the invoice rows. Possible to give as empty value </salesinvoiceamount>, then the amount is calculated from the invoice rows Notice that if you are importing already sent invoices, we recommend that you give the amount.	100,99
Attr.	iso4217currencycode	String	0...1	If not given, currency code from company´s information is used. Otherwise code must be given in ISO 4217 standard	USD
Attr.	currencyrate	String	0...1	If not given, daily currency rate from European central bank is used. If there is no existing currency rate value, then value 1 used automatically	1,33
Attr.	pricetype	String	0...1	netvisor or customer. Customer does nothing but if value is netvisor, Netvisor's price groups and customer prices will be used for invoice rows. SalesInvoiceAmount -value should be 0 so that invoice amout is calculated correctly from invoice rows.	netvisor
2	selleridentifier	String	0...1	Link seller to the invoice. If you want to link the seller information to the seller found on Netvisor, you must set both the seller's link information (selleridentifier) and the seller's name (the next element 'sellername'). Netvisor's seller information can be retrieved from the resource: Get sales personnel list, the list returns the Netvisor Key used to link the seller.	1
Attr.	type	String	1	Type of link: netvisor (netvisorkey) or customer (name) Linking can be done with the seller's Netvisor Key (primary) or the seller's name. When the linking information and the name of the seller (element sellername) are imported, the name of the seller corresponding to the ID in Netvisor becomes the seller on the invoice. If the link is made by name, then the given string is compared forward and backward to the list of Netvisor seller. If seller cannot be found on Netvisor, the interface will response incomplete information.	netvisor
2	sellername	String, max. length 50	0...1	Free form name of the seller	Matti Mallikas
2	invoicetype	String	0...1	invoice, order or invoicedraft. Default is invoice	invoice
2	salesinvoicestatus	String	1	Status of invoice open or unsent for invoice, delivered or undelivered for order	open
Attr.	type	String	1	Use netvisor	netvisor
2	salesinvoicefreetextbeforelines	String, max. length 500	0...1	Free text before before invoice lines
2	salesinvoicefreetextafterlines	String, max. length 500	0...1	Free text after invoice lines
2	salesinvoiceourreference	String, max. length 200	0...1	Information for "our reference" field
2	salesinvoiceyourreference	String, max. length 200	0...1	Information for "your reference" field
2	salesinvoiceprivatecomment	String, max. length 500	0...1	Shown only in Netvisor interface, not printed on invoice form
2	invoicingcustomeridentifier	String	1	Information used to link invoicing customer to invoice. Customer must be already in Netvisor. Value can be customer code or id of customer record in Netvisor (see type attribute)	MM
Attr.	type	String	1	Type of link: netvisor (=Netvisor ID), customer (=customer code), or organizationunitnumber (=OVT-identifier)	customer
Attr.	contactpersonid	String	0...1	Customer's contact person's Netvisor ID. Can be retreived with getcustomer.nv.	4012
2	invoicingcustomername	String, max. length 250	0...1	Will not be collected from Netvisor	Matti
2	invoicingcustomernameextension	String, max. length 250	0...1	Will not be collected from Netvisor	Meikäläinen
2	invoicingcustomeraddressline	String, max. length 100	0...1	Will not be collected from Netvisor	Pajukuja 1
2	invoicingcustomeradditionaladdressline	String, max. length 100	0...1	Will not be collected from Netvisor
2	invoicingcustomerpostnumber	String, max. length 50	0...1	Will not be collected from Netvisor	53100
2	invoicingcustomertown	String, max. length 50	0...1	Will not be collected from Netvisor	Lappeenranta
2	invoicingcustomercountrycode	String	0...1	In ISO 3316 format. *)	FI
Attr.	type	String	1	Will not be collected from Netvisor	ISO-3316
2	officeidentifier	String	0...1	Office identifier. Office identifier in Netvisor. NOTE! This is not Office's Netvisorkey. Office identifier can be given in the message and given particular office (or first match) is searched or new office is created (type=automatic). NOTE! When using this element, all office details must be given in the message.
Attr.	type	String	0...1	automatic when new office should be created according to to sent message. NOTE! All office details must be given in the message.
2	deliveryoffice	String	0...1	Delivery office target to Netvisor delivery office in customer details. NOTE! All delivery office details must be given in the message
Attr.	type	String	1	Target type: Customer=Delivery office name Netvisor=Delivery office NetvisorID
2	deliveryaddressname	String, max. length 250	0...1	Will not be collected from Netvisor. Must be given if delivery details should be shown on invoice PDF.	Maija
2	deliveryaddressline	String, max. length 100	0...1	Will not be collected from Netvisor	Pajukuja 2
2	deliveryaddresspostnumber	String, max. length 50	0...1	Will not be collected from Netvisor	55100
2	deliveryaddresstown	String, max. length 50	0...1	Will not be collected from Netvisor	Imatra
2	deliveryaddresscountrycode	String	0...1	Will not be collected from Netvisor	FI
Attr.	type	String	1	Will not be collected from Netvisor	ISO-3316
2	deliverymethod	String, max. length 50	0...1	Free form text. If given value is not found from Netvisor, then value is created as new delivery method in Netvisor	Installed
2	deliveryterm	String, max. length 50	0...1	Free form text. If given value is not found from Netvisor, then value is created as new delivery term in Netvisor	According to agreement
2	salesinvoicetaxhandlingtype	String	0...1	countrygroup, forcedomestic, domesticconstructionservice or notaxhandling. *1) If not given, taxhandlingtype from customer's information will be used	countrygroup
2	paymentterm	Numeerinen	0...1	Payment term's NetvisorKey	1
Attr.	type	Merkkijono	1	Payment term's type: netvisor = allocating to the payment term based on payment term's NetvisorKey customerdefault = customer's default payment term companydefault = company's default payment term default = primary customer's default payment term. If not set, the company's default payment term is used	netvisor
2	paymenttermnetdays	Numeric	1	Invoice date + paymenttermnetdays = invoice duedate. Payment term: "14 days net"	14
2	paymenttermcashdiscountdays	Numeric	0...1	Cash discount days for the payment term. Payment term: "14 days net, 5 days"	5
2	paymenttermcashdiscount	Numeric	0...1	Cash discount percent Payment term: "14 days net, 5 days-10%"	10
Attr.	type	String	1	Type of discount, always percentage	percentage
2	expectpartialpayments	Numeric	0...1	1 = yes, 0 = no. Default 0. If the invoice accepts partial payments, the invoice is also accepting payments outside the the cash discount tolerances	1
2	overridevouchersalesreceivablesaccountnumber	Numeric	0...1	When given, this will override the default sales receivables account number in Netvisor. Works only with salesinvoices with status "Open".	1703
2	salesinvoiceagreementidentifier	String, max. length 35	0...1	Contract ID
2	printchannelformat	String	0...1
Attr.	type	String	1	netvisor or customer	netvisor
2	secondname	String	0...1	supplementary firm name	Example name
Attr.	type	String	1	netvisor (NetvisorKey) or customer (name)	customer
2	overriderateofoverdue	Numeric	0...1	Penalty interest-%, overrides Netvisor default	5,5
2	ordernumber	String	0...1	Order number	258741
2	proposedaccount	Numeric	0...1	Customer's accounting suggestion	1011
2	type	String	1	customer	customer
2	accountdimensiontext	String, max 35	0...1	Customer's dimension for whole invoice. In Netvisor UI this can be found from sales invoice's Additional information under Additional customer information fields. Can also be imported for invoice rows, see documentation below.	cost center
2	collectioncost	Numeric	0...1	Collection cost. Only positive values (and 0) are allowed. Only for sales invoices.	15
2	isthirdpartysales	Numeric	0...1	Triangular trade. 0 or 1, where 1 chooses the option "Triangular trade" for sales invoice. Used only for sales invoices.	1
2	invoicelines	Aggr.	1

Invoice lines can be either product lines, sublines or comment lines. Product in a product line must exist in Netvisor and be linked to the line either with Netvisor-key or customer specific key. However product name, price and other information can be altered. 

VAT-code is compulsory for product lines. You can check the VAT-codes from the table below. The given VAT-code is used on the voucher if the status of the imported invoice is open. If the invoice status is unsent the VAT-code on the voucher is taken from the accounting account settings. 

If the imported invoice has both product- and comment lines, their order will be the same as in the imported material.

The sales invoice can be accrued on invoice row level using either equal division or allocation curve. When using equal division elements endmonth and endyear are given on the xml. When using allocation curve these elements are not used but the element divisioncurvename is given on the xml. Please note that accruing one month is possible only when the accrual is not on the same month as the invoice date. E.g. if the sales invoice date is in April the accrual can be done earliest for May or for any time after that. The accrual cannot be done to the past.

If product lines are needed, structure for InvoiceLine aggregate is this:

Level	Element name	Type and length	Occurs	Description	Example
3	invoiceline	Aggr.	1...n
4	salesinvoiceproductline	Aggr.	1
5	productidentifier	String	1	Product identifier, either netvisorkey or given product code. Product must be founded in Netvisor.
Attr.	type	String	1	Type of indentifier: - customer (given product code) - netvisor (netvisorkey) - primaryeancode (given primary EAN-code) - secondaryeancode (given secondary EAN-code)	netvisor
5	productname	String, max. 200	0...1	Name of the product. If not given will be retrieved from Netvisor.	test product
5	productunitprice	Numeric, max 12 decimal	1	Product unit price, not retrieved from Netvisor	10,05
Attr.	type	String	1	Type of unit price, net or gross	net
5	productunitpurchaseprice	Numeric	0...1	Product unit purchase price	1,05
Attr.	type	String	1	Type of unit purchase price, always net	net
5	productvatpercentage	Numeric	1	Must not conflict with vat code	24
Attr.	vatcode	String	1	NONE, KOOS, EUOS, EUUO, EUPO, 100, KOMY, EUMY, EUUM, EUPM312, EUPM309, MUUL, EVTO, EVPO, RAMY, RAOS or EVRO	KOMY
5	salesinvoiceproductlinequantity	Numeric	1	Amount of products. Can be integer or decimal. Max eight decimals (e.g. 3,55555555)	5
5	salesinvoiceproductlinediscountpercentage	Numeric	0...1	Discount percentage. If the attribute given, Netvisor will use the discount percentage from customer details in Netvisor	10
Attr.	type	String	1	netvisor	netvisor
5	salesinvoiceproductlinefreetext	String, max. 512	0...1	Free text for the product line
5	salesinvoiceproductlinevatsum	Numeric	0...1	Tax for the product line. Given if amount calculated by Netvisor is wished to be overridden	11,00
5	salesinvoiceproductlinesum	Numeric	0...1	Line's gross total sum. Given if sum calculated by Netvisor is wished to be overridden	50,00
	Note! Both salesinvoiceproductlinesum and salesinvoiceproductlinevatsum elements are required if sum calculated by Netvisor is wished to be overridden.
5	salesinvoiceproductlineinventoryid	Numeric	0...1	Warehouse ID of productline	1
5	accountingaccountsuggestion	Numeric	0...1	Suggestion for accounting account. Must be found in the system	3000
5	dimension	Aggr.	0...n
6	dimensionname	String, max. 50	1	Dimension, if the dimension is not found, the system creates it
6	dimensionitem	String, max. 200	1	Dimension name
5	provisionpercentage	Numeric	0...1	Provision percentage	12
5	accrualrule	Aggr.	0...1	Accrual rule for invoice row, you can use equal division OR allocation curve. Invoicestatus has to be "open", that the voucher is generated.
6	startmonth	Numeric	1	Starting month	9
6	startyear	Numeric	1	Starting year	2020
6	endmonth	Numeric	0...1	Ending month (only with equal division)	12
6	endyear	Numeric	0...1	Ending year (only with equal division)	2020
6	divisioncurvename	String	0...1	Allocation curve (only with allocation curve) Has to be predefined in Netvisor view: 'Financials > Budgeting settings > Allocation curves'	quarter
5	productunitname	String, max 14	0...1	Product unit. If not given, Netvisor will use the product unit from product details in Netvisor. Cannot be given if the compay is using Extended product management.	pcs
5	deliverydate	Date	0...1	Sales order productline delivery date. For sales order only.	2021-04-14
Attr.	format	String	1	Always ansi
5	OrderNumber	Numeric	0...1	Product order number.	1232
5	proposedaccount	Numeric	0...1	Customer's accounting suggestion	1011
5	type	String	1	customer	customer
5	accountdimensiontext	String, max 35	0...1	Customer's dimension for invoice row	cost center

If comment lines are needed, use the following structure for InvoiceLine aggregate:

Level	Element name	Type and length	Occurs	Description	Example
3	invoiceline	Aggr.	1...n
4	salesinvoicecommentline	Aggr.	1
5	comment	String, max 6000	1	Comment for the invoice	Comment for the invoice

If sublines are needed, use the following structure for InvoiceLine aggregate:

Level	Element name	Type and length	Occurs	Description	Example
3	invoiceline	Aggr.	1...n
4	salesinvoicesubline	Aggr.	1
5	sublinearticleidentifier	String, max 35	0...1	Product code	1
5	sublinearticlename	String, max 100	1	Product name	Product
5	sublinedescription	String, max 512	0...1	Line description	Description
5	sublineunitcode	String, max 14	0...1	Product unit	pcs
5	sublineunitprice	Numeric	0...1	Unit price	10
5	sublinedeliveredquantity	Numeric	0...1	Delivered quantity	1
5	sublinediscountpercent	Numeric	0...1	Discount percent	0
5	sublinevatpercent	Numeric	0...1	Vat percent	24
5	sublinesum	Numeric	0...1	Line sum	12,4
5	sublinevatsum	Numeric	0...1	Vat sum	2,4

After the invoice lines, the structure continues as follows:

Level	Element name	Type and length	Occurs	Description	Example
2	invoicevoucherlines	Aggr.	0...1	*2
3	voucherline	Aggr.	1...n
4	linesum	Numeric	1	Line sum. Positive value will be recorded as debit, and negative as credit	100
Attr.	type	String	1	Type of sum, net or gross	net
4	description	String, max. 255	0...1	Free description text
4	accountnumber	String	1	Account number, must be found in the system	3000
4	vatpercent	Numeric	1	VAT percent. Must not conflict with VAT code	24
Attr.	vatcode	Numeric	1	NONE, KOOS, EUOS, EUUO, EUPO, 100, KOMY, EUMY, EUUM, EUPM312, EUPM309, MUUL, EVTO, EVPO, RAMY, RAOS or EVRO. Must not conflict with VAT percent. Check table below.	KOMY
5	dimension	Aggr.	0...n
6	dimensionname	String	1	Dimension name	Project 1
6	dimensionitem	String	1	Dimension item	Payroll
2	accrualrule	Aggr.	0...1	Accrual rule for the whole invoice, you can use equal division OR allocation curve. Invoicestatus has to be "open", that the voucher is generated.
3	startmonth	Numeric	1	Starting month	9
3	startyear	Numeric	1	Starting year	2020
3	endmonth	Numeric	0...1	Ending month (only with equal division)	12
3	endyear	Numeric	0...1	Ending year (only with equal division)	20
3	divisioncurvename	String	0...1	Allocation curve (only with allocation curve) Has to be predefined in Netvisor view: 'Financials > Budgeting settings > Allocation curves'	quarter
2	salesinvoiceattachments	Aggr.	0...1
3	salesinvoiceattachment	Aggr.	1...n
4	mimetype	String	1	MIME type of the attachment	Application/pdf
4	attachmentdescription	String, max 100 characters	1	Description of the attachment
4	filename	String, max 255 characters	1	Filename of the attachment	project1.pdf
4	documentdata	String	1	Base64 encoded data of the attachment
Attr.	type	String	1	By default is used the pdf, if the attribute is not provided. Values: finvoice, Files to be attached to electronic invoice pdf, Files to be attached for printing	pdf
4	printbydefault	Numeric	0...1	NOTE! Is not given if the attachment type is Finvoice (otherwise the request is rejected) 1= true, 0 = false	1
2	customtags	Aggr.	0...1
3	tag	Aggr.	1...n
4	tagname	String	1	The name of the customer additional field in Netvisor	Customer additional field name
4	tagvalue	String	1	Value of the additional field	Additional information
Attr.	type	String	1	Type of the additional field: float (selection list), date, text or enum (decimal number)	text

1*) If value is other than DomesticConstructionService is used in SalesInvoiceTaxHandling field, then value of this field is overriden with value DomesticConstructionService if invoice contains at least one line containing tax code Construction_Service_Sales. All lines in invoice must have same tax code.

2*) While importing a sales invoice, the material can include separate voucher lines, if the voucher is wanted to be formed manually. The system will use the voucher lines of the imported material, and not form voucher lines automatically if they have been included. The voucher lines in sales invoice are similar to those in Get Accounting Data request.

VAT identification	VAT-code	VAT precent
No VAT processing	NONE	0
Domestic sales	KOMY	0, 10, 14, 24
EU sales	EUMY	0
Sales outside the EU	EUUM	0
Domestic purchase	KOOS	0, 10, 14, 24
EU purchase	EUOS	0, 10, 14, 24
EU service purchase	EUPO	0, 10, 14, 24
Non - EU purchases	EUUO	0, 10, 14, 24
100% deductible tax	100	0
312 EU service sales	EUPM312	0
309 EU service sales	EUPM309	0, 10, 14, 24
Other turnover excluding VAT (310)	MUUL	0, 10, 14, 24
Purchases of goods from other EU countries, non-deductible	EVTO	0, 10, 14, 24
Purchases of services from other EU countries, non-deductible	EVPO	0, 10, 14, 24
Non-deductible reverse charge	EVKV	0, 10, 14, 24
Reverse charge	KAVE	0, 10, 14, 24
Sale of construction services	RAMY	0
Purchase of construction service	RAOS	0, 10, 14, 24
Non-deductible purchase of construction service	EVRO	0, 10, 14, 24
Non-EU imports VAT	MAAL	0, 10, 14, 24
Non-EU imports are not eligible for VAT deduction	EVMA	0, 10, 14, 24
Domestic sales	KOMY0	0

Delete sales invoice

Resource: deletesalesinvoice.nv

This resource differs from others by it doesn't need XML message to work. Request is transferred in URI.

With this resource it is possible to remove sales invoice or sales order and its attachments, dimension links, vouchers and etc.
Querystring parameters:

Parameter name	Occurs	Description
invoiceid	1	Invoice Netvisor ID
orderid	0...1	Sales order Netvisor ID

Update sales invoice status

Resource: updatesalesinvoicestatus.nv

This resource differs from others by it doesn't need XML message to work. Request is transferred in URI.
With this resource it is possible to update one or multiple (max 100) sales invoice statuses. If status is update to any other state than "unsent", sales invoice voucher is created automatically.
Querystring parameters:

Parameter name	Occurs	Example	Description
netvisorkey	1	145	Invoice Netvisor ID
netvisorkeylist	0...1	1, 2, 3	Invoices Netvisor ID list separated with comma
status	1	open	To which status invoice/invoices will be set - open - overdue - reminded - requested - collected - paid - creditloss - unsent

Deleted sales invoices

Resource: deletedsalesinvoices.nv

Retrieves sales invoices that have been deleted since the given date. Sales invoices can be retrieved up to 7 days from the given date.

Querystring parameters:

Parameter	Occurs	Description	Example
deletedsince	1	Mandatory parameter. Retrieves events that have been deleted since the given date. Events can be retrieved up to 7 days from the given date.	2022-06-08

Response:

Level	Element	Type	Occurs	Description	Example
root	root	Aggr.	1
1	DeletedSalesInvoices	Aggr.	1
2	DeletedSalesInvoice	Aggr.	0...n
3	NetvisorKey	Numeric	1	Netvisor ID of sales invoice	5
3	DeleteDate	Date	1	Delete date	2022-06-08 15:14
Attr.	format	String	1	Date format, always ansi	ansi

Deleted sales orders

Resource: deletedsalesorders.nv

Retrieves sales orders that have been deleted since the given date. Sales orders can be retrieved up to 7 days from the given date.

Querystring parameters:

Parameter	Occurs	Description	Example
deletedsince	1	Mandatory parameter. Retrieves events that have been deleted since the given date. Events can be retrieved up to 7 days from the given date.	2022-06-08

Response:

Level	Element	Type	Occurs	Description	Example
root	root	Aggr.	1
1	DeletedSalesOrders	Aggr.	1
2	DeletedSalesOrder	Aggr.	0...n
3	NetvisorKey	Numeric	1	Netvisor ID of sales order	5
3	DeleteDate	Date	1	Delete date	2022-06-08 15:14
Attr.	format	String	1	Date format, always ansi	ansi

Invoicing and delivering sales order

Resource: salesorderinvoicing.nv

This resource can be used for invoicing and/or delivering an existing sales order.

Querystring parameters:

Parameter	Occurs	Description
method	1	deliveryonly (only delivered) tai billanddelivery (to be delivered and invoiced)
copysublines	0...1	Copy subtotal rows to invoice; true or false
updatemidprice	0...1	Update the current average price for the products on the invoice row; true or false

The following describes the imported XML message (POST):

Level	Element	Type and length	Occurs	Desc	Esimerkki
1	root	Aggr.	1
2	salesorderinvoicing	Aggr.	1
3	invoicingcustomer	Aggr.	1
4	netvisorkey	String	1	Invoicing customer NetvisorID	1031
4	invoicedate	Date	1	Order date	2021-04-16
Attr.	format	Sting	1	Date format, always ansi	ansi
5	invoicingproductlines	Aggr.	1	Rows to be invoiced/delivered
6	invoicingproductline	Aggr.	1
7	netvisorkey	Numeric	1	NetvisorID of the sales order line	123
7	deliverydate	Date	1	Delivery date of the sales order line	2021-04-16
Attr.	format	String	1	Date format, always ansi	ansi
7	deliveryamount	String	1	Delivered amount	1
Attr.	ispostdelivery	Sting	1	Is post delivery; true or false	false
7	inventoryplace	String	0...1	Inventory place ID	321
Attr.	type	String	1	Always netvisor	netvisor

Import a comment into the sales order or invoice processing history

Resource: salesinvoicecomment.nv

The resource can be used to import a comment into the processing history of a sales order or invoice.

The following describes the imported XML message (POST):

Level	Element	Type and length	Occurs	Description	Examle
1	root	Aggr.	1
2	salesinvoicecomments	Aggr.	1
3	salesinvoicecomment	Aggr.	1
4	invoicetype	String	1	Invoice type: - order - invoice - invoicedraft	invoice
4	invoicenetvisorkey	Numeric	1	NetvisorID of the invoice, order or draft	123
4	comment	String, max 500	1	Comment to the processing history	comment

Matching credit note to invoice

Resource: matchcreditnote.nv

The resource can be used to match credit note to existing sales invoice. The invoice status of both invoices has to be "Sent" and vouchers have to be created. Credit note and invoice have to be in the same currency.

Level	Element	Type and length	Occurs	Description	Examle
1	root	Aggr.	1
2	matchcreditnote	Aggr.	1
3	creditnotenetvisorkey	Numeric	1	Credit note NetvisorKey	2597
3	invoicenetvisorkey	Numeric	1	Invoice NetvisorKey	2582

Get contract invoicing report

Resurssi: contractinvoicingreport.nv

This resource can be used to retrieve the contract invoicing report via API. 

Querystring parameters:

Parameter	Occurs	Description	Example
year	1	Mandatory paramater, predicted year	2022
collectionnetvisorkey	0...1	Optional, service basket's NetvisorKey	1

Response:

Level	Element	Type and length	Occurs	Description	Example
1	root	Aggr.	1
2	ContractInvoicing	Aggr.	1
3	ServiceCollection	Aggr.	1
4	Name	String	1	Service basket name
Attr.	Netvisorkey	Numeric	1	Service basket's NetvisorKey	2587
4	BeginDate	Päivämäärä	1	Invoicing periods from	01.04.2022
Attr.	Format	String	1	Date format, always ansi	ansi
4	EndDate	Päivämäärä	1	Invoicing periods until, if the element value is returned empty, the invoicing period is valid for until further notice
Attr.	Format	String	0...1	Date format, always ansi	ansi
4	PeriodInterval	Numeric	1	Invoicing period interval, indicates the numeric value of period interval.	2
Attr.	Type	String	1	Type of invoicing period interval, day, week, month, year	month
4	Periods	Aggr.	1
5	Period	Aggr.	1
6	Month	Numeric	1	Year and month of the contract invoicing report	2022-01
6	Invoiced	Numeric	1	Created invoices	14 016,00
6	Forecast	Numeric	1	Forecast sum	28 032,00
6	Total	Numeric	1	Total sum	42 048,00

Get Payment term list

This resource can be used to retrieve the payment term list

Resource: paymenttermlist.nv

Level	Element	Type and length	Occurs	Description	Example
root	root	Aggr.	1
1	PaymentTermList	Aggr.	1
2	PaymentTerm	Aggr.	0...n
3	NetvisorKey	Numeric	1	Payment Term's Netvisorkey	123
3	Description	String	1	Payment Term's description	14 days net
3	NetDays	Numeric	1	Number of net days	14
3	DiscountDays	Numeric	1	Number of discount days	5
3	DiscountPercent	Numeric	1	Discount Percentage	10
3	IsDefault	Numeric	1	Is this the default payment term, 1 = yes, 0 = no	1

Did you find it helpful? Yes No

Send feedback