Edit

Share via

countriesRegions resource type (v1.0)

  • Article

NEW VERSION This is v1.0 of the Business Central API. For the newest version, see Business Central API (V2.0).

Represents a countriesRegions object in Business Central, which is part of an address.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

Method Return Type Description
GET countriesRegions countriesRegions Get a Countries/Regions.
POST countriesRegions countriesRegions Create a Countries/Regions.
PATCH countriesRegions countriesRegions Update a Countries/Regions.
DELETE countriesRegions none Delete a Countries/Regions.

Properties

Property Type Description
id GUID The unique ID of the country/region. Non-editable.
code string Specifies the code of the country/region.
displayName string Specifies the display name of the country/region.
addressFormat string Specifies 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.
lastModifiedDateTime datetime The last datetime the country/region was modified. Read-Only.

Relationships

None

JSON representation

Here is a JSON representation of the countriesRegions.

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

Get Countries Regions
Post Countries Regions
Patch Countries Regions
Delete Countries Regions