Asiakasrajapinta
- Asiakasrajapinnan resurssit
- Asiakasrajapinnan resurssien osoitteet
- Asiakasrajapinnan resurssit kuvauksineen
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:
- https://rest.valueframe.com/rest/v2/Account?limit=100: ensimmäiset 100 asiakasta
- https://rest.valueframe.com/rest/v2/Account?limit=100&offset=100: seuraavat 100 asiakasta
- jne.
REST-resurssien osoitteet ovat seuraavat:
| REST-resurssi | GET | PUT | POST | DELETE | KUVAUS |
| Account | x | x |
GET: palauttaa kaikki asiakkaat |
||
| POST: uuden asiakkaan lisääminen | |||||
| Account/ID | x | x |
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/accountType | x | GET: palauttaa asiakastyypit | |||
| Account/accountType/ID | x | GET: palauttaa asiakastyypin jonka id=ID | |||
| Account/businessType | x | GET: palauttaa yritysmuodot | |||
| Account/businessType/ID | x | GET: palauttaa yritysmuodon jonka id=ID | |||
| Account/industry | x | GET: palauttaa toimialaluokitukset | |||
| Account/industry/ID | x | GET: palauttaa toimialaluokitusen jonka id=ID | |||
| Account/turnoverCategory | x | GET: palauttaa liikevaihtoluokituksen | |||
| Account/turnoverCategory/ID | x | GET: palauttaa asiakkaan liikevaihtoluokan jonka id=ID |
Asiakasrajapinnan resurssit kuvauksineen
Account-resurssi
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Asiakkaan uniikki id-numero |
| extId | STRING | Vaihtoehtoinen asiakasnumero |
| name * | STRING | Asiakkaan nimi |
| location | STRING | Toimipiste |
| department | STRING | Osasto |
| businessCode * | STRING | LY-tunnus |
| vatCode | STRING | VAT-tunnus |
| abbreviation | STRING | Asiakkaan lyhenne |
| isParentAccount | BOOLEAN | Onko emoyhtiö |
| isChildAccount | BOOLEAN | Onko tytäryhtiö |
| parentAccountId | INTEGER | Emoyhtiön id |
| startDate | STRING | Asiakassuhteen alku |
| endDate | STRING | Asiakassuhteen loppu |
| streetAddress | STRING | Käyntiosoite, katu |
| streetPostalCode | STRING | Käyntiosoite, postinumero |
| streetCity | STRING | Käyntiosoite, kaupunki |
| streetState | STRING | Käyntiosoite, lääni |
| streetCountry | STRING | Käyntiosoite, maa |
| postalStreetAddress | STRING | Postitussosoite, katu |
| postalPostalCode | STRING | Postitusosoite, postinumero |
| postalCity | STRING | Postitusosoite, kaupunki |
| postalState | STRING | Postitusosoite, lääni |
| postalCountry | STRING | Postitusosoite, maa |
| invoicingStreetAddress | STRING | Laskutusosoite, katu |
| invoicingPostalCode | STRING | Laskutusosoite, postinumero |
| invoicingCity | STRING | Laskutusosoite, postitoimipaikka |
| invoicingCountry | STRING | Laskutuosoite, maa |
| invoicingName | STRING | Laskutusnimi |
| invoicingCO | STRING | Laskutus C/O |
| phoneNumberCountryCode | STRING | Lankanumero, maakoodi |
| phoneNumberAreaCode | STRING | Lankanumero, suuntanumero |
| phoneNumber | STRING | Lankanumero |
| faxCountryCode | STRING | Faxnumero, maakoodi |
| faxAreaCode | STRING | Faxnumero, suuntanumero |
| faxNumber | STRING | Faxnumero |
| STRING | Sähköpostiosoite | |
| www | STRING | WWW-osoite |
| paymentTerm | INTEGER | Maksuehto |
| eInvoiceAddress | STRING | Verkkolaskutunnus |
| factoringAgreementNumber | STRING | Faktoring sopimusnumero |
| isMarketingBlocked | BOOLEAN | Markkinointikielto |
| isEmailMarketingBlocked | BOOLEAN | Sähköpostimarkkinointikielto |
| creationDateTime | STRING (ISO8601) | Asiakkuuden järjestelmään lisäyspäivä |
| modifiedDateTime | STRING (ISO8601) | Viimeinen modifiointipäivä |
| company | OBJECT | Yhtiö, kts. company |
| eInvoiceOperator | OBJECT | Verkkolaskuoperaattori, kts. eInvoiceOperator |
| status * | OBJECT | Asiakkuuden tila, kts. status |
| lostReason | OBJECT | Asiakassuhteen loppumisen syy, kts. lostReason |
| accountManager | OBJECT | 1. asiakasvastaava, kts. accountManager |
| accountManager2 | OBJECT | 2. asiakasvastaava, kts. accountManager |
| accountManager3 | OBJECT | 3. asiakasvastaava, kts. accountManager |
| accountType | OBJECT | Asiakassuhteen tyyppi, kts. accountType |
| businessType | OBJECT | Asiakkaan yritysmuoto, kts. businessType |
| industry | OBJECT | Asiakkaan toimiala, kts. industry |
| turnoverCategory | OBJECT | Asiakkaan liikevaihtoluokka |
| priceList | OBJECT | Asiakkaan hinnasto |
| invoiceDeliveryMethod | OBJECT | Asiakkaan laskun lähetystapa |
| integrationText1 | STRING | Integraatiotarkoituksia varten oleva tekstikenttä |
| integrationInt1 | INTEGER | Integraatiotarkoituksia varten oleva kokonaislukukenttä |
| integrationDate1 | STRING (ISO8601) | Integraatiotarkoituksia varten oleva päivämääräkenttä |
* Pakollinen tieto
Account/accountManager
Alla on listattu Account -resurssin palauttamat asiakasvastaavan tiedot:
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Uniikki id |
| firstName | STRING | Asiakasvastaavan etunimi |
| surName | STRING | Asiakasvastaavan sukunimi |
| companyId | INTEGER | Asiakasvastaavan yhtiön ID |
| emailAddress1 | STRING | Asiakasvastaavan 1 sähköpostiosoite |
| emailAddress2 | STRING | Asiakasvastaavan 2 sähköpostiosoite |
| streetAddress | STRING | Asiakasvastaavan osoite, katu |
| streetPostalCode | STRING | Asiakasvastaavan osoite, postinumero |
| streetCity | STRING | Asiakasvastaavan osoite, kaupunki |
| streetCountry | STRING | Asiakasvastaavan osoite, maa |
| phoneCountryCode | STRING | Asiakasvastaavan lankanumero, maakoodi |
| phoneAreaCode | STRING | Asiakasvastaavan lankanumero, suuntanumero |
| phoneNumber | STRING | Asiakasvastaavan lankanumero, numero |
| mobileCountryCode | STRING | Asiakasvastaavan kännykkänumero, maakoodi |
| mobileAreaCode | STRING | Asiakasvastaavan kännykkänumero, suuntanumero |
| mobileNumber | STRING | Asiakasvastaavan kännykkänymero, numero |
| faxCountryCode | STRING | Asiakasvastaavan faksinumero, maakoodi |
| faxAreaCode | STRING | Asiakasvastaavan faksinumero, suuntanumero |
| faxNumber | STRING | Asiakasvastaavan faksinumero, numero |
| addedDateTime | STRING(ISO8601) | Päivämäärä kun asiakasvastaava on lisätty järjestelmään |
| addedById | INTEGER | Henkilön ID joka on lisännyt asiakasvastaavan järjestelmään |
| modifiedDateTime | STRING(ISO8601) | Päivämäärä kun asiakasvastaavan tietoja on viimeksi muokattu |
| modifiedById | INTEGER | Asiakasvastaavan tietoja muokanneen henkilön ID |
| isPassive | BOOLEAN | Asiakasvastaava on passivoitu |
Account/company
Alla on listattu Account -resurssin palauttamat yhtiön tiedot:
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Yhtiön uniikki id |
| name | STRING | Yhtiön nimi |
| postalAddress | STRING | Postiosoite, katu |
| postalCode | STRING | Postiosoite, postinumero |
| postalCity | STRING | Postiosoite, kaupunki |
| streetAddress | STRING | Käyntiosoite, katu |
| streetPostalCode | STRING | Käyntiosoite, postinumero |
| streetCity | STRING | Käyntiosoite, kaupunki |
| wwwAddress | STRING | Internetsivuston osoite |
| emailAddress | STRING | Sähköpostiosoite |
| vatCode | STRING | Arvolisäverotunniste |
| addedDateTime | STRING (ISO8601) | Yhtiön lisäys päivämäärä |
| addedById | INTEGER | Yhtiön lisänneen henkilön ID |
| modifiedDateTime | STRING (ISO8601) | Yhtiön tietojen päivitys päivämäärä |
| modifiedById | INTEGER | Yhtiön tietoja päivittäneen henkilön ID |
Account/eInvoiceOperator-resurssi
Verkkolaskuoperaattoriin liittyvät tiedot
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Verkkolaskuoperaattorin uniikki id |
| name | STRING | Verkkolaskuoperaattorin nimi |
| code | STRING | Verkkolaskuoperaattorin operaattoritunnus |
| abbreviation | STRING | Verkkolaskuoperaattorin lyhenne |
Account/status-resurssi
Asiakkuuden tilaan (engl. status) liittyvät tiedot
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Statuksen uniikki id |
| name | STRING | Statuksen selväkielinen nimi |
| active | BOOLEAN | Status on käytettävissä (aktiivinen) |
Account/lostReason-resurssi
Asiakkuussuhteen loppumisen syy
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Uniikki id |
| name | STRING | Asiakassuhteen loppumisen syyn selväkielinen nimi |
Account/accountType-resurssi
Asiakkuussuhteen tyyppi
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Uniikki id |
| name | STRING | Asiakassuhteen tyypin selväkielinen nimi |
Account/businessType-resurssi
Asiakkaan yritysmuoto
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Uniikki id |
| name | STRING | Yritysmuodon selväkielinen selitys |
Account/industry-resurssi
Asiakkaan toimialaluokitus
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Uniikki id |
| name | STRING | Toimialaluokituksen selväkielinen nimi |
Account/turnoverCategory-resurssi
Asiakkaan liikevaihtoluokka
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Uniikki id |
| name | STRING | Liikevaihtoluokan selväkielinen nimi |
Account/PriceList -resurssi
Asiakkaan hinnasto
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Uniikki id |
| name | STRING | Hinnaston nimi |
| description | STRING | Hinnaston kuvaus |
Account/invoiceDeliveryMethod-resurssi
Asiakkaan laskun lähetystapa
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Uniikki id |
| name | STRING | Laskun 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 nimi | Tyyppi | Kuvaus |
| id | INTEGER | Kontaktin uniikki id |
| firstName | STRING | Kontaktin etunimi |
| surName | STRING | Kontaktin sukunimi |
| title | STRING | Kontaktin titteli |
| emailAddress1 | STRING | Kontaktin 1 sähköpostiosoite |
| emailAddress2 | STRING | Kontaktin 2 sähköpostiosoite |
| streetAddress | STRING | Kontaktin osoite, katu |
| streetPostalCode | STRING | Kontaktin osoite, postinumero |
| streetCity | STRING | Kontaktin osoite, kaupunki |
| streetCountry | STRING | Kontaktin osoite, maa |
| phoneCountryCode | STRING | Kontakin lankanumero, maakoodi |
| phoneAreaCode | STRING | Kontakin lankanumero, suuntanumero |
| phoneNumber | STRING | Kontaktin lankanumero, numero |
| mobilePhoneCountryCode | STRING | Kontaktin kännykkänumero, maakoodi |
| mobilePhoneAreaCode | STRING | Kontaktin kännykkänumero, suuntanumero |
| mobilePhoneNumber | STRING | Kontaktin kännykkänumero, numero |
| faxCountryCode | STRING | Kontaktin faksinumero, maakoodi |
| faxAreaCode | STRING | Kontaktin faksinumero, suuntanumero |
| faxNumber | STRING | Kontaktin faksinumero, numero |
| isMarketingBlocked | STRING | Markkinointi kielletty |
| isEmailMarketingBlocked | STRING | Sähköpostimarkkinointi kielletty |
| additionalInfo | STRING | Asiakkaan lisätiedot |
| addedDateTime | STRING (ISO8601) | Päivämäärä kun kontakti on lisätty järjestelmään |
| addedById | INTEGER | Kontaktin järjestelmään lisänneen henkilön ID |
| modifiedDateTime | STRING (ISO8601) | Päivämäärä kun kontaktin tietoja on viimeksi muokattu |
| modifiedById | INTEGER | Kontaktia tietoja päivittäneen henkilön ID |
| isPassive | BOOLEAN | Kontakti on passiivinen |
| comments | STRING | Kommentti |
| integrationText1 | STRING | Integraatiotarkoituksia varten oleva tekstikenttä |
| integrationInt1 | INTEGER | Integraatiotarkoituksia varten oleva kokonaislukukenttä |
| integrationDate1 | STRING (ISO8601) | Integraatiotarkoituksia varten oleva päivämääräkenttä |