Asiakasrajapinnan resurssit


Asiakas-rajapinnan kautta voidaan lukea, lisätä ja päivittää asiakas tietoja. Rajapinta koostuu itse asiakas-rajapinnasta, useammasta apurajapinnasta sekä asiakaskontakti-rajapinnasta. Tietojen haussa käytetään limit-, offset- ja count-avainsanoja haun tulosjoukon rajaamiseksi. Rajapinnat ovat seuraavat:

  • Account
  • contact
  • eInvoiceOperator
  • status
  • lostReason
  • accountType
  • businessType
  • industry
  • turnoverCategory


Asiakasrajapinnan resurssien osoitteet


Osoite on muotoa:


https://rest.valueframe.com/rest/v2/{REST_resurssi}/


Account- resurssin maksimiraja oletuksena on 100 asiakasta. Tämä siksi, että jokaiselta asiakkaalta tulee 100 riviä tietoja, jolloin kysely hidastuu merkittävästi. Haun voi kuitenkin suorittaa useassa eri osassa:


REST-resurssien osoitteet ovat seuraavat:


REST-resurssiGETPUTPOSTDELETEKUVAUS
Accountx x 

GET: palauttaa kaikki asiakkaat


 


     POST: uuden asiakkaan lisääminen
Account/IDxx  

GET: palauttaa asiakkaan id=ID


 


     
 

PUT: asiakkaan id=ID tietojen päivitys


 


      DELETE: asiakkaan id=ID poistaminen
Account/ID/contact x  x  GET: palauttaa asiakkaan id=ID kontaktit
Account/ID1/contact/ID2  x    x
 

GET: palauttaa asiakkaan id=ID1 kontaktin jonka id=ID2


 


      POST: lisää kontaktin, jonka id=ID2, asiakkaalle jonka id=ID1
 Account/eInvoiceOperator x    GET: palauttaa verkkolaskuoperaattorit
 Account/eInvoiceOperator/ID x    GET: palauttaa verkkolaskuoperaattorin jonka id=ID 
 Account/status x    GET: palauttaa asiakkaan statukset
 Account/status/ID x    GET: palauttaa asiakkaan statuksen jonka id=ID
 Account/lostReason x    GET: palauttaa asiakassuhteen loppumisen syyt
 Account/lostReason/ID x    GET: palauttaa asiakassuhteen loppumisen syyn jonka id=ID
Account/accountTypex   GET: palauttaa asiakastyypit
Account/accountType/IDx   GET: palauttaa asiakastyypin jonka id=ID
Account/businessTypex   GET: palauttaa yritysmuodot
Account/businessType/IDx   GET: palauttaa yritysmuodon jonka id=ID
Account/industryx   GET: palauttaa toimialaluokitukset
Account/industry/IDx   GET: palauttaa toimialaluokitusen jonka id=ID
Account/turnoverCategoryx   GET: palauttaa liikevaihtoluokituksen
Account/turnoverCategory/IDx   GET: palauttaa asiakkaan liikevaihtoluokan jonka id=ID


Asiakasrajapinnan resurssit kuvauksineen


Account-resurssi


Kentän nimiTyyppiKuvaus
idINTEGERAsiakkaan uniikki id-numero
extIdSTRINGVaihtoehtoinen asiakasnumero
name *STRINGAsiakkaan nimi
locationSTRINGToimipiste
departmentSTRINGOsasto
businessCode *STRINGLY-tunnus
vatCodeSTRINGVAT-tunnus
abbreviationSTRINGAsiakkaan lyhenne
isParentAccountBOOLEANOnko emoyhtiö
isChildAccountBOOLEANOnko tytäryhtiö
parentAccountIdINTEGEREmoyhtiön id
startDateSTRINGAsiakassuhteen alku
endDateSTRINGAsiakassuhteen loppu
streetAddressSTRINGKäyntiosoite, katu
streetPostalCodeSTRINGKäyntiosoite, postinumero
streetCitySTRINGKäyntiosoite, kaupunki
streetStateSTRINGKäyntiosoite, lääni
streetCountrySTRINGKäyntiosoite, maa
postalStreetAddressSTRINGPostitussosoite, katu
postalPostalCodeSTRINGPostitusosoite, postinumero
postalCitySTRINGPostitusosoite, kaupunki
postalStateSTRINGPostitusosoite, lääni
postalCountrySTRINGPostitusosoite, maa
invoicingStreetAddressSTRINGLaskutusosoite, katu
invoicingPostalCodeSTRINGLaskutusosoite, postinumero
invoicingCitySTRINGLaskutusosoite, postitoimipaikka
invoicingCountrySTRINGLaskutuosoite, maa
invoicingNameSTRINGLaskutusnimi
invoicingCOSTRINGLaskutus C/O
phoneNumberCountryCodeSTRINGLankanumero, maakoodi
phoneNumberAreaCodeSTRINGLankanumero, suuntanumero
phoneNumberSTRINGLankanumero
faxCountryCodeSTRINGFaxnumero, maakoodi
faxAreaCodeSTRINGFaxnumero, suuntanumero
faxNumberSTRINGFaxnumero
emailSTRINGSähköpostiosoite
wwwSTRINGWWW-osoite
paymentTermINTEGERMaksuehto
eInvoiceAddressSTRINGVerkkolaskutunnus
factoringAgreementNumberSTRINGFaktoring sopimusnumero
isMarketingBlockedBOOLEANMarkkinointikielto
isEmailMarketingBlockedBOOLEANSähköpostimarkkinointikielto
creationDateTimeSTRING (ISO8601)Asiakkuuden järjestelmään lisäyspäivä
modifiedDateTimeSTRING (ISO8601)Viimeinen modifiointipäivä
companyOBJECTYhtiö, kts. company
eInvoiceOperatorOBJECTVerkkolaskuoperaattori, kts. eInvoiceOperator
status *OBJECTAsiakkuuden tila, kts. status
lostReasonOBJECTAsiakassuhteen loppumisen syy, kts. lostReason
accountManagerOBJECT1. asiakasvastaava, kts. accountManager
accountManager2OBJECT2. asiakasvastaava, kts. accountManager
accountManager3OBJECT3. asiakasvastaava, kts. accountManager
accountTypeOBJECTAsiakassuhteen tyyppi, kts. accountType
businessTypeOBJECTAsiakkaan yritysmuoto, kts. businessType
industryOBJECTAsiakkaan toimiala, kts. industry
turnoverCategoryOBJECTAsiakkaan liikevaihtoluokka
priceListOBJECTAsiakkaan hinnasto
invoiceDeliveryMethodOBJECTAsiakkaan laskun lähetystapa
integrationText1STRINGIntegraatiotarkoituksia varten oleva tekstikenttä
integrationInt1INTEGERIntegraatiotarkoituksia varten oleva kokonaislukukenttä
integrationDate1STRING (ISO8601)Integraatiotarkoituksia varten oleva päivämääräkenttä
invoicingEmail
STRINGLaskutuksen sähköpostiosoite
contractNumber
STRINGSopimusnumero
accountingReference
STRINGTiliöntiviite
invoiceReference
STRINGLaskuviite
actionRequired
BOOLEANVaatii toimenpiteitä (Clento-integraation kenttä)
identificationExpires
STRING (ISO8601)Tuntemistiedot vanhenevat (Clento-integraation kenttä)
lastRiskAnalysisDate
STRING (ISO8601)Viimeisin riskiarvio (Clento-integraation kenttä)
riskAssessment
INTEGERAsiakkaan riskiluokka (Clento-integraation kenttä)


* Pakollinen tieto


 Account/accountManager


Alla on listattu Account -resurssin palauttamat asiakasvastaavan tiedot:


Kentän nimiTyyppiKuvaus
idINTEGERUniikki id
firstNameSTRINGAsiakasvastaavan etunimi
surNameSTRINGAsiakasvastaavan sukunimi
companyIdINTEGERAsiakasvastaavan yhtiön ID
emailAddress1STRINGAsiakasvastaavan 1 sähköpostiosoite
emailAddress2STRINGAsiakasvastaavan 2 sähköpostiosoite
streetAddressSTRINGAsiakasvastaavan osoite, katu
streetPostalCodeSTRINGAsiakasvastaavan osoite, postinumero
streetCitySTRINGAsiakasvastaavan osoite, kaupunki
streetCountrySTRINGAsiakasvastaavan osoite, maa
phoneCountryCodeSTRINGAsiakasvastaavan lankanumero, maakoodi
phoneAreaCodeSTRINGAsiakasvastaavan lankanumero, suuntanumero
phoneNumberSTRINGAsiakasvastaavan lankanumero, numero
mobileCountryCodeSTRINGAsiakasvastaavan kännykkänumero, maakoodi
mobileAreaCodeSTRINGAsiakasvastaavan kännykkänumero, suuntanumero
mobileNumberSTRINGAsiakasvastaavan kännykkänymero, numero
faxCountryCodeSTRINGAsiakasvastaavan faksinumero, maakoodi
faxAreaCodeSTRINGAsiakasvastaavan faksinumero, suuntanumero
faxNumberSTRINGAsiakasvastaavan faksinumero, numero
addedDateTimeSTRING(ISO8601)Päivämäärä kun asiakasvastaava on lisätty järjestelmään
addedByIdINTEGERHenkilön ID joka on lisännyt asiakasvastaavan järjestelmään
modifiedDateTimeSTRING(ISO8601)Päivämäärä kun asiakasvastaavan tietoja on viimeksi muokattu
modifiedByIdINTEGERAsiakasvastaavan tietoja muokanneen henkilön ID
isPassiveBOOLEANAsiakasvastaava on passivoitu


Account/company


Alla on listattu Account -resurssin palauttamat yhtiön tiedot:


Kentän nimiTyyppiKuvaus
idINTEGERYhtiön uniikki id
nameSTRINGYhtiön nimi
postalAddressSTRINGPostiosoite, katu
postalCodeSTRINGPostiosoite, postinumero
postalCitySTRINGPostiosoite, kaupunki
streetAddressSTRINGKäyntiosoite, katu
streetPostalCodeSTRINGKäyntiosoite, postinumero
streetCitySTRINGKäyntiosoite, kaupunki
wwwAddressSTRINGInternetsivuston osoite
emailAddressSTRINGSähköpostiosoite
vatCodeSTRINGArvolisäverotunniste
addedDateTimeSTRING (ISO8601)Yhtiön lisäys päivämäärä
addedByIdINTEGERYhtiön lisänneen henkilön ID
modifiedDateTimeSTRING (ISO8601)Yhtiön tietojen päivitys päivämäärä
modifiedByIdINTEGERYhtiön tietoja päivittäneen henkilön ID


 Account/eInvoiceOperator-resurssi


Verkkolaskuoperaattoriin liittyvät tiedot


Kentän nimiTyyppiKuvaus
idINTEGERVerkkolaskuoperaattorin uniikki id
nameSTRINGVerkkolaskuoperaattorin nimi
codeSTRINGVerkkolaskuoperaattorin operaattoritunnus
abbreviationSTRINGVerkkolaskuoperaattorin lyhenne


Account/status-resurssi


Asiakkuuden tilaan (engl. status) liittyvät tiedot


Kentän nimiTyyppiKuvaus
idINTEGERStatuksen uniikki id
nameSTRINGStatuksen selväkielinen nimi
activeBOOLEANStatus on käytettävissä (aktiivinen)


 Account/lostReason-resurssi


Asiakkuussuhteen loppumisen syy


Kentän nimiTyyppiKuvaus
idINTEGERUniikki id
nameSTRINGAsiakassuhteen loppumisen syyn selväkielinen nimi


 Account/accountType-resurssi


Asiakkuussuhteen tyyppi


Kentän nimiTyyppiKuvaus
idINTEGERUniikki id
nameSTRINGAsiakassuhteen tyypin selväkielinen nimi


 Account/businessType-resurssi


Asiakkaan yritysmuoto


Kentän nimiTyyppiKuvaus
idINTEGERUniikki id
nameSTRINGYritysmuodon selväkielinen selitys


 Account/industry-resurssi


Asiakkaan toimialaluokitus


Kentän nimiTyyppiKuvaus
idINTEGERUniikki id
nameSTRINGToimialaluokituksen selväkielinen nimi


 Account/turnoverCategory-resurssi


Asiakkaan liikevaihtoluokka


Kentän nimiTyyppiKuvaus
idINTEGERUniikki id
nameSTRINGLiikevaihtoluokan selväkielinen nimi


 Account/PriceList -resurssi


Asiakkaan hinnasto


Kentän nimiTyyppiKuvaus
idINTEGERUniikki id
nameSTRINGHinnaston nimi
descriptionSTRINGHinnaston kuvaus


 Account/invoiceDeliveryMethod-resurssi


Asiakkaan laskun lähetystapa


Kentän nimiTyyppiKuvaus
idINTEGERUniikki id
nameSTRINGLaskun lähetystapa


 Account/ID/contact-resurssi


Contact-rajapinnan kautta voidaan hakea kaikki tietylle asiakkaalle liitetyt kontaktit, tai yksittäinen tietylle asiakkaalle liitetty kontakti. Rajapinta tukee GET-, POST- ja DELETE-metodeja. POST-metodi lisää olemassa olevan kontaktin asiakkaalle.


Kentän nimiTyyppiKuvaus
idINTEGERKontaktin uniikki id
firstNameSTRINGKontaktin etunimi
surNameSTRINGKontaktin sukunimi
titleSTRINGKontaktin titteli
emailAddress1STRINGKontaktin 1 sähköpostiosoite
emailAddress2STRINGKontaktin 2 sähköpostiosoite
streetAddressSTRINGKontaktin osoite, katu
streetPostalCodeSTRINGKontaktin osoite, postinumero
streetCitySTRINGKontaktin osoite, kaupunki
streetCountrySTRINGKontaktin osoite, maa
phoneCountryCodeSTRINGKontakin lankanumero, maakoodi
phoneAreaCodeSTRINGKontakin lankanumero, suuntanumero
phoneNumberSTRINGKontaktin lankanumero, numero
mobilePhoneCountryCodeSTRINGKontaktin kännykkänumero, maakoodi
mobilePhoneAreaCodeSTRINGKontaktin kännykkänumero, suuntanumero
mobilePhoneNumberSTRINGKontaktin kännykkänumero, numero
faxCountryCodeSTRINGKontaktin faksinumero, maakoodi
faxAreaCodeSTRINGKontaktin faksinumero, suuntanumero
faxNumberSTRINGKontaktin faksinumero, numero
isMarketingBlockedSTRINGMarkkinointi kielletty
isEmailMarketingBlockedSTRINGSähköpostimarkkinointi kielletty
additionalInfoSTRINGAsiakkaan lisätiedot
addedDateTimeSTRING (ISO8601)Päivämäärä kun kontakti on lisätty järjestelmään
addedByIdINTEGERKontaktin järjestelmään lisänneen henkilön ID
modifiedDateTimeSTRING (ISO8601)Päivämäärä kun kontaktin tietoja on viimeksi muokattu
modifiedByIdINTEGERKontaktia tietoja päivittäneen henkilön ID
isPassiveBOOLEANKontakti on passiivinen
commentsSTRINGKommentti
integrationText1STRINGIntegraatiotarkoituksia varten oleva tekstikenttä
integrationInt1INTEGERIntegraatiotarkoituksia varten oleva kokonaislukukenttä
integrationDate1STRING (ISO8601)Integraatiotarkoituksia varten oleva päivämääräkenttä


 



Oliko tästä vastauksesta apua? Kyllä Ei

Send feedback
Pahoittelut, että emme voineet auttaa. Anna palautetta, jotta voimme parantaa tätä artikkelia.