Resource: vendor.nv
HTTP-method: POST
You can import a new Vendor and edit an existing Vendor.
When importing a Vendor, the API returns the Vendor's NetvisorKey in the response message. We recommend storing this if you need to edit or retrieve the Vendor data later. The Vendor's NetvisorKey can be retrieved via API with the vendor list using the parameter changedsince. In the Netvisor UI, the Vendor's NetvisorKey can be found by opening the vendor card and checking the address bar for the field id (e.g. id=123).
With the message you can import information about the Vendor's bank accounts. Bank accounts are divided into domestic and foreign bank accounts. Bank accounts have different contents:
If the bank account frame does not have its own NetvisorKey value, a new bank account is added for the Vendor. If a NetvisorKey is provided, that bank account will be edited.
The bank account's IsDefault field can be used to set the account as the Default account. If more than one value True is given, the last account in order is set as the Default.
Parameters used in the request:
| Parameter | Type | Occurs | Description |
| --- | --- | --- | --- |
| method | String | 1 | Add Add a new Vendor
Edit Edit an existing Vendor |
| netvisorkey | Numeric | 0...1 | Vendor's NetvisorKey
Mandatory if method = edit |
| useonlyexistingdimensions | Numeric | 0...1 | Prevents automatic creation of new cost object headers and cost objects. Returns an error if the given cost object does not exist.
1 = prevention enabled |
Data of the imported Vendor is sent with the request as XML (POST-data) according to the following description:
| Level | Element | Type | Occurs | Description | Example |
| --- | --- | --- | --- | --- | --- |
| Root | root | Aggregate | 1 | | |
| 1 | vendor | Aggregate | 1 | | |
| 2 | vendorbaseinformation | Aggregate | 1 | | |
| 3 | code | String | 0...1 | Vendor code | 123 |
| 3 | name | String | 1 | Vendor name | Testitoimittaja |
| 3 | address | String | 1 | Address | Toimittajakatu 1 |
| 3 | postcode | String | 1 | Postal code | 00100 |
| 3 | city | String | 1 | City | Helsinki |
| 3 | country | String | 1 | Country code | FI |
| Attr. | type | String | 1 | Country code type | ISO-3166 |
| 3 | organizationid | String | 1 | Business ID | 123456-7 |
| 3 | groupname | String | 0...1 | Vendor group | The toimittajat |
| 3 | vendorbankaccounts | Aggregate | 0...1 | Vendor's bank accounts | |
| 4 | vendordomesticbankaccounts | Aggregate | 0...1 | | |
| 5 | vendordomesticbankaccount | Aggregate | 0...8 | Finnish bank accounts | |
| 6 | netvisorkey | Numeric | 0...1 | Bank account's NetvisorKey | 1 |
| 6 | iban | String | 1 | Account number in IBAN format | FI7536359370000661 |
| 6 | bankname | String | 1 | Bank name | Testipankki |
| 6 | isdefault | String | 0...1 | Use as Default | True |
| 4 | vendorforeignbankaccounts | Aggregate | 0...1 | | |
| 5 | vendorforeignbankaccount | Aggregate | 0...8 | Foreign bank accounts | |
| 6 | netvisorkey | Numeric | 0...1 | Bank account's NetvisorKey | 2 |
| 6 | bban | String | 1 | Account number in BBAN format | GB29NWBK60161331926819 |
| 6 | bicswift | String | 1 | BIC code | BUKBGB22 |
| 6 | bankname | String | 1 | Bank name | Barclays |
| 6 | clearingcode | String | 0...1 | Clearing code | |
| 6 | clearingnumber | String | 0...1 | Clearing number | |
| 6 | bankaddresss | String | 0...1 | Bank address | Bank Street 1 |
| 6 | bankpostcode | String | 0...1 | Bank postal code | |
| 6 | banktown | String | 0...1 | Bank postal address | |
| 6 | country | String | 1 | Country code | GB |
| Attr. | type | String | 1 | Country code type | ISO-3166 |
| 6 | currencycode | String | 1 | Currency code | GBP |
| Attr. | type | String | 1 | Currency code type | ISO-4217 |
| 6 | isdefault | String | 0...1 | Use as Default | False |
| 6 | includeaddresssinforeignpayments | String | 0...1 | Export bank address details to the payment message in addition to the BIC code | True |
| 2 | vendorcontactdetails | Aggregate | 0...1 | Vendor's contact information | |
| 3 | phonenumber | String | 0...1 | Phone number | +35850123456 |
| 3 | email | String | 0...1 | Email | [email protected] |
| 3 | faxnumber | String | 0...1 | Fax | |
| 3 | contactpersonname | String | 0...1 | Contact person's name | Timo Testaaja |
| 3 | contactpersonphonenumber | String | 0...1 | Contact person's phone number | +35840987654 |
| 3 | contactpersonemail | String | 0...1 | Contact person's email | [email protected] |
| 3 | homepage | String | 0...1 | Home page | |
| 3 | comment | String | 0...1 | Comment | No comments |
| 2 | vendoradditionalinformation | Aggregate | 0...1 | | |
| 3 | usedefaultpaymentterminreceivedinvoices | String | 0...1 | False | Use the Vendor's Default term of payment in incoming purchase invoices. Default term of payment is set in the needed elements paymenttermdiscountpercent, paymenttermcashdiscountdays and paymenttermnetdays. |
| 3 | defaultvatpercent | Numeric | 0...1 | Default VAT rate | 24 |
| 3 | ispartialvatreduceprivileged | String | 0...1 | Only partial VAT deduction right | False |
| 3 | paymenttermdiscountpercent | Numeric | 0...1 | Discount percentage | |
| 3 | paymenttermcashdiscountdays | Numeric | 0...1 | Discount days | |
| 3 | paymenttermnetdays | Numeric | 0...1 | Default term of payment | |
| 3 | currencycode | Currency code | 0...1 | Default currency | EUR |
| Attr. | type | String | 1 | Currency code type | ISO-4217 |
| 3 | vendordimensions | Aggregate | 0...1 | Default cost objects | |
| 4 | dimension | Aggregate | 1...n | | |
| 5 | dimensionname | String | 1 | Cost object header | Project |
| 5 | dimensionitem | String | 1 | Cost object | Project 1 |
| 5 | dimensionitemcode | String | 0...1 | Cost object code
(when this is given, the dimensionitem element is ignored) | DIMC-001 |
| 5 | dimensionitemname | String | 0...1 | Cost object name
(when this is given, the dimensionitem element is ignored) | Item Name 1 |
| 3 | vendoraccountingaccounts | Aggregate | 0...1 | Vendor accounting accounts | |
| 4 | vendoraccountingaccount | Aggregate | 1...n | | |
| 5 | accountnumber | String | 1 | Accounting account | 4000 |
| 5 | isdefault | String | 1 | Use as Default | True |
| 3 | vendoracceptancedetails | Aggregate | 0...1 | Factual verifiers | |
| 4 | vendoracceptancedetail | Aggregate | 1...n | | |
| 5 | acceptancename | String | 0...1 | Factual verifier name | Taaki Tarkastaja |
| 5 | isdefault | String | 0...1 | Use as Default | False |
| 5 | isforced | String | 0...1 | | |
*This article has been translated using an AI-based translation tool. The contents or wording of these instructions may differ from those in other instructions or in the software.
*