contact resource type
Represents a contact in Business Central.
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. |
DELETE contact | none | Deletes a contact object. |
POST contact | contact | Creates a contact object. |
PATCH contact | contact | Updates a contact object. |
Navigation
Navigation | Return Type | Description |
---|---|---|
contactInformation | contactInformation | Gets the contactinformation of the contact. |
picture | picture | Gets the picture of the contact. |
Properties
Property | Type | Description |
---|---|---|
id | GUID | The unique ID of the contact. Non-editable. |
number | string | Specifies the number of the contact. |
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. |
jobTitle | string | The job title of the contact. |
companyNumber | string | The number of the company. |
companyName | string | The name of the company. |
contactBusinessRelation | NAV.contactBusinessRelation | |
addressLine1 | string | Specifies the contact's address. This address will appear on all sales documents for the contact. |
addressLine2 | string | Specifies the contact's address. This address will appear on all sales documents for the contact. |
city | string | Specifies the contact's city. |
state | string | Specifies the contact's state. |
country | string | Specifies the contact's country. |
postalCode | string | Specifies the contact's postal code. |
phoneNumber | string | Specifies the contact's telephone number. |
mobilePhoneNumber | string | The mobile phone number. |
string | Specifies the contact's email address. | |
website | string | Specifies the contact's home page address. |
searchName | string | The name used for searching. |
privacyBlocked | boolean | Specifies whether the privacy of the contact is blocked. |
taxRegistrationNumber | string | Specified the tax registration number of the contact. |
lastInteractionDate | date | The date of the last interaction with the contact. |
lastModifiedDateTime | datetime | The last datetime the contact was modified. Read-Only. |
JSON representation
Here is a JSON representation of the contact resource.
{
"id": "GUID",
"number": "string",
"type": "NAV.contactType",
"displayName": "string",
"jobTitle": "string",
"companyNumber": "string",
"companyName": "string",
"contactBusinessRelation": "NAV.contactBusinessRelation",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"email": "string",
"website": "string",
"searchName": "string",
"privacyBlocked": "boolean",
"taxRegistrationNumber": "string",
"lastInteractionDate": "date",
"lastModifiedDateTime": "datetime"
}
Remarks
This resource type requires Business Central version 18.0.