Edit

Share via

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

Method Return Type Description
GET location location Gets a location object.
DELETE location none Deletes a location object.
POST location location Creates a location object.
PATCH location location Updates a location object.

Properties

Property Type Description
id GUID The unique ID of the location. Non-editable.
code string The code of the location.
displayName string Specifies the location's name. This name will appear on all sales documents for the location.
contact string
addressLine1 string Specifies the location's address. This address will appear on all sales documents for the location.
addressLine2 string Specifies the location's address. This address will appear on all sales documents for the location.
city string Specifies the location's city.
state string Specifies the location's state.
country string Specifies the location's country.
postalCode string Specifies the location's postal code.
phoneNumber string Specifies the location's telephone number.
email string Specifies the location's email address.
website string Specifies the location's home page address.
lastModifiedDateTime datetime The 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