Microsoft Dynamics 365 Business Central API
/
Default built by Microsoft
/
Business Central Country Region API
/
Retrieve the properties and relationships of an object of type countryRegion for Dynamics 365 Business Central.

Dynamics 365 Business Central API (1.0)

Dynamics 365 Business Central is a comprehensive business management solution developed by Microsoft. It is designed for small to medium-sized businesses to streamline operations across finance, sales, service, and supply chain. With powerful capabilities and cloud-based flexibility, it helps businesses make informed decisions and drive growth efficiently.

This is a complete REST API documentation for integrating with Dynamics 365 Business Central. It includes standard endpoints provided by Microsoft for managing business data and operations.

Metadata

KeyValue
releaseDate10 Apr 2025
keywordDynamics 365 Business Central API
Download OpenAPI description
default-built-by-microsoft.json
default-built-by-microsoft.yaml
Languages
Servers
Mock server

https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/

https://api.businesscentral.dynamics.com/v2.0/Production/api/v2.0/

https://login.microsoftonline.com/

Business Central Get Access Token API

To obtain an access token, you cannot directly call it through a web UI. Instead, use Postman to make the request. Below is a sample request that you can follow to retrieve your access token:

Operations

Business Central Entity API

(v1.0) Represents all Entities in Dynamics 365 Business Central

Operations

Business Central Company API

(v1.0) Represents an object of type company in Dynamics 365 Business Central

Operations

Business Central Item API

(v1.0) Represents an object of type item in Dynamics 365 Business Central

Operations

Business Central Picture API

(v1.0) Represents an object of type picture in Dynamics 365 Business Central

Operations

Business Central Default Dimensions API

(v1.0) Represents an object of type defaultDimensions in Dynamics 365 Business Central

Operations

Business Central Customer API

(v1.0) Represents an object of type customer in Dynamics 365 Business Central

Operations

Business Central Customer Financial Detail API

(v1.0) Represents an object of type customerFinancialDetail in Dynamics 365 Business Central

Operations

Business Central Vendor API

(v1.0) Represents an object of type vendor in Dynamics 365 Business Central

Operations

Business Central Company Information API

(v1.0) Represents an object of type companyInformation in Dynamics 365 Business Central

Operations

Business Central Sales Invoice API

(v1.0) Represents an object of type salesInvoice in Dynamics 365 Business Central

Operations

Business Central Sales Invoice Line API

(v1.0) Represents an object of type salesInvoiceLine in Dynamics 365 Business Central

Business Central PDF Document API

(v1.0) Represents an object of type pdfDocument in Dynamics 365 Business Central

Operations

Business Central Customer Payment Journal API

(v1.0) Represents an object of type customerPaymentJournal in Dynamics 365 Business Central

Business Central Customer Payment API

(v1.0) Represents an object of type customerPayment in Dynamics 365 Business Central

Business Central Account API

(v1.0) Represents an object of type account in Dynamics 365 Business Central

Operations

Business Central Tax Group API

(v1.0) Represents an object of type taxGroup in Dynamics 365 Business Central

Operations

Business Central Journal API

(v1.0) Represents an object of type journal in Dynamics 365 Business Central

Operations

Business Central Journal Line API

(v1.0) Represents an object of type journalLine in Dynamics 365 Business Central

Business Central Attachments API

(v1.0) Represents an object of type attachments in Dynamics 365 Business Central

Operations

Business Central Employee API

(v1.0) Represents an object of type employee in Dynamics 365 Business Central

Operations

Business Central Time Registration Entry API

(v1.0) Represents an object of type timeRegistrationEntry in Dynamics 365 Business Central

Business Central General Ledger Entry API

(v1.0) Represents an object of type generalLedgerEntry in Dynamics 365 Business Central

Operations

Business Central Currency API

(v1.0) Represents an object of type currency in Dynamics 365 Business Central

Operations

Business Central Payment Method API

(v1.0) Represents an object of type paymentMethod in Dynamics 365 Business Central

Operations

Business Central Dimension API

(v1.0) Represents an object of type dimension in Dynamics 365 Business Central

Operations

Business Central Dimension Value API

(v1.0) Represents an object of type dimensionValue in Dynamics 365 Business Central

Operations

Business Central Dimension Line API

(v1.0) Represents an object of type dimensionLine in Dynamics 365 Business Central

Operations

Business Central Payment Term API

(v1.0) Represents an object of type paymentTerm in Dynamics 365 Business Central

Operations

Business Central Shipment Method API

(v1.0) Represents an object of type shipmentMethod in Dynamics 365 Business Central

Operations

Business Central Item Category API

(v1.0) Represents an object of type itemCategory in Dynamics 365 Business Central

Operations

Business Central Cash Flow Statement API

(v1.0) Represents an object of type cashFlowStatement in Dynamics 365 Business Central

Operations

Business Central Country Region API

(v1.0) Represents an object of type countryRegion in Dynamics 365 Business Central

Operations

Returns a list of countriesRegions

Request

Path
company_idstring(uuid)required

(v1.0) id for company

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
Query
$topinteger

(v1.0) Number of items to return from the top of the list

Example: $top=100
$skipinteger

(v1.0) Number of items to skip from the list

Example: $skip=0
$limitinteger

(v1.0) Number of items to return from the list

Example: $limit=100
$filterstring

(v1.0) Filtering expression

$selectArray of strings

(v1.0) Selected properties to be retrieved

Items Enum"id""code""displayName""addressFormat""lastModifiedDateTime"
curl -i -X GET \
  'https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/countriesRegions?%24filter=string&%24limit=100&%24select=id&%24skip=0&%24top=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

(v1.0) Succesfully returned a list of countriesRegions

Bodyapplication/json
valueArray of objects(countryRegion)
Response
application/json
{
  "value": [
    { … }
  ]
}

Creates an object of type countryRegion in Dynamics 365 Business Central

Request

Path
company_idstring(uuid)required

(v1.0) id for company

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
Headers
Content-Typestringrequired

(v1.0) application/json

Bodyapplication/jsonrequired
idstring or null(uuid)

(v1.0) The id property for the Dynamics 365 Business Central countryRegion entity

Example: "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4"
codestring or null<= 10 characters

(v1.0) The code property for the Dynamics 365 Business Central countryRegion entity

Example: ""
displayNamestring or null<= 50 characters

(v1.0) The displayName property for the Dynamics 365 Business Central countryRegion entity

Example: null
addressFormatstring or null

(v1.0) The addressFormat property for the Dynamics 365 Business Central countryRegion entity

Example: null
lastModifiedDateTimestring or null(date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central countryRegion entity

Example: null
curl -i -X POST \
  'https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/countriesRegions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
    "code": "",
    "displayName": null,
    "addressFormat": null,
    "lastModifiedDateTime": null
  }'

Responses

(v1.0) A new countryRegion has been succesfully created

Bodyapplication/json
idstring(uuid)

(v1.0) The id property for the Dynamics 365 Business Central countryRegion entity

Example: "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4"
codestring<= 10 characters

(v1.0) The code property for the Dynamics 365 Business Central countryRegion entity

Example: "JIBIHDF"
displayNamestring or null<= 50 characters

(v1.0) The displayName property for the Dynamics 365 Business Central countryRegion entity

Example: null
addressFormatstring or null

(v1.0) The addressFormat property for the Dynamics 365 Business Central countryRegion entity

Example: null
lastModifiedDateTimestring or null(date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central countryRegion entity

Example: null
Response
application/json
{
  "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
  "code": "JIBIHDF",
  "displayName": null,
  "addressFormat": null,
  "lastModifiedDateTime": null
}

Retrieve the properties and relationships of an object of type countryRegion for Dynamics 365 Business Central.

Request

Path
company_idstring(uuid)required

(v1.0) id for company

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
countryRegion_idstring(uuid)required

(v1.0) id for countryRegion

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
Query
$selectArray of strings

(v1.0) Selected properties to be retrieved

Items Enum"id""code""displayName""addressFormat""lastModifiedDateTime"
curl -i -X GET \
  'https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/countriesRegions(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)?%24select=id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

(v1.0) Succesfully returned the requested countryRegion

Bodyapplication/json
idstring(uuid)

(v1.0) The id property for the Dynamics 365 Business Central countryRegion entity

Example: "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4"
codestring<= 10 characters

(v1.0) The code property for the Dynamics 365 Business Central countryRegion entity

Example: "JIBIHDF"
displayNamestring or null<= 50 characters

(v1.0) The displayName property for the Dynamics 365 Business Central countryRegion entity

Example: null
addressFormatstring or null

(v1.0) The addressFormat property for the Dynamics 365 Business Central countryRegion entity

Example: null
lastModifiedDateTimestring or null(date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central countryRegion entity

Example: null
Response
application/json
{
  "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
  "code": "JIBIHDF",
  "displayName": null,
  "addressFormat": null,
  "lastModifiedDateTime": null
}

Deletes an object of type countryRegion in Dynamics 365 Business Central

Request

Path
company_idstring(uuid)required

(v1.0) id for company

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
countryRegion_idstring(uuid)required

(v1.0) id for countryRegion

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
curl -i -X DELETE \
  'https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/countriesRegions(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

(v1.0) Succesfully deleted the specified countryRegion

Updates an object of type countryRegion in Dynamics 365 Business Central

Request

Path
company_idstring(uuid)required

(v1.0) id for company

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
countryRegion_idstring(uuid)required

(v1.0) id for countryRegion

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
Headers
Content-Typestringrequired

(v1.0) application/json

If-Matchstringrequired

(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Example: true
Bodyapplication/jsonrequired
idstring or null(uuid)

(v1.0) The id property for the Dynamics 365 Business Central countryRegion entity

Example: "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4"
codestring or null<= 10 characters

(v1.0) The code property for the Dynamics 365 Business Central countryRegion entity

Example: ""
displayNamestring or null<= 50 characters

(v1.0) The displayName property for the Dynamics 365 Business Central countryRegion entity

Example: null
addressFormatstring or null

(v1.0) The addressFormat property for the Dynamics 365 Business Central countryRegion entity

Example: null
lastModifiedDateTimestring or null(date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central countryRegion entity

Example: null
curl -i -X PATCH \
  'https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/countriesRegions(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: true' \
  -d '{
    "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
    "code": "",
    "displayName": null,
    "addressFormat": null,
    "lastModifiedDateTime": null
  }'

Responses

(v1.0) Succesfully updated the specifiedcountryRegion

Bodyapplication/json
idstring(uuid)

(v1.0) The id property for the Dynamics 365 Business Central countryRegion entity

Example: "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4"
codestring<= 10 characters

(v1.0) The code property for the Dynamics 365 Business Central countryRegion entity

Example: "JIBIHDF"
displayNamestring or null<= 50 characters

(v1.0) The displayName property for the Dynamics 365 Business Central countryRegion entity

Example: null
addressFormatstring or null

(v1.0) The addressFormat property for the Dynamics 365 Business Central countryRegion entity

Example: null
lastModifiedDateTimestring or null(date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central countryRegion entity

Example: null
Response
application/json
{
  "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
  "code": "JIBIHDF",
  "displayName": null,
  "addressFormat": null,
  "lastModifiedDateTime": null
}

Business Central Sales Order API

(v1.0) Represents an object of type salesOrder in Dynamics 365 Business Central

Operations

Business Central Sales Order Line API

(v1.0) Represents an object of type salesOrderLine in Dynamics 365 Business Central

Business Central Retained Earnings Statement API

(v1.0) Represents an object of type retainedEarningsStatement in Dynamics 365 Business Central

Operations

Business Central Unit Of Measure API

(v1.0) Represents an object of type unitOfMeasure in Dynamics 365 Business Central

Operations

Business Central Aged Accounts Receivable API

(v1.0) Represents an object of type agedAccountsReceivable in Dynamics 365 Business Central

Operations

Business Central Aged Accounts Payable API

(v1.0) Represents an object of type agedAccountsPayable in Dynamics 365 Business Central

Operations

Business Central Balance Sheet API

(v1.0) Represents an object of type balanceSheet in Dynamics 365 Business Central

Operations

Business Central Trial Balance API

(v1.0) Represents an object of type trialBalance in Dynamics 365 Business Central

Operations

Business Central Income Statement API

(v1.0) Represents an object of type incomeStatement in Dynamics 365 Business Central

Operations

Business Central Tax Area API

(v1.0) Represents an object of type taxArea in Dynamics 365 Business Central

Operations

Business Central Sales Quote API

(v1.0) Represents an object of type salesQuote in Dynamics 365 Business Central

Operations

Business Central Sales Quote Line API

(v1.0) Represents an object of type salesQuoteLine in Dynamics 365 Business Central

Business Central Sales Credit Memo API

(v1.0) Represents an object of type salesCreditMemo in Dynamics 365 Business Central

Operations

Business Central Sales Credit Memo Line API

(v1.0) Represents an object of type salesCreditMemoLine in Dynamics 365 Business Central

Business Central General Ledger Entry Attachments API

(v1.0) Represents an object of type generalLedgerEntryAttachments in Dynamics 365 Business Central

Operations

Business Central Purchase Invoice API

(v1.0) Represents an object of type purchaseInvoice in Dynamics 365 Business Central

Operations

Business Central Purchase Invoice Line API

(v1.0) Represents an object of type purchaseInvoiceLine in Dynamics 365 Business Central

Business Central Project API

(v1.0) Represents an object of type project in Dynamics 365 Business Central

Operations

Business Central Bank Account API

(v1.0) Represents an object of type bankAccount in Dynamics 365 Business Central

Operations

Business Central Customer Sale API

(v1.0) Represents an object of type customerSale in Dynamics 365 Business Central

Operations

Business Central Vendor Purchase API

(v1.0) Represents an object of type vendorPurchase in Dynamics 365 Business Central

Operations