Siirry pääsisältöön

Asiakastiedot / Customer Info

Tämä dokumentti sisältää Nova Webservicen XML-sanomakuvaukset Asiakastiedot / Customer Info -kokonaisuudesta.

Customer

/xml/Customer/

Tällä päivitetään tai luodaan asiakas / Customer creation or update.

Elementti / Element

Tyyppi / Type

Selite

Lisätieto / Additional information

Pakollinen / Mandatory

Number

integer

Asiakkaan numero

- tyhjä tai 0, lisätään uusi, muuten päivitetään / if empty or 0, new customer created, otherwise customer will be updated

- jos lisätty uusi, paluusanomassa lisätyn numero / If new customer, the return value is new customers number

Yritystiedot

Advances

decimal

Ennakot

City

string

Postinumero ja postitoimipaikka

Currency

Code

string

Valuutta

CostCenterID

string

Kustannuspaikka

Country

string

Maa

v_maa

CreditLimit

decimal

Luottoraja

Customer

GroupID

integer

Ryhmä

Delivery

Denied

boolean

Toimituskielto

DelayInDays

integer

Viivästyspäiviä

DeliveryMode

number

Toimitustapa

v_toimitustapa

Discount

Group

integer

Aleryhmä

Discount

Percentage

decimal

ASIAKAS.ALEPROS

Driver

integer

Kuljettaja

DrivingListNo

integer

Ajolista

EInvoice

Address

string

Verkkolaskuosoite

EInvoice

BrokerID

string

Välittäjän tunniste

ExternalNo

string

Ulkoinen nro

Uusi kenttä Nova 9.8 lähtien

Invoicing

Method

Factoring

boolean

Asiakkaan laskutapana factoring

FaxNumber

string

Fax nro

Important

Notes

string

Tärkeää-välilehti

Invoice

CustomerID

integer

Laskutus asnro

InvoiceEmail

string

Sähköposti

Invoicing

Mode

integer

Laskutapa

0. Perinteinen, 1. Factoring, 2. Postin ekirje, 3. EDI/OVT, 4. Verkkolasku, 5. Sähköposti, 7. Kuluttajan e-lasku, 8. Suoramaksu / 0. Traditional, 1. Factoring, 2. E-mail of Post office, 3. EDI, 4. E-invoice, 5. E-mail, 7. Customer's e-invoice, 8. Direct payment

Language

Code

string

Kieli

v_kielikoodi

Mailings

integer

Postituksia

Name1

string

nimi1

*

Name2

string

nimi2

NoAuto

Interest

Invoicing

boolean

Ei automaattisia korkolaskuja

NoAuto

Reminders

boolean

Ei automaattisia maksukehoi-tuksia

NotPost

Delivery

boolean

Ei jälkitoimituksia

NoWeee

Payment

boolean

Ei SER-maksuja

OVTCode

string

OVT-tunnus

Penalty

Interest

decimal

Viivästyskorko %

PhoneNumber

string

Puhelin nro

PricelistId

integer

Hinnasto nro

Recipient

CostCenter

string

Vast.ottajan kustannus-paikka

Recipient

Purchase

Account

string

Vast.ottajan ostotili

Region

string

Alue

Registered

boolean

Rekisteröity

SalesAccount

string

Myyntitili

Selected

boolean

Valittu

SellerID

number

Myyjä

v_myyja

Street

Address

string

Katuosoite

TermOf

Delivery

number

Toimitusehto

v_toimitusehto

TermOf

PaymentID

number

Maksuehdon koodi

v_maksuehto

TradeRegNo

string

Kaupparek.nro

WWW

Address

string

Kotisivu

YCode

string

Y-tunnus

Compilation

InvoicingOnly

integer

vain koontilaskutus

Deny

Compilation

Invoicing

boolean

Koontilaskutus kielletty

CountryCode

string

maakoodi

Jos Country kenttä on tyhjä ja CountryCode kenttään on annettu 2 merkkisen maa koodin niin haetaan maat taulusta maan nimi. Jos on annettu asiakkaalle kieli SWE tai ENG niin haetaan maa taulusta sillä kielellä maan nimi. Oletuksena tai jos ei läyd SWE/ENG kielellä niin tulee suomeksi.

Yhteys-henkilön tiedot

/xml/

ashenkilo, SDK=/xml/

Contact/

(Nova.CustomerMgmtLibrary.Contact)

Name

string

Yhteyshenki-lön nimi

Title

integer

Yhteyshenki-lön titteli (tehtävä)

Email

string

Yhteyshenki-lön email osoite

MobilePhone

string

Yhteyshenki-lön kännykkä nro

Guid

string

yhteyshenki-lön guid

- Lisätään uusi, jos tyhjä tai riviä ei löydy / Adds new, if empty or row was not found

- Paluusano-massa lisätyn rivin guid, jos lisätty uusi rivi / in the return value the new rows guid, if new row was created

- Olemassa oleva kontakti poistetaan, jos löytyy attribuutti delete. Vaatii olemassa-olevan kontaktin Guidin. / Existing contact will be deleted, if delete atribute is defined. Requires an existing Guid of a contact.

IsDefault

boolean

Oletus yhteyshenkilö

Description

string

Selite

AllowPrintOnLabel

boolean

henkilölle voidaan tulostaa osoitetarra

AllowToReceiveEmail

boolean

henkilölle voidaan lähettää sähköpostia

Itse määriteltävät tiedot xml/Customer/UserDefinedFields

UserDefinedField

data arvo

Kentän data arvo. / Data value for field.

name

Attribute

kentän nimi

Itsemääriteltä-vän kentän sarakkeen nimi. / Name of userdefinde field column.

Output /xml/Output

Result

boolean

true, jos tallennus onnistui / true, if succesfully saved

Esimerkki / Example:

<?xml version="1.0" encoding="utf-8"?>

<xml>

<login>

<hash dsn="nova">736</hash>

</login>

<Customer>

<Number>13536</Number>

<Name1>Maija Meikäläinen</Name1>

<Name2>nimi 2</Name2>

<StreetAddress>Katu 1</StreetAddress>

<City>00000 Kaupunki</City>

<PhoneNumber>12345678</PhoneNumber>

<FaxNumber>87654321</FaxNumber>

<CurrencyCode>EUR</CurrencyCode>

<TermOfPaymentID>1</TermOfPaymentID>

<YCode>12345-6</YCode>

<Country>FI</Country>

<LanguageCode>FIN</LanguageCode>

<DeliveryMode>3</DeliveryMode>

<TermOfDelivery>1</TermOfDelivery>

<SellerID>2</SellerID>

</Customer>

<Contact>

<Name>Simo Silmukka</Name>

<Email>[email protected]</Email>

<MobilePhone>01000000</MobilePhone>

<Guid></Guid>

</Contact>

</xml>

Delete esimerkki / Delete example:

...

<Contact>

<Guid delete="1">00000000-0000-0000-00000000000000000</Guid>

</Contact>

...

Read contact list

/xml/ReadContactList/

Tällä haetaan asiakkaan yhteyshenkilötiedot / Returns customers contact information.

Elementti / Element

Tyyppi / Type

Selite

Lisätieto / Additional information

Pakollinen / Mandatory

Customer

Number

integer

Asiakkaan numero

*

Output /xml/Contacts/Contact

CustomerNumber

integer

Asiakkaan numero

Email

string

Yhteyshenki-lön email osoite

FaxNumber

string

Yhteyshenki-lön fax numero

FreeText

string

Yhteyshenkilö osion vapaa teksti kentän tieto

MobilePhone

string

Yhteyshenki-lön kännykkä nro

Name

string

Yhteyshenki-lön nimi

Phone

string

Yhteyshenki-lön puhelin numero

Title

integer

Yhteyshenki-lön titteli

IsDefault

boolean

Oletus yhteyshenkilö

Description

string

Selite

AllowPrintOnLabel

boolean

henkilölle voidaan tulostaa osoitetarra

AllowToReceiveEmail

boolean

henkilölle voidaan lähettää sähköpostia

Esimerkki / Example:

<?xml version="1.0" encoding="utf-8"?>

<xml>

<login>

<hash dsn="nova">73685dbea3290215b74a3a2e9c1c3ecc</hash>

</login>

<ReadContactList>

<CustomerNumber>13536</CustomerNumber>

<Email>[email protected]</Email>

<FaxNumber></FaxNumber>

<FreeText></FreeText>

<MobilePhone>01000000</MobilePhone>

<Name>Simo Silmukka</Name>

<Phone></Phone>

<Title>0</Title>

</ReadContactList>

</xml>

Read customer list

/xml/ReadCustomerList

Elementti / Element

Tyyppi / Type

Selite

Lisätieto / Additional information

Pakollinen / Mandatory

Search

string

yleishakusana / general search criteria

Number

integer

numero

Asiakas numero hakusana / Customer number search criteria

Name

string

Nimi

nimen hakusana / name search criteria

Name2

string

Nimi2

lisänimen hakusana / additional name search criteria

StreetAddress

string

Katuosoite

osoitteen hakusana / street search criteria

City

string

Postinumero ja postitoimi-paikka / Zip code and city

kaupungin hakusana / city search criteria

VatId

string

y-tunnus

ChangedAfter

date

Tietueen muutospäivä

pvm, jonka jälkeen muuttuneet asiakkaat haetaan. Jos tämä on annettu, hakusanoilla ei vaikutusta / Search for articles that has been changed after the given date. If this search criteria is given, the other search criterias has no affect

ContactEmail

string

ashenkilo.sposti

Haku asiakkaan yhteyshenki-lön sähköpostilla / Search by customer contact e-mail.

NameStarts

With

string

Nimi

Tällä saa haettua kaikki asiakkaat jonka nimi alkaa tietyllä tekstillä tai kirjaimella. Huom! jos muita hakuehtoja annettu niin hakee niiden perusteella. / Fetches customers whose name begins with given letter or text. Other given search criterias will override this.

Group

integer

Ryhmä

Ryhmän hakunumero

ShowUser

DefinedFields

bool

true/false

Näytetäänkö asiakkaan itsemääriteltä-vät kentät, oletuksena false / show user defined fields for customer, false as default

/xml/Read

CustomerList/NumberRange

From

string

alkaen

Haetaan asiakkaat välillä alkaen - loppuu esim. numerot 100 - 200. Huom! jos muita hakuehtoja annettu niin hakee niiden perusteella. / Fetches range of customers From - To. Other given search criterias will override this.

To

string

loppuu

Output /xml/

CustomerList/CustomerInfo

Address

string

City

string

Asiakkaan postinumero ja postitoimi-paikka

Country

string

Maa

Chain

string

Asiakkaan ketju

Invoicing

Method

Factoring

boolean

Asiakkaan laskutapana factoring

CreditLimit

decimal

Luottoraja

ExternalNo

string

Ulkoinen nro

Uusi kenttä Nova 9.8 lähtien

Group

string

Asiakasryhmä

GroupName

string

Asiakasryh-män nimi

Invoice

CustomerId

integer

Laskutus asnro

Name

string

Asiakkaan nimi

NotPost

Delivery

boolean

Ei jälkitoimituksia

Number

integer

Asiakkaan numero

OpenSum

decimal

Avoinna summa

Payment

MethodId

integer

Maksuehto

PriceGroup

integer

Hinnasto nro

Registered

boolean

Rekisteröity

Selected

boolean

Valittu

VATid

string

Ly, Y-tunnus

Invoicing

Mode

Integer

Laskutapa

Invoicing

ModeName

String

Laskutavan nimi

AbcGroup

ASIAKAS.ABC

Advances

ASIAKAS.

ENNAKOT

BlockSales

CREDITLIMIT < 0

BranchID

ASIAKASLUOKITTELU.

TOIMIALA

CarrierID

ASIAKAS.

RAHDINKID

Carrier

Selected

ASIAKAS.

RAHDINK

Category1ID

ASIAKASLUOKITTELU.

HENKILOMAARA

Category1

Name

V_HENKILOMAARA.TEXTI

Category2ID

ASIAKASLUOKITTELU.LV

Category2

Name

V_LIIKEVAIHTOLUOKKA.

TEKSTI

ChangedDate

ASIAKAS.TIETUEMPVM

Compilation

Invoicing

ASIAKAS.

KOONTI

Compilation

InvoicingOnly

ASIAKAS.

KOONTILASKUTUS

CostCenterID

ASIAKAS.

KPAIKKA

CountryCode2

MAAT.KOODI2

Currency

Code

ASIAKAS.VALUUTTA

CustomerTo

BranchCode

ASIAKASLUOKITTELU.TOLKOODI

Customer

Type

ASIAKAS.LAJI

DebtAccount

ASIAKAS.

VASTATILI

DelayInDays

ASIAKAS.SUORVIIVE

Delivery

Denied

ASIAKAS.

TOIMITUSKIELTO

DeliveryMode

ASIAKAS.TTAPA

DiscountGroup

ASIAKAS.ALERYHMA

Discount

Percentage

ASIAKAS.ALEPROS

DivisionCode

ASIAKASLUOKITTELU.

LUOKITTELU

Driver

ASIAKAS.

KUSKI

DrivingListNo

ASIAKAS.JNRO

EInvoice

Address

ASIAKAS.

ELASKUTUNNISTE

EInvoice

BrokerID

ASIAKAS.

VLASKUOSOITE

FaxNumber

ASIAKAS.FAX

Guid

ASIAKAS.GUID

Important

Notes

PROFIILI.TXT1

Invoice

Customer

Name

LASKUTUS

NIMI

InvoiceEmail

ASIAKAS.

LASKUEMAIL

Inovicing

ModeName

Laskutapa

Nimi

IsActive

boolean

Aktiivinen/

Passiivinen

Language

Code

ASIAKAS.KIELI

Mailings

ASIAKAS.

POSTIAPU

Name2

ASIAKAS.NIMI2

NoAuto

Interest

Invoicing

ASIAKAS.

KOROT

NoAuto

Reminders

ASIAKAS.

KARHUT

NoIban

Conversion

ASIAKAS.EIIBANKONVERSIOTA

NonDiscount

ItemListID

ASIAKAS.EIALETUOTERYHMAT

NoWeee

Payment

ASIAKAS.EISERMAKSUJA

OwnClientID

ASIAKAS.SOPNRO

OVTCode

ASIAKAS.OVT

Penalty

Interest

ASIAKAS.VIIVASTYSKORKO

Period

ASIAKAS.JAKSO

PersonIn

Charge

ASIAKAS.VASTUU

PhoneNumber

ASIAKAS.PUHELIN

PriceGroupId

ASIAKAS.HINTARYHMA

QualitySpec

ASIAKAS.LAATUSELITE

Quality

SystemInUse

ASIAKAS.LAATU

RecipientCostCenter

ASIAKAS.ASIAKKAANKPAIKKA

Recipient

Purchase

Account

ASIAKAS.ASIAKKAANMTILI

Region

ASIAKAS.ALUE

Relationship

StartDate

ASIAKAS.ALKUPVM

Route

ASIAKAS.ROUTE

SalesAccount

ASIAKAS.MTILI

SellerID

ASIAKAS.MYYJA

SellerName

V_MYYJA.TEKSTI

StreetAddress

ASIAKAS.LOSOITE

TermOfDelivery

ASIAKAS.TEHTO

TermOf

Payment

Name

V_MAKSUEHTO.TEKSTI

TradeRegNo

ASIAKAS.KRNRO

Transaction

Key

ASIAKAS.TRANSACTIONKEY

Transport

Instructions

ASIAKAS.KOHJE

Type

ASIAKAS.LAJI

Type

Description

V_ASIAKASLAJI.SELITE

Warehouse

ASIAKAS.VP

WWW

Address

asiakas.kotisivu

Deny

Compilation

Invoicing

boolean

Koontilaskutus kielletty

/xml/

CustomerList/CustomerInfo/Contacts/

Contact

Customer

Number

integer

Asiakkaan numero

Email

string

Yhteyshenki-lön email osoite

FaxNumber

string

Yhteyshenki-lön fax numero

FreeText

string

Yhteyshenki-lö osion vapaa teksti kentän tieto

MobilePhone

string

Yhteyshenki-lön kännykkä nro

Name

string

Yhteyshenki-lön nimi

Phone

string

Yhteyshenki-lön puhelin numero

Title

integer

Yhteyshenki-lön titteli

Guid

guid

yhteyshenki-lön guid

IsDefault

boolean

oletus yhteyshenkilö

Description

string

Selite

AllowToprint

OnLabel

boolean

henkilölle voidaan tulostaa osoitetarra

AllowTo

ReceiveEmail

boolean

henkilölle voidaan lähettää sähköpostia

/xml/

CustomerList/CustomerInfo/UserDefined

Fields/

UserDefined

Field

name

Attribute

kentän nimi

Tässä atribuutissa on se nimi mikä on määritelty itsemäärittele-vän kentän osioon

type

Attribute

kentän datatyyppi

Tässä atribuutissa on itsemääritetyn kentän datatyyppi

Esimerkki / Example 1:

<?xml version="1.0" encoding="utf-8"?>

<xml>

<login>

<hash dsn="nova">736</hash>

</login>

<ReadCustomerList>

<Name>Maija Meikäläinen</Name>

<Name>nimi 2</Name>

<Address>Katu 1</Address>

<City>00000 Kaupunki</City>

<ChangedAfter>6.12.2016</ChangedAfter>

</ReadCustomerList>

</xml>

Esimerkki / Example 2:

<?xml version="1.0" encoding="utf-8"?>

<xml>

<login>

<hash dsn="nova">736</hash>

</login>

<ReadCustomerList>

<NumberRange>

<From>100</From>

<To>200</To>

</NumberRange>

</ReadCustomerList>

</xml>

Esimerkki / Example 3:

<?xml version="1.0" encoding="utf-8"?>

<xml>

<login>

<hash dsn="nova">73685dbea3290215b74a3a2e9c1c3ecc</hash>

</login>

<ReadCustomerList>

<NameStartsWith>Asiakas</NameStartsWith>

</ReadCustomerList>

</xml>

Read customer product list

/xml/ReadCustomerProductList/

Tällä haetaan asiakkaan tuotteet / Returns customer products.

Elementti / Element

Tyyppi / Type

Selite

Lisätieto / Additional information

Pakollinen / Mandatory

Customer

Number

integer

numero

*

Output /xml/Contacts/Contact

ID

Guid

guid

ProductCode

String

koodi

ObtainDate

Date

hankintapvm

EndDate

Date

loppupvm

IsContract

Boolean

sopimus

IsKMPricing

Boolean

kmveloitus

IsWorkPricing

Boolean

tyoveloitus

Contract

Number

String

sopnro

SerialNumber

String

sarjanro

Version

String

versio

ProductName

String

nimike

Txt

String

txt

Warranty

String

takuu

UnitCode

String

osasto

Price

Decimal

sophinta

Pcs

Decimal

maara

Period

Int32

jakso

RowNumber

Int32

juoksu

Esimerkki / Example:

<xml>

<login>

<hash dsn="nova">736</hash>

</login>

<ReadCustomerProductList>

<CustomerNumber>712</CustomerNumber>

</ReadCustomerProductList>

</xml>

Read visit list

/xml/ReadVisitList/

Tällä haetaan asiakkaan käynnit / Returns customer visits.

Elementti / Element

Tyyppi / Type

Selite

Lisätieto / Additional information

Pakollinen / Mandatory

Customer

Number

integer

numero

*

VisitCode

string

koodi

VisitDate

date

pvm

Output /xml/Contacts/Contact

Customer

Number

integer

numero

VisitDate

date

pvm

Code

string

koodi

Name

string

nimike

Pcs

decimal

kpl

Repetition

string

toisto

Clarification

string

selite

ONumber

integer

jnro

RowRun

Number

integer

Juoksu

SerialNumber

string

Sarjanumero

GUID

guid

Guid

Repetition

Amount

integer

toistokpl

Path

integer

reitti

Agreement

boolean

sopimus

Agreement

Price

decimal

sophinta

StartDate

date

alkupvm

EndDate

date

loppupvm

Esimerkki / Example:

<xml>

<login>

<hash dsn="nova">736</hash>

</login>

<ReadVisitList>

<CustomerNumber>99988</CustomerNumber>

<VisitDate>2012-11-02T00:00:00</VisitDate>

<VisitCode>13</VisitCode>

</ReadVisitList>

</xml>

Update or insert customer product

/xml/UpsertCustomerProduct/CustomerProduct/

Asiakkaan tuotteisiin lisäys ja muokkaus. / Customer products add and modify.

Elementti / Element

Tyyppi / Type

Selite

Lisätieto / Additional information

Pakollinen / Mandatory

Customer

Number

integer

numero

*

ID

Guid

guid

Jos tyhjä niin lisätään uusi. / Empty adds new.

ProductCode

String

koodi

Pakollinen jos lisää uuden / Mandatory if inserting.

(*)

ObtainDate

Date

hankintapvm

EndDate

Date

loppupvm

IsContract

Boolean

sopimus

IsKMPricing

Boolean

kmveloitus

IsWorkPricing

Boolean

tyoveloitus

Contract

Number

String

sopnro

SerialNumber

String

sarjanro

Version

String

versio

ProductName

String

nimike

Txt

String

txt

Warranty

String

takuu

UnitCode

String

osasto

Price

Decimal

sophinta

Pcs

Decimal

maara

Period

Int32

jakso

Output /xml/Contacts/Contact

ID

Guid

guid

ProductCode

String

koodi

ObtainDate

Date

hankintapvm

EndDate

Date

loppupvm

IsContract

Boolean

sopimus

IsKMPricing

Boolean

kmveloitus

IsWorkPricing

Boolean

tyoveloitus

Contract

Number

String

sopnro

SerialNumber

String

sarjanro

Version

String

versio

ProductName

String

nimike

Txt

String

txt

Warranty

String

takuu

UnitCode

String

osasto

Price

Decimal

sophinta

Pcs

Decimal

maara

Period

Int32

jakso

Esimerkki / Example:

<xml>

<login>

<hash dsn="nova">73685dbea3290215b74a3a2e9c1c3ecc</hash>

</login>

<UpsertCustomerProduct>

<CustomerProduct>

<ID></ID>

<ProductCode>00510H</ProductCode>

<ObtainDate>21.8.2018</ObtainDate>

<EndDate></EndDate>

<IsContract>false</IsContract>

<IsKMPricing>false</IsKMPricing>

<IsWorkPricing>false</IsWorkPricing>

<ContractNumber></ContractNumber>

<SerialNumber></SerialNumber>

<Version></Version>

<ProductName>Kiintoavain 12 mm</ProductName>

<Txt></Txt>

<Warranty></Warranty>

<UnitCode></UnitCode>

<Price>0.0000</Price>

<Pcs>0.0000</Pcs>

<Period>0</Period>

<RowNumber>61</RowNumber>

<CustomerNumber>712</CustomerNumber>

</CustomerProduct>

</UpsertCustomerProduct>

</xml>

Vastasiko tämä kysymykseesi?