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

MethodReturn TypeDescription
GET contactcontactGets a contact object.
DELETE contactnoneDeletes a contact object.
POST contactcontactCreates a contact object.
PATCH contactcontactUpdates a contact object.
NavigationReturn TypeDescription
contactInformationcontactInformationGets the contactinformation of the contact.
picturepictureGets the picture of the contact.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the contact. Non-editable.
numberstringSpecifies the number of the contact.
typeNAV.contactTypeSpecifies the type of contact, can be "Company" or "Person".
displayNamestringSpecifies the contact's name. This name will appear on all sales documents for the contact.
jobTitlestringThe job title of the contact.
companyNumberstringThe number of the company.
companyNamestringThe name of the company.
contactBusinessRelationNAV.contactBusinessRelation
addressLine1stringSpecifies the contact's address. This address will appear on all sales documents for the contact.
addressLine2stringSpecifies the contact's address. This address will appear on all sales documents for the contact.
citystringSpecifies the contact's city.
statestringSpecifies the contact's state.
countrystringSpecifies the contact's country.
postalCodestringSpecifies the contact's postal code.
phoneNumberstringSpecifies the contact's telephone number.
mobilePhoneNumberstringThe mobile phone number.
emailstringSpecifies the contact's email address.
websitestringSpecifies the contact's home page address.
searchNamestringThe name used for searching.
privacyBlockedbooleanSpecifies whether the privacy of the contact is blocked.
taxRegistrationNumberstringSpecified the tax registration number of the contact.
lastInteractionDatedateThe date of the last interaction with the contact.
lastModifiedDateTimedatetimeThe last datetime the contact was modified. Read-Only.

JSON representation

Here's 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.

GET contact
DELETE contact
POST contact
PATCH contact