IntegrationHTTP-methodResourceDTDSchemaExample
Get customer listGETcustomerlist.nv  Download
Get customer detailsGETgetcustomer.nv  Download
Import customer detailsPOSTcustomer.nvDownload Download
Delete customer detailsGETdeletecustomer.nv


Import customer officePOSToffice.nv DownloadDownload
Get sales personnel listGETsalespersonnellist.nv  Download

Get customer list

Resource: customerlist.nv

This section describes how to retrieve a list of customers from Netvisor. The customer list contains basic information (NetvisorID, name, customer's code, company ID and URI for retrieving detailed customer information). Detailed customer information can then be retrieved with Get Customer Details.

Querystring parameters:

Parameter nameOccursExampleDescription
keyword0...1Filters result list with given keyword. Match is searched from following fields: Name, Customer Code, Organization identifier, CoName 
changedsince0...1Filters result to contain only customers having change after given date, date in format YYYY-MM-DD2012-01-01
customercodelist0...1Filters result with given customercodes. Customercodes should be separated with comma. The list can include maximum of 100 alfanumeric customer codes.
Note! Parameter keyword can be used with customercodelist. Filters result with given customercodes AND with given keyword.
 

Keyword parameter is used over changedsince

Response:

LevelElement nameType and lengthOccursDescriptionExample
1CustomerListAggr.1  
2CustomerAggr.0...n  
3NetvisorKeyInteger1Customer identifier in Netvisor123
3NameString1Name of the customerCustomer X
3CodeString1Customer code234
3OrganisationIdentifierString1Customers organization identifier if not consumer customer12345678-9
3CustomerGroupIDInteger1Customer Group ID, where the customer belongs. Can be empty.2
3CustomerGroupNameString1Customer Group Name, where the customer belongs. Can be emptyCustomer group 1
3UriString1URI that can be used to get details of current customer/getcustomer.nv?id=123

Get customer details

Resource: getcustomer.nv

In order to retrieve the wanted customer details, the customer ID is needed. This can be picked from the customerlist.

Querystring parameters:

Parameter nameOccursExampleDescription
id1123ID of the customer 
idlist0...11,2,3Can be used to get the details of several customers with given id. Max. 500 identifiers
replyoption
0...11Returns customer's invoicing history details.

Response:

LevelElement nameType and lengthOccursDescriptionExample
1CustomerAggr.1  
2CustomerBaseInformationAggr.1  
3NetvisorkeyInteger1Customer Netvisor key1001
3InternalIdentifierString1Customer codeMM
3ExternalIdentifierString1Organization identifier1234567-8
3OrganizationUnitNumberInteger0...1Organization unit number0037123456715
3CustomerGroupNetvisorKeyString0...1Netvisor identifier of customer group 
3CustomerGroupNameString0...1Name of the customer group 
3NameString 1Name of the customerMatti Meikäläinen
3NameExtensionString 1Extension for the name of the customerToimitusjohtaja
3StreetAddressString 1Customer's street addressPajukuja 1
3AdditionalStreetAddressString1Address extension 
 3CityString 1Customer's post officeLappeenranta
3PostNumberString1Customer's post number53100
3CountryString0...1Country codeFI
Attr.TypeString 0...1Always ISO-3166ISO-3166
3PhoneNumberString 1Customer's phone number040 123 4567
3FaxNumberString 1Customer's fax number05 123 4567
3EmailString 1Customer's E-mail addressmatti.meikalainen@firma.fi
3HomePageUriString 1Customer's web sitewww.firma.fi
3IsActiveNumeric10 or 1, is customer active  1  
3IsPrivateCustomerNumeric10 or 1. Value 1 indicates customer is a private customer1
3EmailInvoicingAddressString E-mail invoice addressmatti.meikalainen@firma.fi
2CustomerFinvoiceDetailsAggr.1  
3FinvoiceAddressString1E-invoice addressFI10970021497
3FinvoiceRouterCodeString 1E-invoice operatorNDEAFIHH
2CustomerDeliveryDetailsAggr.1  
3DeliveryNameString 1Name for the deliveryMatti Meikäläinen
3DeliveryStreetAddressString1Delivery addressPajukuja 1
3DeliveryCityString1Delivery Post officeLappeenranta
3DeliveryPostNumberString1Delivery post number53100
3DeliveryCountryString0...1Delivery countryFI
Attr.typeString 0...1Always ISO-3166ISO-3166
2CustomerContactDetailsAggr.1  
3ContactPersonString 1Default contact person's name 
3ContactPersonEmailString 1Default contact person's E-mail address 
3ContactPersonPhoneString 1Default contact person's Phone number 
2CustomerContactPersonsAggr.0...1  
3CustomerContactPersonAggr.1  
4ContactPersonIDInteger1Contact person's NetvisorID1006
4ContactPersonFirstNameString1Contact person's first nameEric
4ContactPersonLastNameString1Contact person's last nameExample
2CustomerOfficeDetailsAggr.0...nCustomer offices details
 
3OfficeNetvisorKeyInteger1Office NetvisorID10
3OfficeNameString1Office nameHelsingin toimisto
3OfficePhoneNumberString1Office phone 040 312 654
3OfficeTelefaxNumberString1Office fax
05 321 654
3OfficeIdentifierString1Office identifierOfficeidentifier
3OfficeContactAddressAggr.1Office postal address
 
4StreetAddressString0...1Street addressKeskuskatu 1
4PostNumberString0...1Postcode00100
4CityString0...1CityHelsinki
4CountryString0...1CountryFinland
3OfficeVisitAddressAggr.1Visiting address
 
4StreetAddressString0...1Street addressKeskuskatu 1
4PostNumberString0...1Postcode00100
4CityString0...1CityHelsinki
4CountryString0...1CountryFinland
3OfficeFinvoiceDetailsAggr.1Office electronic invoicing details
 
4FinvoiceAddressString0...1E-invoice address (IBAN or EIA)003716264123
4FinvoiceRouterCodeString0...1E-invoice operator code003721291126
2CustomerAdditionalInformationAggr.1  
3CommentString 1Comment text 
3CustomerAgreementIdentifierString1Contract ID 
3ReferenceNumberString 1Standard reference 
3YourDefaultReferenceString1Your default reference 
3DefaultTextBeforeInvoiceLinesString1Default text before invoice rows 
3DefaultTextAfterInvoiceLinesString1Default text after invoice rows 
3DefaultPaymentTermString1Default payment term14 days net
Attr.NetvisorKey String1NetvisorKey (ID)2
3TaxHandlingTypeString1Default tax handling typecountrygroup
3BalanceLimitDecimal 1Customer's balance limit, two decimal accuracy. 
3DefaultSalesPersonString0...1Name of the default sales person 
3DiscountPercentageNumeric0...1Discount percentage10
3PriceGroupString0...1Price group in which customer is linked 
3FactoringAccountString0...1Customer's factoring account nameFactoring
Attr.NetvisorKeyNumeric1Factoring account's NetvisorID1
3InvoicingLanguage
String0...1Customer's invoicing languageFI
Attr. typeString
1Always ISO-3166

3CustomerDimensionsAggr.0...1

4DimensionAggr.0...n

5DimensionNameString1Customer specific dimension headerAnimals
Attr.NetvisorKeyString1Dimension header Netvisor ID4
5DimensionItemString1Customer specific dimension nameCats
Attr.NetvisorKeyString1Dimension Netvisor ID117
2AdditionalInformationAggr.0...1

3ReceivablesManagement
Aggr.1Customer's invoicing details
4TurnoverDays
Numeric1The turnover days for customer's invoices42
4TurnoverDeviation
Numeric1The turnover deviation for customer's invoices28

Import customer details

Recourse: customer.nv

With customer.nv old customer details can be edited or a new customer can be added to Netvisor.

When editing existing customer details, the XML should only include details that are intended to be updated. If the XML contains blank fields(elements), are these fields updated as blank in Netvisor.

If customerfinvoicedetails element is given, element content validity is not checked. The operator must be still found from system. Below is list of operator codes that are allowed in Netvisor:

OperatorCode
Aktia/PaikallisosuuspankkiHELSFIHH
ÅlandsbankenAABAFI22
Apix Messaging Oy003723327487
Apix Messaging Oy (old code)00372332748700001
BasWare Einvoices OyBAWCFI22
CGI Suomi (ent. Logica Suomi Oy)003703575029
Danske BankDABAFIHH
DNB Bank ASA, Finland BranchDNBAFIHX
Enfo003714377140
HandelsbankenHANDFIHH
InExchange Factorum ABINEXCHANGE
InExchange Factorum AB (old code)SE556700997101
Liaison Technologies Oy (ent. Anilinker)003708599126
Maventa003721291126
Netbox Finland Oy003726044706
NordeaNDEAFIHH
Notebeat Oy003717203971
OpusCapita (can be used until 31.12.2018)003710948874
OpusCapita Solutions OyE204503
OsuuspankkiOKOYFIHH
Pagero003723609900
POP PankkiPOPFFI22
PostNord Strålfors Oy 003701150617
Ropo Capital003714377140
SäästöpankkiITELFIHH
S-Pankki/LähiTapiolaSBANFIHH
Sproom ApSSPROOM
TeliaSonera Finland Oyj003714756079
Tieto Oyj
003701011385
PeppolPEPPOL

Querystring parameters:

Parameter nameOccursExampleDescription
method1AddAdd or Edit
id0...1123Must be defined if method = Edit, defines customer to update

If method has not been supplied or the customer to update is not found for the id, an INVALID_DATA -error with further information is returned.

The id of a customer to update can be obtained with Get Customer List, and salesperson id with Get Salespersonnel List.

The data to import is sent with the query as an XML with the following structure:

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1  
1customerAggr1  
2customerbaseinformationAggr.1  
3internalidentifierString, max 500...1Customer's identifierMM123
Attr.typeString0...1automatic (if given and internalidentifier is empty, customer's identifier in Netvisor will be the next free customer identifier)automatic
3externalidentifierString0...1Organization identifier123456-7
3organizationunitnumberString, max 170...1Organization unit number0037123456715
3nameString, max 2500...1Customer's nameMatti Meikäläinen
3nameextensionString, max 2500...1Extension for nameToimitusjohtaja
3streetaddressString, max 800...1Customer's Street addressPajukuja 1
3additionaladdresslineString, max 800...1Additional address line  
3cityString, max 800...1Customer's post officeLappeenranta
3postnumberString, max 500...1Customer's post number 53100
3countryString, 0...1Customer's country code FI
Attr.typeString0...1Always ISO-3166ISO-3166
3customergroupnameString, max 500...1Customer is attached to group by its name. If group does not exists, new group is createdAlennusasiakkaat
3phonenumberString, max 800...1Customer's phone number040 123456
3faxnumberString, max 800...1Customer's fax number 05 123456
3emailString, max 2000...1Customer's E-mail address matti.meikäläinen@firma.fi
3homepageuriString, max 800...1Customer www-address www.firma.fi
3isactiveInteger0...10 or 1, indicates whether customer is active 1
3isprivatecustomerInteger0...10 or 1, indicates whether customer is a Private Customer 1
3emailinvoicingaddressString, max 5000...1Valid e-mail invoice address. Can be given as a list, separated with ;. matti.meikäläinen@firma.fi
2customerfinvoicedetailsAggr.0...1  
3finvoiceaddressString 1E-Invoice address FI109700021497
3finvoiceroutercodeString1E-invoice operator, see valid values from list aboveNDEAFIHH
2customerdeliverydetailsAggr.0...1  
3deliverynameString, max 2500...1Recipient of the deliveryMatti Meikäläinen
3deliverystreetaddressString, max 800...1Street address Pajukuja 1
3deliverycityString, max 800...1Post office Lappeenranta
3deliverypostnumberString, max 500...1Post number 53100
3deliverycountryString0...1Country code FI
Attr.typeString 0...1Always ISO-3166ISO-3166
2customercontactdetailsAggr.0...1  
3contactnameString0...1  
3contactpersonString, max 800...1Contact person's name Matti Meikäläinen
3contactpersonemailString, max 2000...1Contact person's E-mail matti.maikalainen@firma.fi
3contactpersonphoneString, max 80 0...1Contact person's phone number 040 123 4567
2customeradditionalinformationAggr.0...1  
3commentString, max 25000...1Comment for the customer register  
3customeragreementidentifierString, max 350...1Contract ID 
3customerreferencenumberString 0...1standard reference 
3InvoicinglanguageString 0...1Invoice language: FI, EN or SE. If the element is not given by message, the default language is FinnishFI
Attr.typeString 0...1Always ISO-3166ISO-3166
3invoiceprintchannelformatInteger0...1Invoice print channel format
1= Invoice+bank transfer
2=Invoice
 1
Attr.typeString 1Always netvisornetvisor
3yourdefaultreferenceString, max 2000...1Your default reference 
3defaulttextbeforeinvoicelinesString, max 5000...1Default text before invoice rows 
3defaulttextafterinvoicelinesString, max 5000...1Default text after invoice rows 
3defaultpaymenttermString0...1Customer default payment term14 days net
Attr.typeString1netvisor (ID) or customer (name)customer
3defaultsecondnameString0...1Default second nameSecond name
Attr.typeString1netvisor (ID) or
customer (name)
customer
3paymentinterest
Integer0...1Penalty interest, value can be between 0-100
5
3balancelimitInteger0...1Customer balance limit5000
3defaultsalespersonAggr.0..1  
4salespersonidString 0...1Default salesperson's id  
Attr.typeString 1Always netvisornetvisor
2customerdimensiondetailsAggr.0...1

3dimensionAggr.1

4dimensionnameString1Default dimension header name. Created if needed.Project
4dimensionitemString1Dimension name. Created if needed.Project 1

Delete customer details

Resource: deletecustomer.nv

Resource can be used to delete single customer's details from Netvisor. The response is "OK" if the customer can be deleted and if the message fails, API tells the reason e.g. "The customer has invoices".

Query string parameter:

ParameterOccursExampleDescription
customerid1Customer's NetvisorKey (ID)

Import customer office

Resource: office.nv

Importing and editing customer's office details.
Querystring parameters:

ParameterOccursExampleDescription
method1AddAdd or Edit
customerid1123Customer's NetvisorID
officeid0...11Office NetvisorID, mandatory when editing existing

Notify these:

  • With edit you can remove information by giving tag as empty
  • Office name is mandatory, it can never be empty
  • FinvoiceAddress needs to be genuine OVT or IBAN-number
  • FinvoiceOperator accepts all the same ID's than other resources, see list above
LevelElementType and lengthOccursDescriptionExample
RootrootAggr.1  
1officeAggr.1  
2nameString1Office name 
2phonenumberString0...1Office phone 
2telefaxnumberString0...1Office fax 
2officeidentifierString0...1Office code
2officecontactaddressAggr.0...1Office postal information 
3streetaddressString1Street name 
3postnumberString1Post number 
3cityString1City 
3countryString1Country code  
Attr.typeString1Always ISO-3166
 
2officevisitaddressAggr.0...1Office visiting address 
3streetaddressString1Street name 
3postnumberString1Post number 
3cityString1City 
3countryString1Country code 
Attr.typeString1Always ISO-3166
 
2officefinvoicedetailsAggr.0...1Office electronic invoicing details
 
3finvoiceaddressString1E-invoice address (IBAN or OVT)
 
3finvoiceroutercodeString1E-invoice operator
 

Get sales personnel list

Resource: salespersonnellist.nv

Returns a list of sales personnel.

LevelElementTypeOccurencesDescriptionExample
RootrootAggr.1  
1SalesPersonnelListAggr.1  
2SalesPersonAggr.0...n  
Attr.NetvisorKeyString1Sales person's Netvisor id 1 
3FirstNameString1Sales person's first nameMatt
3LastNameString1Sales person's last nameSmith
3ProvisionPercentInteger1Sales person's provision percent10

 


xml
(716 Bytes)
xml
(456 Bytes)
xsd
(2.74 KB)
xml
xml
(717 Bytes)
xml
(3.11 KB)
xml
(758 Bytes)

Did you find it helpful? Yes No

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