itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a range of Contacts of a specific customer
Catalog: VismaNet
Schema: Customer
The data in this table is partitioned per value of the COMPANY_CODE column.
This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive SQL driver for Visma.net Financials does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net Financials API.
Select Visma.net Financials API URL: /controller/api/v1/customer/{customerCd}/contact
Insert Visma.net Financials API URL: /controller/api/v1/customer/{customerCd}/contact
Update Visma.net Financials API URL: /controller/api/v1/customer/{customerCd}/contact
Delete Visma.net Financials API URL: /controller/api/v1/customer/{customerCd}/contact
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/customer/{customerCd}/contact
Table Function Parameters
The following parameters can be used to control the behaviour of the table function CustomerContactsForCustomerByCustomerCode. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
active |
string |
☐ |
|
|
businessAccount |
string |
☐ |
|
|
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
customerCd |
string |
☑ |
|
|
displayName |
string |
☐ |
|
|
string |
☐ |
|
|
|
firstName |
string |
☐ |
|
|
greaterThanValue |
string |
☐ |
|
|
lastModifiedDateTime |
string |
☐ |
|
|
lastModifiedDateTimeCondition |
string |
☐ |
|
|
lastName |
string |
☐ |
|
|
numberToRead |
int32 |
☐ |
|
|
orderBy |
string |
☐ |
|
|
skipRecords |
int32 |
☐ |
|
|
Table Function Columns
The columns of the table function CustomerContactsForCustomerByCustomerCode are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
active |
boolean |
Active |
☐ |
The top part > Active > A check box that indicates (if selected) that the contact is active. |
address_addressId |
int32 |
Address ID |
☐ |
|
address_addressLine1 |
string |
Address Line 1 |
☐ |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. |
address_addressLine2 |
string |
Address Line 2 |
☐ |
Address 2 > The second line of the address. |
address_addressLine3 |
string |
Address Line 3 |
☐ |
Address 3 > The third line of the address. |
address_city |
string |
City |
☐ |
City > The city. |
address_country_errorInfo |
string |
|
☐ |
|
address_country_id |
string |
Country ID |
☐ |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. |
address_country_metadata_maxPageSize |
int64 |
|
☐ |
|
address_country_metadata_totalCount |
int64 |
|
☐ |
|
address_country_name |
string |
Country Name |
☐ |
Mandatory field: Country name* > The complete name of the country. |
address_county_id |
string |
County ID |
☐ |
Click the magnifier > The identifier |
address_county_name |
string |
County Name |
☐ |
Click the magnifier > The displayed name |
address_postalCode |
string |
Postal Code |
☐ |
Postcode > The postcode. |
businessAccount |
string |
Business Account |
☐ |
The top part > Business account > The business account associated with the contact. |
businessAccountType |
string |
|
☐ |
The top part > Business account > The business account type of the business account associated with the contact. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
contactId |
int32 |
Contact ID |
☐ |
The top part > Contact ID > The unique identifier of the contact, which the system generates automatically. |
contactMethod |
string |
Contact Method |
☐ |
CRM section not available in Visma.net ERP |
displayName |
string |
Display Name |
☐ |
|
doNotCall |
boolean |
Do Not Call |
☐ |
CRM section not available in Visma.net ERP |
doNotEmail |
boolean |
Do Not Email |
☐ |
CRM section not available in Visma.net ERP |
doNotFax |
boolean |
Do Not Fax |
☐ |
CRM section not available in Visma.net ERP |
doNotMail |
boolean |
Do Not Mail |
☐ |
CRM section not available in Visma.net ERP |
string |
☐ |
The Details tab > Contact section > Email > The email address of the contact. |
||
fax |
string |
Fax |
☐ |
The Details tab > Contact section > Business fax > The fax number of the contact. |
firstName |
string |
First Name |
☐ |
The top part > First name > The first name of the contact. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
Background information: The date and time when the details of the contact were last updated. |
lastName |
string |
Last Name |
☐ |
Mandatory field: The top part > Last name* > The last name of the contact. |
noMarketing |
boolean |
No Marketing |
☐ |
CRM section not available in Visma.net ERP |
noMassMail |
boolean |
No Mass Mail |
☐ |
CRM section not available in Visma.net ERP |
phone1 |
string |
Phone 1 |
☐ |
The Details tab > Contact section > Business 1/Business 2/Business 3/Business assistant 1/Business fax /Home/Home fax/Mobile > The primary phone number of the contact. Select the type from the drop down. |
phone2 |
string |
Phone 2 |
☐ |
The Details tab > Contact section > Business 1/Business 2/Business 3/Business assistant 1/Business fax /Home/Home fax/Mobile > The primary phone number of the contact. Select the type from the drop down. |
phone3 |
string |
Phone 3 |
☐ |
The Details tab > Contact section > Business 1/Business 2/Business 3/Business assistant 1/Business fax /Home/Home fax/Mobile > The primary phone number of the contact. Select the type from the drop down. |
position |
string |
Position |
☐ |
The top part > Job title > The contact’s job title or position. |
sameAsAccount |
boolean |
Same as Account |
☐ |
The Details tab > Same as in account > A check box that indicates (if selected) that the contact's address is the same as the address of the business account. |
title |
string |
Title |
☐ |
The top part > First name > The contact's courtesy title. |
web |
string |
Web |
☐ |
The Details tab > Contact section > Web > The website of the contact, if any. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
