Moving from Beta to v1.0

With the April'19 release of Dynamics 365 Business Central, the Standard APIs were released in version 1.0.

API version numbers are mananged in the URI https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/{API VERSION}/. For example, for v1.0 of the API the URI is https://api.businesscentral.dynamics.com/v2.0/production/api/v1.0/.

Important

The beta API will remain live until April 2020. It's recommended to move to v1.0 as soon as possible. When moving from beta to v1.0, pay attention to changes related to URIs of the document APIs, and to the customer APIs where balance, overdueAmount, and totalSalesExcludingTax have moved to the customerFinancialDetails API. Other changes are additive.

Comparing Dynamics 365 Business Central beta API, to Dynamics 365 Business Central v1.0 APIs have the following changes.

Entity Changes
customer Properties balance, overdueAmount, totalSalesExcludingTax have moved to a new entity customerFinancialDetails, which has a relation to the customer entity.
customerFinancialDetails Entity added.
companyInformation bussinessProfileId has been removed.
salesInvoice, salesOrder, salesQuote Biling, shipping and selling postal addresses are added.
purchaseInvoice buyFrom, payTo and shipTp adesses added.
salesInvoiceLine, salesOrderLine, salesQuoteLine, salesCreditMemoLine, purchaseInvoiceLine Key changed from multipart key, to a single key. Type has changed from Guid to String.
salesCreditMemo Billing and selling addresses added, and properties phoneNumber and email.
journalLine Added attachment, so attachments can be added to journalLine".
timeRegistrationEntry New entity. Makes it possible to add employee time registrations.
salesQuote Properties phoneNumber and email have been added.

For a full comparison of API versions, compare the metadata of the APIs. Using OAuth, tenant ID is not needed in the URI when querying:

GET https://api.businesscentral.dynamics.com/v2.0/{environment}/api/beta/$metadata
GET https://api.businesscentral.dynamics.com/v2.0/{environment}/api/v1.0/$metadata

Using Basic Auth:

GET https://api.businesscentral.dynamics.com/v2.0/{tenant Id}/{environment}/api/v1.0/$metadata

See Also

Welcome to the API(v1.0) for Dynamics 365 Business Central
Endpoints for the APIs