contact resource type
Represents a contact in Business Central.
Availability Information
This endpoint is only available if KatarGo is installed. Click here for the documentation without KatarGo.
Note
For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.
Methods
| Method | Return Type | Description |
|---|---|---|
| GET contact | contact | Gets a contact object. |
| POST contact | contact | Creates a contact object. |
| PATCH contact | contact | Updates a contact object. |
| DELETE contact | contact | Deletes a contact object |
Bound Actions
The contact resource type offers a bound action called createCustomer which creates a customer for the selected contact. The precondition for this is that a customer template is assigned to the contact.
This is illustrated in the following example:
CREATECUSTOMER https://{businesscentralPrefix}/api/v2.0/companies({id})/contactsKTG({id})/Microsoft.NAV.createCustomer
The response has no content; the response code is 201.
Navigation
| Navigation | Return Type | Description |
|---|---|---|
| picture | picture | Gets the picture of the contact. |
| contactBusinessRelationsWebCon | contactBusinessRelationsWebCon | Gets the contactBusinessRelationsWebCon of the contact |
Properties
| Property | Type | Description | Max Length |
|---|---|---|---|
| 🔑 id | GUID | The unique ID of the contact. Non-editable. | |
| number | string | Specifies the number of the contact. | 20 |
| type | NAV.contactType | Specifies the type of contact, can be "Company" or "Person". | |
| displayName | string | Specifies the contact's name. This name will appear on all sales documents for the contact. | 100 |
| name2 | string | Specifies the contact's name 2. | 50 |
| firstName | string | Specifies the contact's first name. | 30 |
| middleName | string | Specifies the contact's middle name. | 30 |
| surname | string | Specifies the contact's surname. | 30 |
| companyNumber | string | The number of the company. | 20 |
| companyName | string | The name of the company. | 100 |
| contactBusinessRelation | NAV.contactBusinessRelation | The business relation with the contact. | |
| addressLine1 | string | Specifies the contact's address. This address will appear on all sales documents for the contact. | 100 |
| addressLine2 | string | Specifies the contact's address. This address will appear on all sales documents for the contact. | 50 |
| city | string | Specifies the contact's city. | 30 |
| state | string | Specifies the contact's state. | 30 |
| country | string | Specifies the contact's country. | 10 |
| postalCode | string | Specifies the contact's postal code. | 20 |
| phoneNumber | string | Specifies the contact's telephone number. | 30 |
| mobilePhoneNumber | string | The mobile phone number. | 30 |
| string | Specifies the contact's email address. | 80 | |
| website | string | Specifies the contact's home page address. | 80 |
| searchName | string | The name used for searching. | 100 |
| privacyBlocked | boolean | Specifies whether the privacy of the contact is blocked. | |
| taxRegistrationNumber | string | Specified the tax registration number of the contact. | 20 |
| lastInteractionDate | date | The date of the last interaction with the contact. | |
| lastModifiedDateTime | datetime | The last datetime the contact was modified. Read-Only. | |
| customerTemplateId | GUID | Specifies the unique ID of the customer template | |
| customerTemplateCode | string | Specifies the unique Code of the customer template | 20 |
| customerTemplateCode | string | Specifies the unique Code of the customer template | 20 |
| currencyCode | String | The default currency code for the contact. | |
| languageCode | string | Specifies the language code of the contact. | 10 |
| salutationCode | string | Specifies the salutation code of the contact. | 10 |
| onlinePassword | string | Specifies the online password of the contact. | |
| onlineLogin | string | Specifies the online Login of the contact. | 80 |