Update customer defaultDimensions
Update the default dimensions of the customer in Dynamics 365 Business Central.
HTTP request
Replace the URL prefix for Dynamics 365 Business Central depending on environment following the guideline.
PATCH businesscentralPrefix/companies({companyId})/customers({customerId})/defaultDimensions({customerId},{dimensionId})
Request headers
Header | Value |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json |
Request body
In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
Note
You cannot modify parentId, dimensionId or dimensionCode fields, because these are key fields, and rename is not allowed in Default Dimension record.
Response
If successful, this method returns a 200 OK
response code and an updated default dimensions for the customer in the response body.
Example
Request
Here is an example of the request.
PATCH https://{businesscentralPrefix}/api/beta/companies({companyId})/customers({customerId})/defaultDimensions({customerId},{dimensionId})
Request body
{
"dimensionValueId":"1045a902-070a-4d31-b2b1-b9431e9e5b26",
"postingValidation":"Same Code"
}
Response
Here is an example of the response.
Note
The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
{
"@odata.context":"https://api.businesscentral.dynamics.com/v1.0/api/beta/$metadata#companies(5106c77d-af37-4e2d-bb88-45d87aba1033)/customers(b3fbe87a-61b8-4a6c-85de-0555f1627a67)/defaultDimensions",
"value":
[
{
"@odata.etag":"W/\"JzQ0OzNPaHFuS0ZQdk5oc3ZkSW9KdzVkdXk2LytjcmNqeHJJOU05SjZ1aFBYVjQ9MTswMDsn\"",
"parentId":"b3fbe87a-61b8-4a6c-85de-0555f1627a67",
"dimensionId":"d5fc81ea-8687-4e9d-9c49-7fde28ccdb1a",
"dimensionCode":"DEPARTMENT",
"dimensionValueId":"1045a902-070a-4d31-b2b1-b9431e9e5b26",
"dimensionValueCode":"PROD",
"postingValidation":"Same Code"
}
]
}
See also
Tips for working with the APIs
Graph Reference
Working with Dynamics 365 Business Central in Microsoft Graph
Enabling the APIs for Dynamics 365 Business Central
Endpoints for the APIs
Error Codes
Customers
Create customer defaultDimensions
Get customer defaultDimensions
Delete customer defaultDimensions