Resurssi: getvendor.nv
HTTP-metodi: GET
Palauttaa toimittajan tiedot. Toimittajan tiedot noudetaan NetvisorKey:n tai muutosaikaleiman perusteella. Toimittajien NetvisorKey:t saa noudettua rajapinnan yli käyttämällä muutosaikaleima (changedsince) parametria.
Netvisorin käyttöliittymässä toimittajan NetvisorKey:n saa tietoon avaamalla toimittajakortin ja katsomalla sen osoiteriviltä kohdasta 'id' (esim. id=123).
Kutsussa käytettävät parametrit:
| Parametri | Ilmentymiä | Kuvaus | Esimerkki |
| netvisorkey | 1 | Toimittajan tunniste Netvisorissa. Vastauksen juurielementtinä "vendor". | 1 |
| netvisorkeylist | 0...1 | Palauttaa yhdessä pyynnössä tiedot toimittajista. Huomioithan, että kaikilla annetuilla ID:illä on löydyttävä toimittaja, muuten tulee vastauksena pelkkä virhe: "Toimittajaa ei löydy, netvisorkey NNN". Vastauksen juurielementtinä on "vendors", jos annetussa listassa on useita ID:itä, mutta"vendor" jos annettu vain yksi ID. | 1,2,3 |
| changedsince | 0...1 | Suodattaa toimittajat, joissa muutoksia annetun päivämäärän jälkeen. Päivämäärällä annetaan muodossa YYYY-MM-DD tai aikaleimalla YYYY-MM-DDTHH:MM:SS. Vastauksen juurielementtinä on "vendors" jos listassa on useita ID:itä. Jos muuttuneita toimittaja ei ole, vendors-elementin sisältö on tyhjä. Mikäli halutaan noutaa koko toimittajalistaus, parametrin päivämääränä voi antaa: getvendor.nv?changedsince=1970-01-01 | |
| page | 0...1 | Numeerinen arvo, jolla voi hakea toimittajatietoja 500 toimittajan sivuissa. Jokainen sivu pitää hakea omalla kutsullaan. Sivutuksen tiedot palautetaan rajapinnan vastaussanoman header-tiedoissa. Esim: X-Netvisor-Pagination-Current-Page : 2 X-Netvisor-Pagination-Previous-Page : 1 X-Netvisor-Pagination-Next-Page : 3 X-Netvisor-Pagination-Limit : 100 X-Netvisor-Pagination-Total-Count : 1000 | 2 |
Vastaus:
| Taso | Elementti | Muoto | Ilmentymiä | Kuvaus | Esimerkki |
| Root | Root | Aggregaatti | 1 | ||
| 1 | Vendor | Aggregaatti | 1 | Juurielementti voi olla "vendor" tai "vendors", katso parametrien kuvauksista tarkemmat ohjeet. | |
| 2 | NetvisorKey | Numeerinen | 1 | Toimittajan NetvisorKey | 123 |
| 2 | VendorBaseInformation | Aggregaatti | 1 | ||
| 3 | Code | Merkkijono | 0...1 | Toimittajakoodi | 123 |
| 3 | Name | Merkkijono | 1 | Toimittajan nimi | Testitoimittaja |
| 3 | Address | Merkkijono | 1 | Osoite | Toimittajakatu 1 |
| 3 | PostCode | Merkkijono | 1 | Postikoodi | 00100 |
| 3 | City | Merkkijono | 1 | Kaupunki | Helsinki |
| 3 | Country | Merkkijono | 1 | Maakoodi | FI |
| Attr. | type | Merkkijono | 1 | Maakoodin tyyppi | ISO-3166 |
| 3 | OrganizationId | Merkkijono | 1 | Y-tunnus | 1234567-8 |
| 3 | GroupName | Merkkijono | 0...1 | Toimittajaryhmä | The toimittajat |
| 3 | VendorBankAccounts | Aggregaatti | 0...1 | Toimittajan pankkitilit | |
| 4 | VendorDomesticBankAccounts | Aggregaatti | 0...1 | ||
| 5 | VendorDomesticBankAccount | Aggregaatti | 0...8 | Suomalaiset pankkitilit | |
| 6 | NetvisorKey | Numeerinen | 0...1 | Pankkitilin NetvisorKey | 1 |
| 6 | IBAN | Merkkijono | 1 | Tilinumero IBAN muodossa | FI7536359370000661 |
| 6 | BankName | Merkkijono | 1 | Pankin nimi | Testipankki |
| 6 | IsDefault | Merkkijono | 0...1 | Käytetäänkö oletuksena | True |
| 4 | VendorForeignBankAccounts | Aggregaatti | 0...1 | Ulkomaalaiset pankkitilit | |
| 5 | VendorForeignBankAccount | Aggregaatti | 0...8 | Ulkomaalainen pankkitili | |
| 6 | NetvisorKey | Numeerinen | 0...1 | Pankkitilin NetvisorKey | 2 |
| 6 | BBAN | Merkkijono | 1 | Tilinumero BBAN muodossa | GB29NWBK60161331926819 |
| 6 | BicSwift | Merkkijono | 1 | BIC numero | BUKBGB22 |
| 6 | BankName | Merkkijono | 1 | Pankin nimi | Barclays |
| 6 | ClearingCode | Merkkijono | 0...1 | Clearing koodi | |
| 6 | ClearingNumber | Merkkijono | 0...1 | Clearing numero | |
| 6 | BankAddresss | Merkkijono | 0...1 | Pankin osoite | Bank Street 1 |
| 6 | Country | Merkkijono | 1 | Maakoodi | GB |
| Attr. | type | Merkkijono | 1 | Maakoodin tyyppi | ISO-3166 |
| 6 | CurrencyCode | Merkkijono | 1 | Valuuttakoodi | GBP |
| Attr. | type | Merkkijono | 1 | Valuuttakoodin tyyppi | ISO-4217 |
| 6 | IsDefault | Merkkijono | 0...1 | Käytetäänkö oletuksena | False |
| 6 | IncludeAddresssInForeignPayments | Merkkijono | 0...1 | Vie pankin osoitetiedot maksusanomalle BIC-koodin lisäksi | True |
| 2 | VendorContactDetails | Aggregaatti | 0...1 | Toimittajan yhteystiedot | |
| 3 | PhoneNumber | Merkkijono | 0...1 | Puhelinnumero | +35850123456 |
| 3 | Merkkijono | 0...1 | Sähköposti | toimittaja@toimittajat.fi | |
| 3 | FaxNumber | Merkkijono | 0...1 | Faksi | |
| 3 | ContactPersonName | Merkkijono | 0...1 | Yhteyshenkilön nimi | Timo Testaaja |
| 3 | ContactPersonPhoneNumber | Merkkijono | 0...1 | Yhteyshenkilön puhelinnumero | +35840987654 |
| 3 | ContactPersonEmail | Merkkijono | 0...1 | Yhteyshenkilön | timo.testaaja@toimittajat.fi |
| 3 | HomePage | Merkkijono | 0...1 | Kotisivut | |
| 3 | Comment | Merkkijono | 0...1 | Kommentti | No comments |
| 2 | VendorAdditionalInformation | Aggregaatti | 0...1 | ||
| 6 | UseDefaultPaymentTermInReceivedInvoices | Merkkijono | 0...1 | Käytä aina oletusmaksuehtoa saapuvissa laskuissa | True |
| 3 | DefaultVatpercent | Numeerinen | 0...1 | Oletus ALV-kanta | 24 |
| 3 | IsPartialVatReducedPrivileged | Merkkijono | 0...1 | Vain osittainen ALV-vähennysoikeus | False |
| 3 | PaymentTerm | Numeerinen | 0...1 | Oletusmaksuehto | 3 |
| 3 | VendorDimensions | Aggregaatti | 0...1 | Oletuslaskentakohteet | |
| 4 | Dimension | Aggregaatti | 1 | ||
| 5 | DimensionName | Merkkijono | 1 | Laskentakohdeotsikko | Projekti |
| 5 | DimensionItem | Merkkijono | 1 | Laskentakohde | Projekti 1 |
| 3 | VendorAccountingAccounts | Aggregaatti | 0...1 | Toimittajan kirjanpidon tilit | |
| 4 | VendorAccountingAccount | Aggregaatti | 1 | ||
| 5 | AccountNumber | Merkkijono | 1 | Kirjanpidon tili | 4000 |
| 5 | AccountName | ||||
| 5 | IsDefault | Merkkijono | 1 | Käytetäänkö oletuksena | True |
| 3 | VendorAcceptanceDetails | Aggregaatti | 0...1 | Asiatarkastajat | |
| 4 | VendorAcceptanceDetail | Aggregaatti | 1...n | ||
| 5 | AcceptanceName | Merkkijono | 0...1 | Asiatarkastajan nimi | Taaki Tarkastaja |
| 5 | IsDefault | Merkkijono | 0...1 | Käytetäänkö oletuksena | False |
| 5 | IsForced | Merkkijono | 0...1 |
Oliko tästä vastauksesta apua? Kyllä Ei
Send feedbackPahoittelut, että emme voineet auttaa. Anna palautetta, jotta voimme parantaa tätä artikkelia.