countryRegion resource type

Represents a country/region 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 countryRegioncountryRegionGets a country/region object.
DELETE countryRegionnoneDeletes a country/region object.
POST countryRegioncountryRegionCreates a country/region object.
PATCH countryRegioncountryRegionUpdates a country/region object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the country/region. Non-editable.
codestringThe code of the country/region.
displayNamestringSpecifies the country/region's name. This name will appear on all sales documents for the country/region.
addressFormatNAV.countryRegionAddressFormatSpecifies the format of the address that is displayed on external-facing documents. You link an address format to a country/region code so that external-facing documents based on cards or documents with that country/region code use the specified address format.
lastModifiedDateTimedatetimeThe last datetime the country/region was modified. Read-Only.

JSON representation

Here's a JSON representation of the countryRegion resource.

{
    "id": "GUID",
    "code": "string",
    "displayName": "string",
    "addressFormat": "NAV.countryRegionAddressFormat",
    "lastModifiedDateTime": "datetime"
}

GET countryRegion
DELETE countryRegion
POST countryRegion
PATCH countryRegion