Resource: getvendor.nv
HTTP-method: GET
Returns vendor information. Vendor information is retrieved based on NetvisorKey or alteration timestamp. Vendors' NetvisorKeys can be retrieved over the API by using the alteration timestamp (changedsince) parameter.
In Netvisor UI, the vendor's NetvisorKey can be found by opening the vendor card and checking the address bar for 'id' (e.g. id=123).
Parameters used in the request:
| Parameter | Occurs | Description | Example |
| --- | --- | --- | --- |
| netvisorkey | 1 | Vendor identifier in Netvisor.
The root element in the response is "vendor". | 1 |
| netvisorkeylist | 0...1 | Returns information about vendors in a single request.
Note that for all given IDs there must be a corresponding vendor, otherwise the response will only contain an error: "Vendor not found, netvisorkey NNN".
The root element in the response is "vendors" if the given list contains several IDs, but"vendor" if only one ID is given. | 1,2,3 |
| changedsince | 0...1 | Filters vendors that have changes after the given date. The date is given in format YYYY-MM-DD or timestamp YYYY-MM-DDTHH:MM:SS.
The root element in the response is "vendors" if the list contains several IDs. If there are no changed vendors, the content of the vendors element is empty.
If you want to retrieve the whole vendor list, you can use the following date value for the parameter: getvendor.nv?changedsince=1970-01-01 | |
| page | 0...1 | Numeric value that can be used to retrieve vendor information in pages of 500 vendors. Each page must be requested with its own call.
Paging information is returned in the response message header fields, for example:
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 |
Response:
| Level | Element | Type | Occurs | Description | Example |
| --- | --- | --- | --- | --- | --- |
| Root | Root | Aggr. | 1 | | |
| 1 | Vendor | Aggr. | 1 | The root element in the response can be "vendor" or "vendors", see parameter descriptions for more detailed instructions. | |
| 2 | NetvisorKey | Numeric | 1 | Vendor's NetvisorKey | 123 |
| 2 | VendorBaseInformation | Aggr. | 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 | Type of country code
| ISO-3166 |
| 3 | OrganizationId | String | 1 | Business ID | 1234567-8 |
| 3 | GroupName | String | 0...1 | Vendor group | The toimittajat |
| 3 | VendorBankAccounts | Aggr. | 0...1 | Vendor's bank accounts
| |
| 4 | VendorDomesticBankAccounts | Aggr. | 0...1 | | |
| 5 | VendorDomesticBankAccount | Aggr. | 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 | Used as default or not | True |
| 4 | VendorForeignBankAccounts | Aggr. | 0...1 | Foreign bank accounts
| |
| 5 | VendorForeignBankAccount | Aggr. | 0...8 | Foreign bank account | |
| 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 number
| BUKBGB22 |
| 6 | BankName | String | 1 | Bank name | Barclays |
| 6 | ClearingCode | String | 0...1 | Clearing code
| |
| 6 | ClearingNumber | String | 0...1 | Clearing number
| |
| 6 | BankAddress | 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 | Used as default or not | False |
| 6 | IncludeAddresssInForeignPayments | String | 0...1 | Transfer bank address information to payment message in addition to BIC code | True |
| 2 | VendorContactDetails | Aggr. | 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 name
| Timo Testaaja |
| 3 | ContactPersonPhoneNumber | String | 0...1 | Contact person phone number
| +35840987654 |
| 3 | ContactPersonEmail | String | 0...1 | Contact person email | [email protected] |
| 3 | HomePage | String | 0...1 | Home page | |
| 3 | Comment | String | 0...1 | Comment | No comments |
| 2 | VendorAdditionalInformation | Aggr. | 0...1 | | |
| 6
| UseDefaultPaymentTermInReceivedInvoices | String | 0...1 | Always use default term of payment on received invoices
| True |
| 3 | DefaultVatPercent | Numeric | 0...1 | Default VAT rate | 24 |
| 3 | IsPartialVatReducedPrivileged | String | 0...1 | Only partial VAT deduction right | False |
| 3 | PaymentTerm | Numeric | 0...1 | Default term of payment | 3 |
| 3 | VendorDimensions | Aggr. | 0...1 | Default cost objects | |
| 4 | Dimension | Aggr. | 1 | | |
| 5 | DimensionName | String | 1 | Cost object header | Projekti |
| 5 | DimensionItem | String | 1 | Cost object
If an identifier has been set for the cost object, the combined name (identifier + name) is returned, e.g. "P001 Website renewal"
| Projekti 1 |
| 5 | DimensionItemName | String | 0...1 | Cost object name | Verkkosivuston uudistus |
| 5 | DimensionItemCode | String | 0...1
| Cost object identifier | P001 |
| 3 | VendorAccountingAccounts | Aggr. | 0...1 | Vendor accounting accounts | |
| 4 | VendorAccountingAccount | Aggr. | 1 | | |
| 5 | AccountNumber | String | 1 | Accounting account | 4000 |
| 5 | AccountName | | | | |
| 5 | IsDefault | String | 1 | Used as default or not | True |
| 3 | VendorAcceptanceDetails | Aggr. | 0...1 | Factual verifiers | |
| 4 | VendorAcceptanceDetail | Aggr. | 1...n | | |
| 5 | AcceptanceName | String | 0...1 | Factual verifier name | Taaki Tarkastaja |
| 5 | IsDefault | String | 0...1 | Used as default or not | 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.
*