Resource: getcustomer.nv
HTTP-method: GET
Before retrieving customer details from Netvisor, you must first retrieve the customer list and pick the customer identifier (NetvisorKey) from there. With this you can retrieve more detailed information. Customer details can be retrieved either one customer at a time or by using the idlist parameter for max. 500 customers.
Querystring parameters:
| Parameter name | Occurs | Example | Description |
| id | 1 | 123 | NetvisorKey, i.e. ID of the customer to be retrieved |
| idlist | 0...1 | 1,2,3 | Returns full details of all requested customers in one request, max. 500 IDs |
| replyoption | 0...1 | 1 | Returns details of customer's receivables turnover times |
| replyoption | 0...1 | 8 | Returns information on customer's default invoicing method BuyerServiceCode |
| replyoption | 0...1 | 4 | Returns information on customer's additional information fields CustomTags |
| replyoption | 0...1 | 2 | Returns information on customer's automatic reminders AutomationRule |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| 1 | Customer | Aggr. | 1 | ||
| 2 | CustomerBaseInformation | Aggr. | 1 | ||
| 3 | NetvisorKey | Integer | 1 | Customer Netvisor key | 1001 |
| 3 | InternalIdentifier | String | 1 | Customer code | MM |
| 3 | ExternalIdentifier | String | 1 | Business id | 1967543-8 |
| 3 | OrganizationUnitNumber | Number | 0...1 | OVT identifier | 00371967543815 |
| 3 | CustomerGroupNetvisorKey | String | 0...1 | Netvisor identifier of customer group | |
| 3 | CustomerGroupName | String | 0...1 | Name of the customer group | |
| 3 | Name | String | 1 | Name of the customer | Matti Meikäläinen |
| 3 | NameExtension | String | 1 | Extension for the name of the customer | Toimitusjohtaja |
| 3 | StreetAddress | String | 1 | Customer's street address | Pajukuja 1 |
| 3 | AdditionalStreetAddress | String | 1 | Address extension | |
| 3 | City | String | 1 | Postal address | Lappeenranta |
| 3 | PostNumber | String | 1 | Customer's post number | 53100 |
| 3 | Country | String | 0...1 | Country code in ISO-3166 format | FI |
| Attr. | type | String | 0...1 | Country code format, always ISO-3166 | ISO-3166 |
| 3 | PhoneNumber | String | 1 | Customer's phone number | 040 123 456 |
| 3 | FaxNumber | String | 1 | Customer's fax number | 05 123 456 |
| 3 | String | 1 | Customer's email address | matti.meikalainen@firma.fi | |
| 3 | EmailInvoicingAddress | String | 1 | Email invoice address | matti.meikalainen@firma.fi |
| 3 | HomePageUri | String | 1 | Customer's web site | www.firma.fi |
| 3 | IsActive | Number | 1 | 0 or 1, is customer active | 1 |
| 3 | IsPrivateCustomer | Number | 1 | 1 if private customer, 0 if not private customer | 1 |
| 2 | CustomerFinvoiceDetails | Aggr. | 1 | ||
| 3 | FinvoiceAddress | String | 1 | E-invoice address | FI10970021497 |
| 3 | FinvoiceRouterCode | String | 1 | E-invoice operator | NDEAFIHH |
| 2 | CustomerDeliveryDetails | Aggr. | 1 | Customer's default place of business | |
| 3 | DeliveryName | String | 1 | Name for the delivery | |
| 3 | DeliveryStreetAddress | String | 1 | Delivery address | |
| 3 | DeliveryCity | String | 1 | Postal address | |
| 3 | DeliveryPostNumber | String | 1 | Delivery post number | |
| 3 | DeliveryCountry | String | 0...1 | Delivery country | |
| Attr. | type | String | 0...1 | Country code format, always ISO-3166 | ISO-3166 |
| 2 | CustomerContactDetails | Aggr. | 1 | ||
| 3 | ContactPerson | String | 1 | Default contact person's name | |
| 3 | ContactPersonEmail | String | 1 | Default contact person's email | |
| 3 | ContactPersonPhone | String | 1 | Default contact person's phone number | |
| 2 | CustomerContactPersons | Aggr. | 0..1 | ||
| 3 | CustomerContactPerson | Aggr. | 1 | ||
| 4 | ContactPersonID | Integer | 1 | Contact person's NetvisorID | 1006 |
| 4 | ContactPersonFirstName | String | 1 | Contact person's first name | Eric |
| 4 | ContactPersonLastName | String | 1 | Contact person's last name | Example |
| 4 | ContactPersonPhoneNumber | Integer | 1 | Contact person's phone number | 0501234567 |
| 4 | ContactPersonEmail | String | 1 | Contact person's email address | eric.example@firma.fi |
| 4 | ContactPersonOfficeNetvisorKey | Integer | 1 | Contact person's office Netvisor id | 2 |
| 2 | CustomerOfficeDetails | Aggr. | 0...n | Customer offices details | |
| 3 | OfficeNetvisorKey | Integer | 1 | Office NetvisorID | 10 |
| 3 | OfficeName | String | 1 | Office name | Helsingin toimisto |
| 3 | OfficePhoneNumber | String | 1 | Office phone | 040 312 654 |
| 3 | OfficeTelefaxNumber | String | 1 | Office fax | 05 321 654 |
| 3 | OfficeIdentifier | String | 1 | Office identifier | toimipaikkatunnus |
| 3 | OfficeContactAddress | Aggr. | 1 | Office postal address | |
| 4 | StreetAddress | String | 0...1 | Street address | Keskuskatu 1 |
| 4 | PostNumber | String | 0...1 | Postcode | 00100 |
| 4 | City | String | 0...1 | City | Helsinki |
| 4 | Country | String | 0...1 | Country | Suomi |
| 3 | OfficeVisitAddress | Aggr. | 1 | Visiting address | |
| 4 | StreetAddress | String | 0...1 | Street address | Keskuskatu 1 |
| 4 | PostNumber | String | 0...1 | Postcode | 00100 |
| 4 | City | String | 0...1 | City | Helsinki |
| 4 | Country | String | 0...1 | Country | Suomi |
| 3 | OfficeFinvoiceDetails | Aggr. | 1 | Office e-invoice details | |
| 4 | FinvoiceAddress | String | 0...1 | E-invoice address (IBAN or OVT) | 003716264123 |
| 4 | FinvoiceRouterCode | String | 0...1 | E-invoice operator | 003721291126 |
| 2 | CustomerAdditionalInformation | Aggr. | 1 | ||
| 3 | Comment | String | 1 | Comment text | |
| 3 | CustomerAgreementIdentifier | String | 1 | Contract id | |
| 3 | ReferenceNumber | String | 1 | Standard reference | |
| 3 | UseCreditorReferenceNumber | Integer | 1 | Use RF reference in invoicing. 1 or 0 | 1 |
| 3 | UseOrderReferenceNumber | Number | 1 | Use order reference number in invoicing: | 0 or 1 |
| 3 | YourDefaultReference | String | 1 | Your default reference | |
| 3 | DefaultTextBeforeInvoiceLines | String | 1 | Default text before invoice rows | |
| 3 | DefaultTextAfterInvoiceLines | String | 1 | Default text after invoice rows | |
| 3 | DefaultPaymentTerm | String | 1 | Default payment term | 14 days net |
| Attr. | NetvisorKey | String | 1 | NetvisorKey (ID) | 2 |
| 3 | TaxHandlingType | String | 1 | Default tax handling type | Asiakkaan laskutusmaaryhmän mukainen käsittely |
| 3 | BalanceLimit | Decimal | 1 | Customer's balance limit, two decimal accuracy. | |
| 3 | DefaultSalesPerson | String | 0...1 | Name of the default seller | |
| 3 | DiscountPercentage | Number | 0...1 | Discount percentage | 10 |
| 3 | PriceGroup | String | 0...1 | Price group in which customer is linked | |
| 3 | FactoringAccount | String | 0...1 | Customer's factoring account name | Factoring |
| Attr. | NetvisorKey | String | 1 | Factoring account's NetvisorID | 1 |
| 3 | InvoicingLanguage | String | 0...1 | Customer's invoicing language | FI |
| Attr. | type | String | 1 | Country code format, always ISO-3166 | ISO-3166 |
| 3 | EUStandardFinvoice | Number | 0...1 | E-invoice that complies w/ EU standard, 1=yes, 0=no | 1 |
| 3 | InCollectionProhibitation | Number | 1 | Collection prohibition, 1=yes, 0=no | 1 |
| 3 | CustomerDimensions | Aggr. | 0...1 | ||
| 4 | Dimension | Aggr. | 0...n | ||
| 5 | DimensionName | String | 1 | Customer specific dimension header | Eläimet |
| Attr. | NetvisorKey | String | 1 | Dimension header Netvisor ID | 4 |
| 5 | DimensionItem | String | 1 | Customer specific cost object If an identifier has been set for the cost object, the response will contain a combined name, i.e. identifier + name, for example "P001 Verkkosivuston uudistus" | Kissat |
| Attr. | NetvisorKey | String | 1 | Dimension Netvisor ID | 117 |
| 5 | DimensionItemName | String | 0...1 | Cost object name | Verkkosivuston uudistus |
| 5 | DimensionItemCode | String | 0...1 | Cost object identifier | P001 |
| 2 | AdditionalInformation | Aggr. | 0...1 | ||
| BuyerServiceCode | String | Customer's default invoicing method | 00 - Consumer e-invoice 01 - Direct payment / - none | ||
| 3 | CustomTag | String | 1 | Additional information field | Laivatyö alv 0% ALV 58 § |
| attr. | NetvisorKey | String | 1 | Additional information field NetvisorKey | 5 |
| 3 | ReceivablesManagement | Aggr. | 1 | Receivables turnover times | |
| 4 | TurnoverDays | String | 1 | Average payment time | 42 |
| 4 | TurnoverDeviation | String | 1 | Payment date in relation to due date | 28 |
Change history
| Date | Change | Description |
| New elements DimensionItemName and DimensionItemCode Change to the logic of element DimensionItem | According to Netvisor's new cost object handling, the response now returns the cost object identifier if an identifier has been given for the cost object in Netvisor. If an identifier has been given, the DimensionItem element will also return the cost object identifier together with the name. | |
| 12.12.2024 | New element InCollectionProhibitation | Response now includes information regarding the collection prohibition status. |
| 9.10.2025 | New parameters | CustomTags and AutomationRule |
Did you find it helpful? Yes No
Send feedback