Metadata
Key | Value |
---|---|
releaseDate | 10 Apr 2025 |
keyword | Dynamics 365 Business Central API |
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.
Key | Value |
---|---|
releaseDate | 10 Apr 2025 |
keyword | Dynamics 365 Business Central API |
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/
https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies({company_id})/customers
https://api.businesscentral.dynamics.com/v2.0/Production/api/v2.0/companies({company_id})/customers
https://login.microsoftonline.com/companies({company_id})/customers
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)/customers?%24expand=customerFinancialDetails&%24filter=string&%24limit=100&%24select=id&%24skip=0&%24top=100' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "value": [ { … } ] }
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The type property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity
(v1.0) The email property for the Dynamics 365 Business Central customer entity
https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies({company_id})/customers
https://api.businesscentral.dynamics.com/v2.0/Production/api/v2.0/companies({company_id})/customers
https://login.microsoftonline.com/companies({company_id})/customers
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)/customers' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"number": "",
"displayName": "Burton K",
"type": "Person",
"addressLine1": "447 Ashcraft Circle",
"addressLine2": "",
"city": "Pawleys Island",
"state": "South Carolina",
"country": "US",
"postalCode": "29403",
"phoneNumber": "",
"email": "",
"currencycode": "USD"
}'
(v1.0) A new customer has been succesfully created
(v1.0) The id property for the Dynamics 365 Business Central customer entity
(v1.0) The number property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The type property for the Dynamics 365 Business Central customer entity
(v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity
(v1.0) The email property for the Dynamics 365 Business Central customer entity
(v1.0) The website property for the Dynamics 365 Business Central customer entity
(v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity
(v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity
(v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity
(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity
(v1.0) The currencyId property for the Dynamics 365 Business Central customer entity
(v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity
(v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity
(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity
(v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity
(v1.0) The blocked property for the Dynamics 365 Business Central customer entity
(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity
{ "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "number": null, "displayName": "", "type": null, "phoneNumber": null, "email": null, "website": null, "taxLiable": null, "taxAreaId": null, "taxAreaDisplayName": null, "taxRegistrationNumber": null, "currencyId": null, "currencyCode": null, "paymentTermsId": null, "shipmentMethodId": null, "paymentMethodId": null, "blocked": null, "lastModifiedDateTime": null, "customerFinancialDetails": [ { … } ], "picture": [ { … } ], "defaultDimensions": [ { … } ], "currency": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "BKSD94GH", "displayName": null, "symbol": null, "amountDecimalPlaces": null, "amountRoundingPrecision": null, "lastModifiedDateTime": null }, "paymentTerm": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "JKHB9XER3", "displayName": null, "dueDateCalculation": null, "discountDateCalculation": null, "discountPercent": null, "calculateDiscountOnCreditMemos": null, "lastModifiedDateTime": null }, "shipmentMethod": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "SP934M", "displayName": null, "lastModifiedDateTime": null }, "paymentMethod": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "PM-001", "displayName": null, "lastModifiedDateTime": null } }
https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies({company_id})/customers({customer_id})
https://api.businesscentral.dynamics.com/v2.0/Production/api/v2.0/companies({company_id})/customers({customer_id})
https://login.microsoftonline.com/companies({company_id})/customers({customer_id})
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)/customers(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)?%24expand=customerFinancialDetails&%24select=id' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
(v1.0) Succesfully returned the requested customer
(v1.0) The id property for the Dynamics 365 Business Central customer entity
(v1.0) The number property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The type property for the Dynamics 365 Business Central customer entity
(v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity
(v1.0) The email property for the Dynamics 365 Business Central customer entity
(v1.0) The website property for the Dynamics 365 Business Central customer entity
(v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity
(v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity
(v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity
(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity
(v1.0) The currencyId property for the Dynamics 365 Business Central customer entity
(v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity
(v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity
(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity
(v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity
(v1.0) The blocked property for the Dynamics 365 Business Central customer entity
(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity
{ "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "number": null, "displayName": "", "type": null, "phoneNumber": null, "email": null, "website": null, "taxLiable": null, "taxAreaId": null, "taxAreaDisplayName": null, "taxRegistrationNumber": null, "currencyId": null, "currencyCode": null, "paymentTermsId": null, "shipmentMethodId": null, "paymentMethodId": null, "blocked": null, "lastModifiedDateTime": null, "customerFinancialDetails": [ { … } ], "picture": [ { … } ], "defaultDimensions": [ { … } ], "currency": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "BKSD94GH", "displayName": null, "symbol": null, "amountDecimalPlaces": null, "amountRoundingPrecision": null, "lastModifiedDateTime": null }, "paymentTerm": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "JKHB9XER3", "displayName": null, "dueDateCalculation": null, "discountDateCalculation": null, "discountPercent": null, "calculateDiscountOnCreditMemos": null, "lastModifiedDateTime": null }, "shipmentMethod": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "SP934M", "displayName": null, "lastModifiedDateTime": null }, "paymentMethod": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "PM-001", "displayName": null, "lastModifiedDateTime": null } }
https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies({company_id})/customers({customer_id})
https://api.businesscentral.dynamics.com/v2.0/Production/api/v2.0/companies({company_id})/customers({customer_id})
https://login.microsoftonline.com/companies({company_id})/customers({customer_id})
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)/customers(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The type property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity
(v1.0) The email property for the Dynamics 365 Business Central customer entity
https://docs.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies({company_id})/customers({customer_id})
https://api.businesscentral.dynamics.com/v2.0/Production/api/v2.0/companies({company_id})/customers({customer_id})
https://login.microsoftonline.com/companies({company_id})/customers({customer_id})
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)/customers(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'If-Match: true' \
-d '{
"number": "",
"displayName": "Burton K",
"type": "Person",
"addressLine1": "447 Ashcraft Circle",
"addressLine2": "",
"city": "Pawleys Island",
"state": "South Carolina",
"country": "US",
"postalCode": "29403",
"phoneNumber": "",
"email": "",
"currencycode": "USD"
}'
(v1.0) Succesfully updated the specifiedcustomer
(v1.0) The id property for the Dynamics 365 Business Central customer entity
(v1.0) The number property for the Dynamics 365 Business Central customer entity
(v1.0) The displayName property for the Dynamics 365 Business Central customer entity
(v1.0) The type property for the Dynamics 365 Business Central customer entity
(v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity
(v1.0) The email property for the Dynamics 365 Business Central customer entity
(v1.0) The website property for the Dynamics 365 Business Central customer entity
(v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity
(v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity
(v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity
(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity
(v1.0) The currencyId property for the Dynamics 365 Business Central customer entity
(v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity
(v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity
(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity
(v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity
(v1.0) The blocked property for the Dynamics 365 Business Central customer entity
(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity
{ "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "number": null, "displayName": "", "type": null, "phoneNumber": null, "email": null, "website": null, "taxLiable": null, "taxAreaId": null, "taxAreaDisplayName": null, "taxRegistrationNumber": null, "currencyId": null, "currencyCode": null, "paymentTermsId": null, "shipmentMethodId": null, "paymentMethodId": null, "blocked": null, "lastModifiedDateTime": null, "customerFinancialDetails": [ { … } ], "picture": [ { … } ], "defaultDimensions": [ { … } ], "currency": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "BKSD94GH", "displayName": null, "symbol": null, "amountDecimalPlaces": null, "amountRoundingPrecision": null, "lastModifiedDateTime": null }, "paymentTerm": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "JKHB9XER3", "displayName": null, "dueDateCalculation": null, "discountDateCalculation": null, "discountPercent": null, "calculateDiscountOnCreditMemos": null, "lastModifiedDateTime": null }, "shipmentMethod": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "SP934M", "displayName": null, "lastModifiedDateTime": null }, "paymentMethod": { "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "PM-001", "displayName": null, "lastModifiedDateTime": null } }