Asiakasrekisterin käsittelyn toiminnot jakautuvat seuraaviin toimintoihin:

IntegraatioHTTP-metodiResurssiDTDSkeemaEsimerkki
Asiakaslistan noutoGETcustomerlist.nv  Lataa
Asiakastietojen noutoGETgetcustomer.nv  Lataa
Asiakastietojen tuontiPOSTcustomer.nvLataa Lataa
Asiakkaan poistoGETdeletecustomer.nv


Asiakkaan toimipaikan tuontiPOSToffice.nv LataaLataa
Myyjälistan noutoGETsalespersonnellist.nv  Lataa

Huomaathan artikkelin asiakasrekisterin päivityksen suositelluista toimintamalleista.

Asiakaslistan nouto

Resurssi: customerlist.nv

Netvisorin asiakaslistan nouto. Asiakaslista sisältää asiakkaiden perustietoja (NetvisorID, nimi, asiakkaan koodi, Y-tunnus yritysasiakkaille, URI tarkempien asiakastietojen hakuun). Tarkemmat asiakastiedot voidaan tämän jälkeen noutaa käyttäen toimintoa Asiakastietojen nouto.

Kutsussa käytettävät parametrit:

ParametriIlmentymiäKuvausEsimerkki
keyword0...1Suodattaa listaa annetulla keywordillä. Palauttaa listalle ne asiakkaat, joilta löytyy keyword*.
Osumaa etsitään kentistä Nimi, Asiakasnumero, Y-tunnus, CoNimi
 
changedsince0...1Suodattaa asiakkuudet, joissa muutoksia annetun päivämäärän jälkeen. Päivämäärä muodossa YYYY-MM-DD2014-09-13
customercodelist0...1Pilkkueroteltu lista asiakaskoodeja, jonka mukaan suodattaa palautettavat asiakkaat. Lista saa sisältää enintään 100 alfanumeerista asiakaskoodia. Huom! Keyword-parametrin voi antaa customercodelist-parametrin kanssa. Tällöin resurssi palauttaa ne asiakkaat, joilla on listalta löytyvä asiakaskoodi JA keyword jossain keywordin etsimässä kentässä. 

Jos keyword-parametri on annettu, changedsince jätetään huomioimatta.

Vastaus:

TasoElementtiMuotoIlmentymiäKuvausEsimerkki
1CustomerlistAggregaatti1  
2CustomerAggregaatti0...n  
3NetvisorkeyNumero1Asiakkaan Netvisor tunnus (Netvisor kanta-id)123
3NameMerkkijono1Asiakkaan nimiAsiakas 1
3CodeMerkkijono1Asiakkaan koodi234
3OrganisationidentifierMerkkijono1Asiakkaan yritystunnus jos ei kuluttaja-asiakas12345678-9
3CustomerGroupIDNumeerinen 1Asiakasryhmän ID, johon asiakas kuuluu. Voi olla myös tyhjä.2
3CustomerGroupNameMerkkijono 1Asiakasryhmän nimi, johon asiakas kuuluu. Voi myös olla tyhjä.Asiakasryhmä 1
3UriMerkkijono1Osoite, josta voidaan hakea asiakkaan yksityiskohdat /getcustomer.nv?id=123

Asiakastietojen nouto

Resurssi: getcustomer.nv

Ennen asiakastiedon noutoa Netvisorista on noudettava asiakaslista, josta poimitaan asiakkaan tunniste (NetvisorKey). Tämän avulla voidaan noutaa tarkemmat tiedot. Asiakkaan tiedot voi noutaa joko asiakas kerrallaan tai idlist -parametria käyttämällä maks. 500 asiakkaan tiedot.

Kutsussa käytettävät parametrit:

ParametriIlmentymiäEsimerkkiKuvaus
id1123Haettavan asiakkaan NetvisorKey eli ID
idlist0...11,2,3Palauttaa yhdessä pyynnössä täydet tiedot kaikista halutuista asiakkaista, max. 500 ID:tä

Vastaus:

TasoElementtiMuotoIlmentymiäKuvausEsimerkki
1CustomerAggregaatti1  
2CustomerBaseInformationAggregaatti1  
3NetvisorkeyNumeerinen1Asiakkaan Netvisor-tunnus1001
3InternalIdentifierMerkkijono1AsiakaskoodiMM
3ExternalIdentifierMerkkijono1Y-tunnus1967543-8
3OrganizationUnitNumberNumero0...1OVT-tunnus00371967543815
3CustomerGroupNetvisorKeyMerkkijono0...1Asiakasryhmän tunniste 
3CustomerGroupNameMerkkijono0...1Asiakasryhmän nimi 
3NameMerkkijono1Asiakkaan nimiMatti Meikäläinen
3NameExtensionMerkkijono1Asiakkaan nimen jatkeToimitusjohtaja
3StreetAddressMerkkijono1KatuosoitePajukuja 1
3AdditionalStreetAddressMerkkijono1Laskutusosoitteen lisäkenttä 
3CityMerkkijono1PostitoimipaikkaLappeenranta
3PostNumberMerkkijono1Postinumero53100
3CountryMerkkijono0...1Maatieto ISO-3166 muodossaFI
Attr.TypeMerkkijono0...1Maatiedon esitystapa, aina ISO-3166ISO-3166
3PhoneNumberMerkkijono1Puhelinnumero040 123 456
3FaxNumberMerkkijono1Fax-numero05 123 456
3EmailMerkkijono1Sähköpostiosoitematti.meikalainen@firma.fi
3HomePageUriMerkkijono1www-osoitewww.firma.fi
3IsActiveNumero10 tai 1 riippuen siitä onko asiakas aktiivinen1
3IsPrivateCustomerNumero11 jos on henkilöasiakas, 0 jos ei ole henkilöasiakas1
3EmailInvoicingAddressMerkkijono1Sähköpostilaskutusosoitematti.meikalainen@firma.fi
2CustomerFinvoiceDetailsAggregaatti1  
3FinvoiceAddressMerkkijono1VerkkolaskuosoiteFI10970021497
3FinvoiceRouterCodeMerkkijono1VerkkolaskuoperaattoriNDEAFIHH
2CustomerDeliveryDetailsAggregaatti1  
3DeliveryNameMerkkijono1Toimituksen nimi 
3DeliveryStreetAddressMerkkijono1Toimitusosoite 
3DeliveryCityMerkkijono1Postitoimipaikka 
3DeliveryPostNumberMerkkijono1Postinumero 
3DeliveryCountryMerkkijono0...1Maatieto 
Attr.typeMerkkijono0...1Maatiedon esitystapa, aina ISO-3166ISO-3166
2CustomerContactDetailsAggregaatti1  
3ContactPersonMerkkijono1Oletusyhteyshenkilön nimi 
3ContactPersonEmailMerkkijono1Oletusyhteyshenkilön sähköposti 
3ContactPersonPhoneMerkkijono1Oletusyhteyshenkilön Puhelinnumero 
2CustomerContactPersonsAggregaatti0..1  
3CustomerContactPersonAggregaatti1  
4ContactPersonIDNumeerinen1Yhteyshenkilön NetvisorID1006
4ContactPersonFirstNameMerkkijono1Yhteyshenkilön etunimiEric
4ContactPersonLastNameMerkkijono1Yhteyshenkilön sukunimiExample
2CustomerOfficeDetailsAggregaatti0...nAsiakkaan toimipaikan tiedot
 
3OfficeNetvisorKeyNumeerinen1Toimipaikan Netvisor-tunnus10
3OfficeNameMerkkijono1Toimipaikan nimiHelsingin toimisto
3OfficePhoneNumberMerkkijono1Toimipaikan puhelinnumero040 312 654
3OfficeTelefaxNumberMerkkijono1Toimipaikan faksi05 321 654
3OfficeIdentifierMerkkijono1Toimipaikan tunnustoimipaikkatunnus
3OfficeContactAddressAggregaatti1Toimipaikan postiosoitetiedot 
4StreetAddressMerkkijono0...1KatuosoiteKeskuskatu 1
4PostNumberMerkkijono0...1Postinumero00100
4CityMerkkijono0...1KaupunkiHelsinki
4CountryMerkkijono0...1MaaSuomi
3OfficeVisitAddressAggregaatti1Toimipaikan käyntiosoitteen tiedot 
4StreetAddressMerkkijono0...1KatuosoiteKeskuskatu 1
4PostNumberMerkkijono0...1Postinumero00100
4CityMerkkijono0...1KaupunkiHelsinki
4CountryMerkkijono0...1MaaSuomi
3OfficeFinvoiceDetailsAggregaatti1Toimipaikan verkkolaskutiedot 
4FinvoiceAddressMerkkijono0...1Verkkolaskuosoite (IBAN tai OVT)003716264123
4FinvoiceRouterCodeMerkkijono0...1Verkkolaskuoperaattori003721291126
2CustomerAdditionalInformationAggregaatti1  
3CommentMerkkijono1Kommenttiteksti 
3CustomerAgreementIdentifierMerkkijono1Sopimustunnus 
3ReferenceNumberMerkkijono1Vakioviite 
3YourDefaultReferenceMerkkijono1Oletusviitteenne 
3DefaultTextBeforeInvoiceLinesMerkkijono1Oletusteksti ennen laskurivejä 
3DefaultTextAfterInvoiceLinesMerkkijono1Oletusteksti jälkeen laskurivien 
3DefaultPaymentTermMerkkijono1Oletusmaksuehto14 päivää netto
Attr.NetvisorKeyMerkkijono1NetvisorKey (ID)2
3TaxHandlingTypeMerkkijono1OletusverotuskäsittelyAsiakkaan laskutusmaaryhmän mukainen käsittely
3BalanceLimitDesimaaliluku1Asiakkaan tiliraja, kahden desimaalin tarkkuudella. 
3DiscountPercentageNumero0...1Alennusprosentti10
3DefaultSalesPersonMerkkijono0...1Oletusmyyjän nimi 
3PriceGroupMerkkijono0...1Hintaryhmän nimi johon asiakas on linkitetty 
3FactoringAccountMerkkijono0...1Asiakkaan factoring-tilin nimiFactoring
Attr.NetvisorKeyMerkkijono1Factoring-tilin NetvisorID1
3InvoicingLanguage
Merkkijono0...1Asiakkaan laskutuskieliFI
Attr.typeMerkkijono1Maatiedon esitystapa, aina ISO-3166
ISO-3166
3CustomerDimensionsAggregaatti0...1

4DimensionAggregaatti0...n

5DimensionNameMerkkijono1Asiakkaan laskentakohteen otsikkoEläimet
Attr.NetvisorKeyMerkkijono1Laskentakohteen otsikon Netvisor ID4
5DimensionItemMerkkijono1Asiakkaan laskentakohdeKissat
Attr.NetvisorKeyMerkkijono1Laskentakohteen Netvisor ID117

Asiakastietojen tuonti

Resurssi: customer.nv

Käytetään uuden asiakkaan lisäämiseen tai vanhan päivittämiseen. Asiakaslistan tai asiakkaan täydellisten tietojen haku tapahtuvat eri pyynnöillä.

Jos verkkolaskutustiedot annetaan, ei verkkolaskutusosoitteen oikeellisuutta erikseen tarkisteta. Verkkolaskuoperaattorin tulee kuitenkin löytyä järjestelmästä.
Alla lista Netvisorin sallimista verkkolaskuoperaattoreista ja operaattoritunnuksista:

VerkkolaskuoperaattoriTunnus
AktiaHELSFIHH
ÅlandsbankenAABAFI22
Apix Messaging Oy003723327487
Apix Messaging Oy (vanha tunnus)
00372332748700001
Basware Oyj
BAWCFI22
CGI Suomi (ent. Logica)003703575029
Danske BankDABAFIHH
DNB Bank ASA, Finland BranchDNBAFIHX
HandelsbankenHANDFIHH
InExchange Factorum ABINEXCHANGE
InExchange Factorum AB (vanha tunnus)
SE556700997101
Liaison Technologies Oy (ent. Anilinker)003708599126
Maventa003721291126
Netbox Finland Oy003726044706
NordeaNDEAFIHH
Notebeat Oy003717203971
OpusCapita (vanha tunnus 31.12.2018 saakka)003710948874
OpusCapita Solutions OyE204503
OsuuspankkiOKOYFIHH
Pagero003723609900
POP PankkiPOPFFI22
PostNord Strålfors Oy003701150617
Ropo Capital003714377140
SäästöpankkiITELFIHH
S-Pankki/LähiTapiolaSBANFIHH
Sproom ApSSPROOM
TeliaSonera Finland Oyj003714756079
Tieto Oyj
003701011385
PeppolPEPPOL

Kutsussa käytettävät parametrit:

ParametriIlmentymätEsimerkkiKuvaus
method1AddAdd tai Edit
id0...1123Asiakkaan NetvisorKey
Pakollinen, kun asiakkaan tietoja muokataan

Mikäli metodia ei ole annettu tai päivitettävää asiakasta ei löydy järjestelmästä, palautetaan INVALID_DATA –virhe selitteineen. Päivitettävän asiakkaan id:n saa tietoon kysymällä ensin asiakaslistaa.
Asiakkaan päivityksessä XML-sanomaan kirjoitetaan vain päivitettävät tiedot. Aineistoon ei tule kirjoittaa tietoja, joita ei haluta päivittää: muuten rajapinta päivittää ne tyhjäksi.

salespersonid:n saa käyttämällä Myyjälistan noutoa.

Tuotavat tiedot lähetetään kutsun mukana oheisen kuvauksen mukaisena xml:nä (POST-data):

TasoElementtiMuotoIlmentymiäKuvausEsimerkki
rootrootAggregaatti1  
1customerAggregaatti1  
2customerbaseinformationAggregaatti1  
3internalidentifierMerkkijono, max. 500...1AsiakaskoodiMM123
Attr.typeMerkkijono0...1automatic (mikäli annetaan ja asiakaskoodi jätetään tyhjäksi, käytetään automaattisesti seuraavaa vapaata asiakasnumeroa)automatic
externalidentifierMerkkijono0...1 Y-tunnus1967543-8
3organizationunitnumberNumero,
max. 17
0...1OVT-tunnus (Vastaanottajan OVT-tunnus, jos tieto poikkeaa yrityksen y-tunnuksesta)00371967543815
nameMerkkijono, max. 2500...1Asiakkaan nimiMatti Meikäläinen
nameextensionMerkkijono, max. 2500...1Asiakkaan nimen jatkeToimitusjohtaja
streetaddressMerkkijono, max. 800...1KatuosoitePajukuja 1
additionaladdresslineMerkkijono, max. 800...1Osoitteen jatko 
cityMerkkijono, max. 800...1PostitoimipaikkaLappeenranta
postnumberMerkkijono, max. 500...1Postinumero53100
countryMerkkijono0...1 Maatieto (jos ei anneta, tulee oletuksena Suomi)FI
Attr.typeMerkkijono0...1 Maatiedon esitystapaISO-3166
customergroupnameMerkkijono, max. 500...1Asiakasryhmän nimi, asiakas liitetään ryhmään nimen perusteella Jos ryhmää ei ole olemassa, sellainen luodaan.Alennusasiakkaat
phonenumberMerkkijono, max. 800...1Puhelinnumero040 123456
faxnumberMerkkijono, max. 800...1Fax-numero05 123456
emailMerkkijono, max. 2000...1Sähköpostiosoitematti.meikalainen@firma.fi
3homepageuriMerkkijono, max. 800...1www-osoitewww.firma.fi
3isactiveNumero0...10 tai 1, merkitsee onko asiakas aktiivinen. 1
3isprivatecustomerNumero0...10 tai 1, merkitsee onko asiakas henkilöasiakas (1=henkilöasiakas). 0
3emailinvoicingaddressMerkkijono, max. 5000...1Sähköpostilaskutusosoite, pitää olla validi sähköpostiosoite. Voidaan antaa listana ; eroteltuna
matti.meikalainen@firma.fi
2customerfinvoicedetailsAggregaatti0...1  
3finvoiceaddressMerkkijono,
max. 50
1Verkkolaskuosoite, ei voida tuoda ilman verkkolaskuoperaattoritietoaFI109700021497
3finvoiceroutercodeMerkkijono,
max. 50
1Verkkolaskuoperaattorin operaattoritunnus, sallitut operaattorit
NDEAFIHH
2customerdeliverydetailsAggregaatti0...1  
3deliverynameMerkkijono, max. 2500...1Toimitusosoitteen nimitietoMaija Mehiläinen
3deliverystreetaddressMerkkijono, max. 800...1ToimitusosoitePajukuja 2
3deliverycityMerkkijono, max. 800...1Toimitusosoitteen postitoimipaikkaLappeenranta
3deliverypostnumberMerkkijono, max. 500...1Toimitusosoitten postinumero53100
3deliverycountryMerkkijono0...1Toimitusosoitteen maatietoFI
Attr.typeMerkkijono0...1Maatiedon esitystapa, aina ISO-3166ISO-3166
2customercontactdetailsAggregaatti0...1  
3contactnameMerkkijono0...1Ei visualisoituna käyttöliittymässä, älä käytä 
3contactpersonMerkkijono, max. 800...1Yhteyshenkilön nimi, tieto viedään käyttöliittymän Sukunimi kenttään
Matti Meikäläinen
3contactpersonemailMerkkijono, max. 2000...1Yhteyshenkilön sähköpostimatti.meikäläinen@firma.fi
3contactpersonphoneMerkkijono, max. 800...1Yhteyshenkilön puhelinnro040 987 254
2customeradditionalinformationAggregaatti0...1  
3commentMerkkijono, max. 2500
0...1Kommentti asiakasrekisteriin 
3customeragreementIdentifierMerkkijono, max. 350...1Sopimustunnus 
3customerreferencenumberMerkkijono0...1Viitenumero tarkisteineen oikeassa muodossa1070
3invoicinglanguageMerkkijono0...1Asiakkaan laskutuskieli, FI, EN tai SE. Mikäli tätä tietoa ei anneta sanomalla, tulee Laskun kieli -kenttään oletuksena SuomiFI
Attr.typeMerkkijono0...1Aina ISO-3166ISO-3166
3invoiceprintchannelformatNumeerinen0...1Laskun tulostusmuoto
1 = Lasku + tilisiirto
2 = Lasku
1
Attr.typeMerkkijono1Aina netvisornetvisor
3yourdefaultreferenceMerkkijono, max. 200
0...1Oletusviitteenne 
3defaulttextbeforeinvoicelinesMerkkijono, max. 500
0...1Oletusteksti ennen laskurivejä 
3defaulttextafterinvoicelinesMerkkijono, max. 500
0...1Oletusteksti jälkeen laskurivien 
3defaultpaymenttermMerkkijono0...1Oletusmaksuehto14 päivää netto
Attr.typeMerkkijono1Maksuehdon tyyppi, netvisor (id) tai customer (nimi)customer
3defaultsecondname
Merkkijono0...1OletusaputoiminimiAputoiminimi
Atrr.typeMerkkijono1Oletusaputoiminimen tyyppi, netvisor (id) tai customer (nimi)
customer
3paymentinterest
Numeerinen0...1Viivästyskorkoprosentti5
3balancelimitNumeerinen0...1Tiliraja5000
3defaultsalespersonAggregaatti0...1  
4salespersonidMerkkijono 0...1Oletusmyyjän tunnus 
Attr.typeMerkkijono1Tunnuksen tyyppi, aina netvisornetvisor
2customerdimensiondetailsAggregaatti0...1

3dimensionAggregaatti1...n

4dimensionnameMerkkijono1OletuslaskentakohdeotsikkoProject
4dimensionitemMerkkijono1OletuslaskentakohdeProject 1

Asiakkaan poisto

Resurssi: deletecustomer.nv

Resurssilla voidaan poistaa yksittäinen asiakas Netvisorista. Vastauksena "OK" viesti, jos poisto onnistuu. Jos poisto epäonnistuu, palautetaan virheviestin mukana syyt poiston epäonnistumiselle, esim. "Asiakkaalla on laskuja".

Kutsussa käytettävä parametri:

ParametriIlmentymiäKuvausEsimerkki
customerid1Asiakkaan NetvisorKey eli ID2

Asiakkaan toimipaikan tuonti

Resurssi: office.nv

Asiakkaan toimipaikan tietojen lisääminen ja muokkaus.
Kutsussa käytettävät parametrit:

ParametriIlmentymätKuvausEsimerkki
method1Add tai EditAdd
customerid1Asiakkaan Netvisor-tunnus
123
officeid0...1Toimipaikan Netvisor-tunnus, pakollinen muokatessa olemassaolevaa toimipaikkaa1

Lisähuomioita:

  • Edit-sanomalla voi poistaa tietoja antamalla ko. tagin sisällön tyhjänä.
  • Toimipaikan nimi on pakollinen tieto, joten se ei voi koskaan olla tyhjä.
  • FinvoiceAddress pitää olla kelvollinen OVT- tai IBAN-tunnus.
  • FinvoiceOperator käy samat operaattoritunnukset kuin kaikkialla muuallakin rajapinnassa, kts. lista ylempää.

Tuotavat tiedot lähetetään kutsun mukana oheisen kuvauksen mukaisena XML:nä (POST-data):

TasoElementtiMuotoIlmentymätKuvausEsimerkki
RootrootAggregaatti1  
1officeAggregaatti1  
2nameMerkkijono1Toimipaikan nimi 
2phonenumberMerkkijono0...1Toimipaikan puhelinnumero 
2telefaxnumberMerkkijono0...1Toimipaikan faksi 
2officeidentifierMerkkijono0...1Toimipaikkatunnus

2officecontactaddressAggregaatti0...1Toimipaikan postiosoitetiedot 
3streetaddressMerkkijono1Katuosoite 
3postnumberMerkkijono1Postinumero 
3cityMerkkijono1Kaupunki 
3countryMerkkijono1Maakoodi 
Attr.typeMerkkijono1Aina ISO-3166
 
2officevisitaddressAggregaatti0...1Toimipaikan käyntiosoitteentiedot 
3streetaddressMerkkijono1Katuosoite 
3postnumberMerkkijono1Postinumero 
3cityMerkkijono1Kaupunki 
3countryMerkkijono1Maakoodi 
Attr.typeMerkkijono1Aina ISO-3166
 
2officefinvoicedetailsAggregaatti0...1Toimipaikan verkkolaskutiedot
 
3finvoiceaddressMerkkijono1Verkkolaskuosoite (IBAN tai OVT)
 
3finvoiceroutercodeMerkkijono1Verkkolaskuoperaattori 

Myyjälistan nouto

Resurssi: salespersonnellist.nv

Noutaa listan myyjistä.

Vastaus:

TasoElementtiMuotoIlmentymätKuvausEsimerkki
RootrootAggregaatti1  
1SalesPersonnelListAggregaatti1  
2SalesPersonAggregaatti0...n  
Attr.NetvisorKeyMerkkijono1Myyjän netvisor-tunnus1
3FirstNameMerkkijono1Myyjän etunimiMatti
3LastNameMerkkijono1Myyjän sukunimiMyyntivastaava
3ProvisionPercentNumero1Myyjän provisioprosentti10

 



xml
(462 Bytes)
xml
(432 Bytes)
xml
(716 Bytes)
xml
(637 Bytes)
xsd
(2.74 KB)
xml
xml
(3.02 KB)

Oliko tästä vastauksesta apua? Kyllä Ei

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