An e-invoice transaction payment will be charged for each purchase invoice imported to Netvisor via API.

Purchase invoice resources have been developed for internal use and therefore purchase invoice resources don't support all related actions. They were published though as they will work as-is in many integrations. Known issues:

  • Attachment import is not (fully) supported (you can bring one attachment, which is handled as a picture of an invoice)
  • Vendors are not updated automatically by purchase invoice XML
IntegrationHTTP-methodResourceDTDSchemaExample
Get purchase invoice listGETpurchaseinvoicelist.nv  Download
Get purchase invoiceGETgetpurchaseinvoice.nv  Download
Get purchase invoice attachmentsGETgetattachments.nv  -
Import purchase invoicePOSTpurchaseinvoice.nvpurchaseinvoice.dtd Download
Update invoice status and post purchase invoice POSTpurchaseinvoicepostingdata.nvpurchaseinvoicepostingdata.dtd Download
Import purchace invoice circulationPOSTpurchaseinvoicecirculation.nv
purchaseinvoicecirculation.xsdDownload
Import purchase invoice accrualPOSTpurhaseinvoiceaccrual.nv
purchaseinvoiceaccrual.xsdDownload
Import vendorPOSTvendor.nv vendor.xsd 
Get vendorGETgetvendor.nv   

Get purchase invoice list

Resource: purchaseinvoicelist.nv

Querystring parameters:

Parameter nameOccursDescriptionExample
begininvoicedate0...1Invoice date lower limit2018-09-20
endinvoicedate0...1Invoice date upper limit2018-09-30
invoicenumber0...1Invoice number to get1001
invoicestatus0...1Invoice status: open, approved or acceptedopen
lastmodifiedstart0...1Finds invoices that are modified after given date2018-09-15
lastmodifiedend0...1Finds invoices that are modified before given date2018-09-15
purchaseinvoicebatchid0...1Finds invoices which were imported with the given batch ID. See purchase invoice batch handling123

Response:

LevelElement NameType and lengthOccursDescriptionExample
rootRootAggr.1  
1PurchaseInvoiceListAggr.1  
2PurchaseInvoiceAggr.0...n  
3NetvisorKeyNumeric1Invoice identifier in Netvisor123
3InvoiceNumberText1Invoice number345
3InvoiceDateDateTime1Invoide date2013-10-23
Attr.formatString1Format of InvoiceDate, Always ansiansi
3VendorString1Name of the vendorVendor Oy Ab
3VendorOrganizationIdentifierNumeric1Business ID (Y-tunnus)1234567-8
3SumNumeric1Invoice total sum100,00
3PaymentsNumeric1Invoice payments sum30,50
3OpenSumNumeric1Open sum of invoice69,50
3UriString1Url that can be used to get details of invoice/getpurchaseinvoice.nv?netvisorkey=123

Get purchase invoice

Resource: getpurchaseinvoice.nv

Get detailed information of a specific purchase invoice.

Querystring parameters:

Parameter nameOccursDescriptionExample
netvisorkey1Netvisor key of the invoice to retrieve. 1
netvisorkeylist0...1Can be used to get the details of several invoices with given id. Max. 500 identifiers.1,2,3
version0...1Used for returning single invoice line's dimension details inside the element (PurchaseInvoiceLine)
1 = Dimensions outside of the invoice line, used as default or if parameter not given
2 = Dimensions inside the invoice line 
2
include0...1- actions = What can be done to the invoice (approve, accept, reject, pay)
- handlinghistory = Invoice's handling history
- previewimage = Invoice's previewimage
actions
omitattachments0...1True = Exclude attachments
False = Include attachments
If parameter not given = True
false

Response:

LevelElement NameType and lengthOccursDescriptionExample
RootRootAggr.1 
1PurchaseInvoiceAggr.1 
2PurchaseInvoiceNumberString1Invoice number345
2PurchaseInvoiceDateDate1Invoide date2013-10-23
Attr.formatString1Format of InvoiceDate, Always ansiansi
2PurchaseInvoiceDeliveryDateDate1Delivery date2013-09-10
Attr.formatString1Format of DeliveryDate, Always ansiansi
2PurchaseInvoiceDueDateDate1Due date2014-01-09
Attr.formatString1Format of DueDate, Always ansiansi
2PurchaseInvoiceValueDateDate1Value date2013-12-03
Attr.formatString1Format of ValueDate, Always ansiansi
2PurchaseInvoiceReferencenumberString1Reference number of invoice1234
2PurchaseInvoiceAmountNumeric1Amount in two decimal accuracy1234,56
2PurchaseInvoicePaidAmountNumeric1Paid amount in two decimal accuracy1000,00
2ForeignCurrencyAmountNumeric1Amoun in foreign currency in two decimal accuracy1234,56
2ForeignCurrencyNameIDString1Currency codeEUR
2InvoiceStatusString1Status of the invoice
Note: Currently always returns 'open', incomplete functionality
open
2ApprovalStatusString1Purhase invoice's approval status:
new invoice=open
in factual verification=infactualverification
approved=approved
rejected=acceptrorrejected
approved
2PurchaseInvoiceOurReferenceString1Our reference 
2PurchaseInvoiceYourReferenceString1Your reference 
2PurchaseInvoiceDescriptionString1Invoice description 
2VendorNetvisorKeyNumeric1Vendor's Netvisor Key123
2VendorOrganizationIdentifierString1Vendor's Business ID (y-tunnus)1234567-8
2VendorCodeString1Vendor's Code23
2VendorNameString1Name of the vendor Vendor Inc
2VendorAddressLineString1Address of the vendor Pajukuja 5
2VendorPostNumberString1Vendor post number 53100
2VendorTownString1Vendor cityLappeenranta
2VendorCountryString1County code of the Vendor FI
2VoucherIDNumeric0...1Voucher's NetvisorKey1235
2IsAccountedString1Is invoice accountedTrue
2PreviewImageString0...nWhen action parameter in use
2AttachmentsAggr.0...1 
3AttachmentAggr.1...n 
4AttachmentBase64DataBase641Base64 encoded data of the attachment
4FileNameString1File name of the attachment Invoice1234.pdf
4ContentTypeString1MIME-type of attachment content Appication/pdf
4CommentString1Comment text
2InvoiceLinesAggr.0...1 
3PurchaseInvoiceLineAggr.1...n 
4NetvisorKeyString1Netvisor key 
4LineSumNumeric1Sum of the line 
4LineNetSumNumeric1Net sum of the line
4UnitPriceNumeric 1Price of a single unit (gross)
4VatPercentNumeric 1VAT percent 
4VatCodeString1VAT code
4DescriptionString1Description text 
4UnitString1Unit of measurement 
4OrderedAmountNumeric 1Amount of product ordered 
4PurchasePriceNumeric 1Unit purchase price 
4DeliveredAmountNumeric 1Amount of units delivered 
4ProductCodeString1Product identifier 
4DiscountPercentageNumeric 1Discount percentage 
4ProductNameString1Name of the product 
4AccountingSuggestionBookkeepingaccountNetvisorKeyString0...1Account suggestions Nevisorkey
4AccountingSuggestionBookkeepingAccountString0...1Account suggestion
4PurchaseInvoiceDimensionsAggr.0...1Levels 4 -5 -6 when version parameter is 2.
In other case levels 3-4-5

5DimensionAggr.1...n 
6DimensionNameString1Dimension 
6DimensionDetailNameString1Name of the dimension 
2LinkedPurchaseOrdersAggr.0...1If purchaseoders have been linked to a purchase invoice, returns their number and ID
3PurchaseOrderAggr.1...n 
4OrderNumberNumeric1Number of purchase order123
4NetvisorKeyNumeric0...1NetvisorID of purchase order
Note! If the number of purchase order has been added to purchase invoice in advance, the purchase order might not be in Netvisor
10

 When parameter actions is in use the following structure is added at the end of the message:

LevelElementType and lengthOccursDescriptionExample
2PostingLinesAccessAggr.1Purchase invoice accounting
3CanEditPostingLinesString1True or FalseTrue
3CanUserPostInvoiceString1True or FalseFalse
3SuggestPostingByDefaultString1True or FalseTrue
3CanEditAccountingSuggestionString1True or FalseFalse
2ActionsAggr.1What can be done to the purchase invoice with the user's rights
3ActionAggr.1...n

4IdString1Possible values:
approved
accepted
rejected
pay
accepted
4TypeString1Returns the resouce that can be used to deliver the actionpurchaseinvoicepostingdata
4DescriptionString1Explanation of the actionAccept the purchase invoice
2AlertsAggr.1If there are no alerts, only upper level tag is shown
3AlertAggr.1

4HeadingString1HeaderThe invoice is in a locked period
4DescriptionString1ExplanationAccepting the purchase invoice does not update any information because the invoice is in a locked period
2NotificationsAggr.1If there are no notifications, only upper level tag is shown
3NotoficationAggr.1

4HeadingString1Header
4DescriptionString1ExplanationVendor's bank account has been deleted, update bank account

When parameter handlinghistory is in use the following structure is added at the end of the message:

LevelElementType and lengthOccursDescriptionExample
2HandlingHistoryAggr.1Purchase invoice handling history
3HandlingHistoryLineAggr.1...n

4TypeString1EventInvoiceCreated
4HeadingString1HeaderCreated
4DescriptionString1ExplanationInvoice created in the system
4TimestampDate1Timestamp2018-01-01 09:45:49:000
Attr.formatString1Date format, always ansiansi
4UserNameString1Name of the user who performed the actionEric Example
4UserEmailString1Email of the user in the compayn if it is defined and the user is not "System"eric.example@company.com.test
4UpdatedInformationFieldsAggr.0...nUpdated information
5FieldNameString1InfomationAccounted
5OldValueString1Old valueNo
5NewValueString1New valueYes

Get purchase invoice attachments

Resource: getattachments.nv

Returns purchase invoice attachments.

Also returns purchase invoice's finvoice-style attachment as an image.

ParameterOccursDescriptionExample
attachmentsource1Always purchaseinvoice
purchaseinvoice
netvisorkey1Netvisor ID of the purchase invoice123
convertpdfstoimages0...1With value true pdf attachments are converted to png images.
Every pdf page as their own image.
true

Response:

LevelElementTypeOccursDescriptionExample
rootRootAggr.1  
1AttachmentsAggr.1  
2AttachmentAggr.1...n  
3AttachmentNetvisorKeyNumeric1Netvisor ID of attachment123
3AttachmentPageNumberNumericPage number1
3FileNameStringDate of invoiceTestimage.jpg
3FileTypeString1 image/png
3ContentStringBase64 encoded fileiVBORw0KGgoAAAANSUhEUgAAB

Import purchase invoice

Resource: purchaseinvoice.nv

An e-invoice transaction payment will be charged for each purchase invoice imported to Netvisor via API.

Proper attachments can not be imported for purchase invoice, an attachment is handled as a picture of the invoice. The content of the attachment has not been limited, though. Imported attachment is found in the purchase invoice view as a picture. Even though the DTD determines that more than one attachment can be included, in practice only the first one can be shown in the user interface. Purchase invoice attachments have to be in PDF-format.

InvoiceSource must be finvoice to import an attachment.

During the import vendor card is created if vendor is missing from Netvisor. When importing, the vendor is focused to existing vendor by following rules:

  1. Focus on existing vendor if account number and name matches with the invoice and VAT number is the same as on invoice
  2. Focus on existing vendor if account number matches with the invoice and VAT number is the same as on invoice
  3. Focus on existing vendor if account number and name matches with the invoice
  4. Focus on existing vendor if name matches with the invoice and VAT number is the same as on invoice
  5. Focus on existing vendor if account number matches with the invoice and VAT number is empty
  6. Focus on existing vendor if account number matches with the invoice
  7. Focus on existing vendor if VAT number is the same as on invoice
  8. Focus on existing vendor if name matches with the invoice

If non of the above applies, new vendor is created.

Request:

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1 
1purchaseinvoiceAggr.1 
2invoicenumberString1Number of the invoice12345
2invoicedateDate 1Date of the invoice 2014-03-03
Attr.formatString1Date format, always ansiansi
Attr.findopendateString0...1Only true is acceptedtrue
2invoicesourceString0...1Can be manual or finvoicefinvoice
2valuedateDate 0...1Currently this is needed in order to import purchase invoices in despite of being marked optional in DTD2014-03-03
Attr.formatString1Date format, always ansiansi
2eventdateDate0...1Event date for purchase invoice voucer2014-03-31
Attr.formatString1Date format, always ansiansi
2duedateDate 1Due date of the invoice2014-03-17
Attr.formatString1Date format, always ansi
2purchaseinvoiceonroundString0...1Defines the status of PurchaseInvoice. Can be open, approved or acceptedopen
Attr.typeString1Type of status, default netvisor netvisor
2vendornameString, max 2500...1Name of the vendorMy Vendor
2vendoraddresslineString, max 800...1Address of the vendor 
2vendorpostnumberString, max 500...1Post number of the vendor 
2vendorcityString, max 500...1City of the vendor 
2vendorcountryString, max 500...1Country code of the vendor FI
2vendorphonenumberString, max 800...1Vendor's phone number 
2vendorfaxnumberString, max 800...1Vendor's fax number 
2vendoremailString, max 800...1Vendor's E-mail address 
2vendorhomepageString, max 800...1Vendor homepage 
2amountNumeric1Total of the invoice, this will be approximated to 2 decimals100,00
2accountnumberString0...1Account number FI1000111234567
2organizationindentifierString0...1Organiztion identifier 123456-7
2deliverydateDate 0...1Invoice delivery date 2014-03-03
Attr.formatString1Date format, always ansi 
2overduefinepercentNumeric 0...1overduefine percent 
2bankreferencenumberString, max 700...1Bank reference or purchase order message1234567
2ourreferenceString, max 2000...1Our reference 
2yourreferenceString, max 2000...1Your reference 
2currencycodeString0...1Currency, currencycode and accountnumber must be given in order to have the exchange calculation done correctlyGBP
2deliverytermsString, max 2550...1Terms of delivery 
2deliverymethodString, max 2550...1Method of delivery 
2commentString, max 255 0...1Comment 
2checksumString0...1Checksum 
2pdfextrapagesNumeric 0...1 
2readyforaccountingNumeric 0...1If given ( and invoices status is approved/accepted ), interface will approve / accept it and form a voucher for accounting1
2primaryvendormatchtypeString0...1Possible to force vendormatch by value:
- code
- name
- bankaccountnumber
- organizationid
If no vendor found with the given value, then default procedure is followed
code
2purchaseinvoicelinesAggr.1 
3purchaseinvoicelineAggr.1...n 
4productcodeString, max 50 0...1Product code 340
4productnameString, max 2001Name of the product Test Product
4orderedamountNumeric 0...1Amount ordered 12
4deliveredamountNumeric 1Amount delivered 12
4unitnameString0...1Unit of measurement 
4unitpriceNumeric 1Price of a single unit 3,81
4discountpercentageNumeric 0...1Discount percentage 1,52
4vatpercentNumeric1VAT percentage 24
4linesumNumeric 1Total of the line, this will be approximated to 2 decimals45,72
Attr.typeString1Type of sum, default is brutto (gross)brutto
4descriptionString, max 200 0...1Description text
4sortNumeric 0...1 
4accountingsuggestionNumeric 0...1If not given, default from company's default accounts will be used (based on vendor's country code)4000
4dimensionAggr.0...n 
5dimensionnameString, max 501Dimension header
Project
5dimensionitemString, max 2001Dimension name 8890
2purchaseinvoicecommentlinesAggr.0...1 
3purchaseinvoicecommentlineAggr.1...n 
4commentString1Comment text 
4sortString0...1 
2purchaseinvoiceattachmentsAggr.0...1

 


3purchaseinvoiceattachmentAggr.1...nOnly PDF-format supported. Attachmnet is handled as a picture of the invoice. 
4mimetypeString1MIME-type of the attachment
4attachmentdescriptionString1Description of the attachment 
4filenameString1The name of attached file
4documentdataString1In Base64 format

Update invoice status and post purchase invoice

Resource: purchaseinvoicepostingdata.nv

 The resource can be used for rejecting, verifying, or approving a purchase invoice as well as for posting. When importing, you can also edit posting lines.

When using this resource, Netvisor user rights of the owner of the used api user keys are checked. This user needs rights to post/verify/approve purchase invoices.

The purchase invoice that you want to verify, accept, or reject must be in state 'open'. The row data are the same as in importing purchase invoice (purchaseinvoice.nv), the row data that is imported replaces the row data on the purchase invoice in Netvisor. Sums in row data must match the purchase invoice amount, otherwise import will end up to error.

A purchase invoice can be posted without changing invoice status when element IsReadyForAccounting is given with value 1 and leaving out the Status element  Depending on the status of the purchase invoice, either this pre-posts or posts the invoice, such as in the Netvisor user interface.

LevelElementType and lengthOccursDescriptionExample
rootRootAggr.1  
1PurchaseInvoicePostingDataAggr.1  
2PurchaseInvoiceNetvisorKeyNumeric1Netvisor ID of purchase invoice 31646 
2StatusString1Purchase invoice status, in that order they can be given:
contentsupervisorrejected (hylätty asiatarkastuksessa)
approved (asiatarkastettu)
acceptrrejected (hylätty hyväksynnässä)
accepted (hyväksytty)

Invoice status cannot be update to a previous state
approved
2EventDateDate0...1Event date2019-01-15
Attr.formatString1Event date format, always ansiansi
2IsReadyForAccountingNumeric1If value 1 is given Netvisor will generate voucher automatically. If value is not given posting will be done manually in Netvisor.1
2CommentString, max 30000...1Comment of purchase invoice Example comment 
3PurchaseInvoicePostingLineAggr.0...n  
4purchaseinvoicelinenetvisorkeyNumeric0...1Purchase invoice row NetvisorID12345
4ProductCodeString0...1Product code123
4ProductNameStringProduct name
Can be left out by giving but it will overwrite the possible existing text in Netvisor.
Example product
4OrderedAmountNumeric0...1 Number of ordered products 
4DeliveredAmountNumericNumber of delivered products 
4UnitNameString0...1 Unit of measurekpl
4UnitPriceNumericUnit price 
4DiscountPercentageNumeric0...1 Discount percentage 
4VatPercentNumericVAT percent 
Attr.vatcodeString1VAT code 
4LineSumNumeric1Will be rounded to two decimals 
AtypeString1Only gross (brutto)gross
4DescriptionString0...1Description 
4SortNumeric 0...1Row running number1
4AccountingSuggestionNumeric0...1Accounting suggestion
If not given, default accounts in Netvisor will be used
 
4DimensionAggr.0...n  
5DimensionNameString, max 2001Dimension header 
5DimensionItemString, max 2001Dimension name 

Import purchase invoice circulation

Resource: purchaseinvoicecirculation.nv

Resource can be used for setting, editing or deleting purchase invoice circulation.

The identification of circulation users is done using email address. If the user has an email address saved in Netvisor's User settings Company-specific exceptions, this email address is used. Users email address has to be unique in the company.

The user set for circulation has to have sufficient Accounts receivable and accounts payable rights in Netvisor to factually verify and/or accept purchase invoices. In addition there shouldn't be a vendor or sum limit that prevents circulation. Note! The API user must have a right for setting purchase invoice's approval circulation in Accounts receivable and accounts payable rights in Netvisor.

The resource can be used to set multiple circulations at the same time in one message. If API responds with "OK", the circulation for all purchase invoices has been set. If API responds with an error, importing purchase invoice circulation failed for all invoices in the same message. ValidDataIdentifier-element is returned for those purchase invoices where importing purchase invoice circulation would have been successfull without the error.

Deleting purchase invoice circulation is done by not importing factual verificators and approver fot the invoice.

The last imported factual verficator will be set as invoice's main factual verificator.

Importing circulation lists or forced circulation is not supported. If the purchase invoice already has circulation and a user has accepted or factually verified the invoice, the circulation can not be edited via API.

The following describes the XML message to import (POST) purchase invoice circulation into Netvisor:

LevelElementFormatOccursDescriptionExample
RootrootAggr.1  
1purchaseinvoicecirculationsAggr.1

2purchaseinvoicecirculationAggr.1Circulation for one purchase invoice
3invoiceidentifierAggr.1Purchase invoice identifier, NetvisorID or invoice number
4netvisorkeyNumeric0...1Purchase invoice NetvisorID123
4invoicenumberNumeric0...1Purchase invoice number123
3factualverificatorAggr.0...nFactural verificators
4emailString1Email addressverificator@company.com
3approverAggr.0...1Purchase invoice approver
4emailString1Email addressapprover@company.com
3commentString, max 2500...1Comment for handling historyVerificators and approver set by integration X.

Import purchase invoice accrual

Resource: purchaseinvoiceaccrual.nv

Purchase invoice can be accrued by giving start month and year and end month and year or start month and year or divisioncurve. Accual end time can not be before the start time and start time can be invoice's event month at the earliest. The invoice accrued can't be accounted. The purchase invoice can not be accrued on a locked period.

When using divisioncurve the accrual can have monthly percentage values. When using start month and year and end month and year the accrual is done using even percentage for the given time span. For example 3/2021-4/2021 accrues the invoice rows for March and April with 50%.

The following describes the XML message to import (POST) purchase invoice accrual into Netvisor:

LevelElementFormatOccursDescriptionExample
RootrootAggr.1  
1purchaseinvoiceaccrualAggr.1Purchase invoice accrual
2invoiceidentifierAggr.1Purchase invoice identifier, either NetvisorID or invoice number
3netvisorkeyNumeric0...1Purchase invoice NetvisorID123
3invoicenumberString0...1Purchase invoice number123
2accrualruleAggr.1Accrual rule
3startmonthNumeric1Accrual start month3
3startyearNumeric1Accrual start year2021
3divisioncurvenameString, max 2500...1Division curve name, has to be uniqueDepreciations
3endmonthNumeric0...1Accrual end month4
3endyearNumeric0...1Accrual end year2021

Import vendor

Resource: vendor.nv

Add a new vendor or edit existing vendor.

API returns vendor's NetvisorKey. We reccomend to store it somewhere, if you want to get of change verdor information afterwards. For now, the NetvisorKey cannot be obtained via API. Through Netvisor UI NetvisorKey can be obtained when opening the vendor and looking the serch bar, where is id (e.g. id=123).

Parameters:

ParameterOccursDescriptionExample
method1Add Add new vendor
Edit Edit existing vendor

netvisorkey0...1Vendor's NetvisorKey
Mandatory if method = edit

XML-message (POST-data):

LevelElementTypeOccursDescriptionExample
RootrootAggr.1  
1vendorAggr.1  
2vendorbaseinformationAggr.1  
3codeString0...1Vendor code123
3nameString1Vendor nameTestitoimittaja
3addressString0...1AdressToimittajakatu 1
3postcodeString0...1Postal code00100
3cityString0...1CityHelsinki
3countryString0...1County codeFI
Attr.typeString1Type of county codeISO-3166
3organizationidString0...1Business ID (Y-tunnus)123456-7
3groupnameString0...1Vendor groupThe toimittajat
3vendorbankaccountsAggr.0...1Vendor's bank accounts
 
4vendordomesticbankaccounts Aggr.0...1  
5vendordomesticbankaccountAggr.0...8Finnish bank accounts
 
6netvisorkeyNumeric0...1Bank account's NetvisorKey
1
6ibanString1Account number (IBAN)FI7536359370000661
6banknameString1Bank nameTestipankki
6isdefaultString0...1Use as a default or notTrue
4vendorforeignbankaccounts Aggr.0...1  
5vendorforeignbankaccountAggr.0...8Foreign bank accounts
 
6netvisorkeyNumeric0...1Bank account's NetvisorKey2
6bbanString1Account number (IBAN)GB29NWBK60161331926819
6bicswiftString1BIC code
BUKBGB22
6banknameString1Bank nameBarclays
6clearingcodeString0...1Clearing code
 
6clearingnumberString0...1Clearing number
 
6bankaddresssString0...1Bank address
Bank Street 1
6countryString1Country codeGB
Attr.typeString

1

Country code type ISO-3166
6currencycodeString1Currency codeGBP
AttypeString1Currency code typeISO-4217
6isdefaultString0...1Use as a default or notFalse
6includeaddresssinforeignpaymentsString0...1Add bank's address information to payment message besides BIC codeTrue
2vendorcontactdetailsAggr.0...1Vendor's contact information 
3phonenumberString0...1Phone number+35850123456
3emailString0...1Emailtoimittaja@toimittajat.fi
3faxnumberString0...1Fax 
3contactpersonnameString0...1Contact person's nameTimo Testaaja
3contactpersonphonenumberString0...1Contact person's phone number+35840987654
3contactpersonemailString0...1Contact person's emailtimo.testaaja@toimittajat.fi
3homepageString0...1Home page 
3commentString0...1CommentNo comments
2vendoradditionalinformationAggr.0...1  
3defaultvatpercentNumeric0...1Default VAT percent24
3ispartialvatreduceprivilegedString0...1Partial VAT reduced priviledgedFalse
3paymenttermdiscountpercentNumeric0...1Discount percentage
 
3paymenttermcashdiscountsdaysNumeric0...1Discount days
 
3paymenttermnetdaysNumeric0...1Default payment term days 
3currencycodeCurrency code0...1Default currencyEUR
Attr.  typeString1Currency code typeISO-4217
3vendordimensionsAggr.0...1Default dimensions 
4dimensionAggr.1
5dimensionnameString1Dimension nameProjects
5dimensionitemString1Dimension itemProject 1
3vendoraccountingaccountsAggr.0...1Vendor accounting accounts 
4vendoraccountingaccountAggr.1...n  
5accountnumberString1Account number4000
5isdefaultString1Use as a default or notTrue
3vendoracceptancedetailsAggr.0...1Acceptors 
4vendoracceptancedetailAggr.1...n  
5acceptancenameString0...1Acceptor nameTaaki Tarkastaja
5isdefaultString0...1Use as a default or notFalse
5isforcedString0...1  

Get vendor

Resource: getvendor.nv

Returns vendor information. 

Through Netvisor UI NetvisorKey can be obtained when opening the vendor and looking the serch bar, where is id (e.g. id=123).

Parameters:

ParameterOccursDescriptionExample
netvisorkey1Netvisor key of the vendor. The root element in the response is "vendor"1
netvisorkeylist0...1Can be used to get the details of several vendors with given id. 
Note that there should be a vendor with all given IDs, otherwise the API will return an error message.
The root element in the response is "vendors" if there are several IDs given.
1,2,3
changedsince0...1Filters result to contain only vendors having change after given date, date in format YYYY-MM-DD or time in format YYYY-MM-DDTHH:MM:SS.

The root element in the response is "vendors" if there are several IDs given. If there are no changes vendor details, the content of the vendors element is empty.

page0...1Parameter can be used to get vendors in the groups of 500. Each page must be called in a separate request.

Page information is included in the response header information e.g.
X-Netvisor-Pagination-Current-Page : 2
X-Netvisor-Pagination-Previous-Page : 1
X-Netvisor-Pagination-Next-Page : 3
X-Netvisor-Pagination-Limit : 100
X-Netvisor-Pagination-Total-Count : 1000

 

2

Response:

LevelElementTypeOccursDescriptionExample
RootrootAggr.1  
1vendorAggr.1The root element in the response is "vendor" or "vendors", see parameter descriptions. 
2NetvisorKeyNumeric1Vendor's Netvisor Key123
2vendorbaseinformationAggr.1  
3codeString0...1Vendor code123
3nameString1Vendor nameTestitoimittaja
3addressString0...1AddressToimittajakatu 1
3postcodeString0...1Postal code00100
3cityString0...1CityHelsinki
3countryString0...1County codeFI
Attr.typeString1Type of county codeISO-3166
3organizationidString0...1Business ID (Y-tunnus)123456-7
3groupnameString0...1Vendor groupThe toimittajat
3vendorbankaccountsAggr.0...1Vendor's bank accounts 
4vendordomesticbankaccounts Aggr.0...1  
5vendordomesticbankaccountAggr.0...8Finnish bank accounts 
6netvisorkeyNumeric0...1Bank account's NetvisorKey1
6ibanString1Account number (IBAN)FI7536359370000661
6banknameString1Bank nameTestipankki
6isdefaultString0...1Use as a default or notTrue
4vendorforeignbankaccounts Aggr.0...1  
5vendorforeignbankaccountAggr.0...8Foreign bank accounts 
6netvisorkeyNumeric0...1Bank account's NetvisorKey2
6ibanString1Account number (IBAN)GB29NWBK60161331926819
6bicswiftString1BIC codeBUKBGB22
6banknameString1Bank nameBarclays
6clearingcodeString0...1Clearing code 
6clearingnumberString0...1Clearing number 
6bankaddresssString0...1Bank addressBank Street 1
6countryString1Country codeGB
Attr.typeString

1

Country code typeISO-3166
6currencycodeString1Currency codeGBP
Attr.typeString1Currency code typeISO-4217
6isdefaultString0...1Use as a default or notFalse
6includeaddresssinforeignpaymentsString0...1Add bank's address information to payment message besides BIC codeTrue
2vendorcontactdetailsAggr.0...1Vendor's contact information 
3phonenumberString0...1Phone number+35850123456
3emailString0...1Emailtoimittaja@toimittajat.fi
3faxnumberString0...1Fax 
3contactpersonnameString0...1Contact person's nameTimo Testaaja
3contactpersonphonenumberString0...1Contact person's phone number+35840987654
3contactpersonemailString0...1Contact person's emailtimo.testaaja@toimittajat.fi
3homepageString0...1Home page 
3commentString0...1CommentNo comments
2vendoradditionalinformationAggr.0...1  
3defaultvatpercentNumeric0...1Default VAT number24
3ispartialvatreducedprivilegedString0...1Partial VAT reduced priviledgedFalse
3paymenttermdiscountpercentNumeric0...1Discount percentage 
3paymenttermcashdiscountsdaysNumeric0...1Discount days 
3paymentermnetdaysNumeric0...1Default payment term days 
3currencycodeCurrency code0...1Default currencyEUR
Attr.  typeString1Currency code typeISO-4217
3vendordimensionsAggr.0...1Default dimensions 
4dimensionAggr.1Dimension nameKohde
5dimensionnameString1Dimension nameProjects
5dimensionitemString1Dimension itemProject 1
3vendoraccountingaccountsAggr.0...1Vendor accounting accounts 
4vendoraccountingaccountAggr.1...n  
5accountnumberString1Account number4000
5accountnameString1Account nameOstot
5isdefaultString1Use as a default or notTrue
3vendoracceptancedetailsAggr.0...1Acceptors 
4vendoracceptancedetailAggr.1...n  
5acceptancenameString0...1Acceptor nameTaaki Tarkastaja
5isdefaultString0...1Use as a default or notFalse
5isforcedString0...1  



xml
(330 Bytes)
xml
(506 Bytes)
xml
xml
xml
xml

Did you find it helpful? Yes No

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