location resource type

Represents a location 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 locationlocationGets a location object.
DELETE locationnoneDeletes a location object.
POST locationlocationCreates a location object.
PATCH locationlocationUpdates a location object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the location. Non-editable.
codestringThe code of the location.
displayNamestringSpecifies the location's name. This name will appear on all sales documents for the location.
contactstring
addressLine1stringSpecifies the location's address. This address will appear on all sales documents for the location.
addressLine2stringSpecifies the location's address. This address will appear on all sales documents for the location.
citystringSpecifies the location's city.
statestringSpecifies the location's state.
countrystringSpecifies the location's country.
postalCodestringSpecifies the location's postal code.
phoneNumberstringSpecifies the location's telephone number.
emailstringSpecifies the location's email address.
websitestringSpecifies the location's home page address.
lastModifiedDateTimedatetimeThe last datetime the location was modified. Read-Only.

JSON representation

Here's a JSON representation of the location resource.

{
    "id": "GUID",
    "code": "string",
    "displayName": "string",
    "contact": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string",
    "phoneNumber": "string",
    "email": "string",
    "website": "string",
    "lastModifiedDateTime": "datetime"
}

GET location
DELETE location
POST location
PATCH location