Microsoft Dynamics 365 Business Central API
/
Default built by Microsoft
/
Business Central Sales Order API

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

Business Central Sales Order API

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

Operations

Returns a list of salesOrders

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

$expandArray of strings

(v1.0) Entities to expand

Items Enum"salesOrderLines""customer""currency""paymentTerm""shipmentMethod"
$selectArray of strings

(v1.0) Selected properties to be retrieved

Items Enum"id""number""externalDocumentNumber""orderDate""customerId""contactId""customerNumber""customerName""billToName""billToCustomerId"
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)/salesOrders?%24expand=salesOrderLines&%24filter=string&%24limit=100&%24select=id&%24skip=0&%24top=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

(v1.0) Succesfully returned a list of salesOrders

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

Creates an object of type salesOrder in Dynamics 365 Business Central

Request

Path
company_idstring(uuid)required

(v1.0) id for company

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

(v1.0) Entities to expand

Items Value"salesOrderLines"
Example: $expand=salesOrderLines
Headers
Content-Typestringrequired

(v1.0) application/json

Bodyapplication/jsonrequired
externalDocumentnumberstring or null<= 35 characters

(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesOrder entity

Example: "SO-00003"
orderDatestring or null

(v1.0) The orderDate property for the Dynamics 365 Business Central salesOrder entity

Example: "2025-04-04"
customernumberstring or null<= 20 characters

(v1.0) The customerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: "2609"
billToCustomernumberstring or null<= 20 characters

(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: "2609"
shipToNamestring or null<= 100 characters

(v1.0) The shipToName property for the Dynamics 365 Business Central salesOrder entity

Example: "Taitain"
shipToContactstring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Taitain"
sellToAddressLine1string or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "1039 West University Avenue"
sellToAddressLine2string or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: ""
sellToCitystring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Georgetown"
sellToCountrystring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "US"
sellToStatestring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Texas"
sellToPostCodestring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "78628"
shipToAddressLine1string or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "1039 West University Avenue"
shipToAddressLine2string or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: ""
shipToCitystring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Georgetown"
shipToCountrystring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "US"
shipToStatestring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Texas"
shipToPostCodestring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "78628"
currencycodestring or null

(v1.0) The currencyCode property for the Dynamics 365 Business Central salesOrder entity

Example: "USD"
phonenumberstring or null<= 30 characters

(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesOrder entity

Example: "+15128680200"
emailstring or null<= 80 characters

(v1.0) The email property for the Dynamics 365 Business Central salesOrder entity

Example: "[email protected]"
salesOrderLinesArray of objects(salesOrderLines)
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)/salesOrders?%24expand=salesOrderLines' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalDocumentnumber": "SO-00003",
    "orderDate": "2025-04-04",
    "customernumber": "2609",
    "billToCustomernumber": "2609",
    "shipToName": "Taitain",
    "shipToContact": "Taitain",
    "sellToAddressLine1": "1039 West University Avenue",
    "sellToAddressLine2": "",
    "sellToCity": "Georgetown",
    "sellToCountry": "US",
    "sellToState": "Texas",
    "sellToPostCode": "78628",
    "shipToAddressLine1": "1039 West University Avenue",
    "shipToAddressLine2": "",
    "shipToCity": "Georgetown",
    "shipToCountry": "US",
    "shipToState": "Texas",
    "shipToPostCode": "78628",
    "currencycode": "USD",
    "phonenumber": "+15128680200",
    "email": "[email protected]",
    "salesOrderLines": [
      {
        "lineType": "Item",
        "locationid": "2c3866a4-6008-f011-9346-000d3ac96156",
        "lineObjectNumber": "HSS002",
        "discountAmount": 0,
        "quantity": 1,
        "unitPrice": 539
      }
    ]
  }'

Responses

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

Bodyapplication/json
idstring(uuid)

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

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

(v1.0) The number property for the Dynamics 365 Business Central salesOrder entity

Example: null
externalDocumentNumberstring or null<= 35 characters

(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
orderDatestring or null

(v1.0) The orderDate property for the Dynamics 365 Business Central salesOrder entity

Example: null
customerIdstring or null(uuid)

(v1.0) The customerId property for the Dynamics 365 Business Central salesOrder entity

Example: null
contactIdstring or null<= 250 characters

(v1.0) The contactId property for the Dynamics 365 Business Central salesOrder entity

Example: null
customerNumberstring or null<= 20 characters

(v1.0) The customerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
customerNamestring or null<= 100 characters

(v1.0) The customerName property for the Dynamics 365 Business Central salesOrder entity

Example: null
billToNamestring or null<= 100 characters

(v1.0) The billToName property for the Dynamics 365 Business Central salesOrder entity

Example: null
billToCustomerIdstring or null(uuid)

(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesOrder entity

Example: null
billToCustomerNumberstring or null<= 20 characters

(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
shipToNamestring or null<= 100 characters

(v1.0) The shipToName property for the Dynamics 365 Business Central salesOrder entity

Example: null
shipToContactstring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: null
currencyIdstring or null(uuid)

(v1.0) The currencyId property for the Dynamics 365 Business Central salesOrder entity

Example: null
currencyCodestring or null

(v1.0) The currencyCode property for the Dynamics 365 Business Central salesOrder entity

Example: null
pricesIncludeTaxboolean or null

(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
paymentTermsIdstring or null(uuid)

(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesOrder entity

Example: null
shipmentMethodIdstring or null(uuid)

(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesOrder entity

Example: null
salespersonstring or null<= 20 characters

(v1.0) The salesperson property for the Dynamics 365 Business Central salesOrder entity

Example: null
partialShippingboolean or null

(v1.0) The partialShipping property for the Dynamics 365 Business Central salesOrder entity

Example: null
requestedDeliveryDatestring or null(date-time)

(v1.0) The requestedDeliveryDate property for the Dynamics 365 Business Central salesOrder entity

Example: null
discountAmountnumber or null(decimal)

(v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrder entity

Example: null
discountAppliedBeforeTaxboolean or null

(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
totalAmountExcludingTaxnumber or null(decimal)

(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
totalTaxAmountnumber or null(decimal)

(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrder entity

Example: null
totalAmountIncludingTaxnumber or null(decimal)

(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
fullyShippedboolean or null

(v1.0) The fullyShipped property for the Dynamics 365 Business Central salesOrder entity

Example: null
statusstring or null

(v1.0) The status property for the Dynamics 365 Business Central salesOrder entity

Example: null
lastModifiedDateTimestring or null(date-time)

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

Example: null
phoneNumberstring or null<= 30 characters

(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
emailstring or null<= 80 characters

(v1.0) The email property for the Dynamics 365 Business Central salesOrder entity

Example: null
salesOrderLinesArray of objects or null(salesOrderLine)
customerobject(customer)
currencyobject(currency)
paymentTermobject(paymentTerm)
shipmentMethodobject(shipmentMethod)
Response
application/json
{
  "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
  "number": null,
  "externalDocumentNumber": null,
  "orderDate": null,
  "customerId": null,
  "contactId": null,
  "customerNumber": null,
  "customerName": null,
  "billToName": null,
  "billToCustomerId": null,
  "billToCustomerNumber": null,
  "shipToName": null,
  "shipToContact": null,
  "currencyId": null,
  "currencyCode": null,
  "pricesIncludeTax": null,
  "paymentTermsId": null,
  "shipmentMethodId": null,
  "salesperson": null,
  "partialShipping": null,
  "requestedDeliveryDate": null,
  "discountAmount": null,
  "discountAppliedBeforeTax": null,
  "totalAmountExcludingTax": null,
  "totalTaxAmount": null,
  "totalAmountIncludingTax": null,
  "fullyShipped": null,
  "status": null,
  "lastModifiedDateTime": null,
  "phoneNumber": null,
  "email": null,
  "salesOrderLines": [
    { … }
  ],
  "customer": {
    "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": { … },
    "paymentTerm": { … },
    "shipmentMethod": { … },
    "paymentMethod": { … }
  },
  "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
  }
}

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

Request

Path
company_idstring(uuid)required

(v1.0) id for company

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

(v1.0) id for salesOrder

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

(v1.0) Entities to expand

Items Enum"salesOrderLines""customer""currency""paymentTerm""shipmentMethod"
$selectArray of strings

(v1.0) Selected properties to be retrieved

Items Enum"id""number""externalDocumentNumber""orderDate""customerId""contactId""customerNumber""customerName""billToName""billToCustomerId"
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)/salesOrders(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)?%24expand=salesOrderLines&%24select=id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

(v1.0) Succesfully returned the requested salesOrder

Bodyapplication/json
idstring(uuid)

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

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

(v1.0) The number property for the Dynamics 365 Business Central salesOrder entity

Example: null
externalDocumentNumberstring or null<= 35 characters

(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
orderDatestring or null

(v1.0) The orderDate property for the Dynamics 365 Business Central salesOrder entity

Example: null
customerIdstring or null(uuid)

(v1.0) The customerId property for the Dynamics 365 Business Central salesOrder entity

Example: null
contactIdstring or null<= 250 characters

(v1.0) The contactId property for the Dynamics 365 Business Central salesOrder entity

Example: null
customerNumberstring or null<= 20 characters

(v1.0) The customerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
customerNamestring or null<= 100 characters

(v1.0) The customerName property for the Dynamics 365 Business Central salesOrder entity

Example: null
billToNamestring or null<= 100 characters

(v1.0) The billToName property for the Dynamics 365 Business Central salesOrder entity

Example: null
billToCustomerIdstring or null(uuid)

(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesOrder entity

Example: null
billToCustomerNumberstring or null<= 20 characters

(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
shipToNamestring or null<= 100 characters

(v1.0) The shipToName property for the Dynamics 365 Business Central salesOrder entity

Example: null
shipToContactstring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: null
currencyIdstring or null(uuid)

(v1.0) The currencyId property for the Dynamics 365 Business Central salesOrder entity

Example: null
currencyCodestring or null

(v1.0) The currencyCode property for the Dynamics 365 Business Central salesOrder entity

Example: null
pricesIncludeTaxboolean or null

(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
paymentTermsIdstring or null(uuid)

(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesOrder entity

Example: null
shipmentMethodIdstring or null(uuid)

(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesOrder entity

Example: null
salespersonstring or null<= 20 characters

(v1.0) The salesperson property for the Dynamics 365 Business Central salesOrder entity

Example: null
partialShippingboolean or null

(v1.0) The partialShipping property for the Dynamics 365 Business Central salesOrder entity

Example: null
requestedDeliveryDatestring or null(date-time)

(v1.0) The requestedDeliveryDate property for the Dynamics 365 Business Central salesOrder entity

Example: null
discountAmountnumber or null(decimal)

(v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrder entity

Example: null
discountAppliedBeforeTaxboolean or null

(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
totalAmountExcludingTaxnumber or null(decimal)

(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
totalTaxAmountnumber or null(decimal)

(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrder entity

Example: null
totalAmountIncludingTaxnumber or null(decimal)

(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
fullyShippedboolean or null

(v1.0) The fullyShipped property for the Dynamics 365 Business Central salesOrder entity

Example: null
statusstring or null

(v1.0) The status property for the Dynamics 365 Business Central salesOrder entity

Example: null
lastModifiedDateTimestring or null(date-time)

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

Example: null
phoneNumberstring or null<= 30 characters

(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
emailstring or null<= 80 characters

(v1.0) The email property for the Dynamics 365 Business Central salesOrder entity

Example: null
salesOrderLinesArray of objects or null(salesOrderLine)
customerobject(customer)
currencyobject(currency)
paymentTermobject(paymentTerm)
shipmentMethodobject(shipmentMethod)
Response
application/json
{
  "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
  "number": null,
  "externalDocumentNumber": null,
  "orderDate": null,
  "customerId": null,
  "contactId": null,
  "customerNumber": null,
  "customerName": null,
  "billToName": null,
  "billToCustomerId": null,
  "billToCustomerNumber": null,
  "shipToName": null,
  "shipToContact": null,
  "currencyId": null,
  "currencyCode": null,
  "pricesIncludeTax": null,
  "paymentTermsId": null,
  "shipmentMethodId": null,
  "salesperson": null,
  "partialShipping": null,
  "requestedDeliveryDate": null,
  "discountAmount": null,
  "discountAppliedBeforeTax": null,
  "totalAmountExcludingTax": null,
  "totalTaxAmount": null,
  "totalAmountIncludingTax": null,
  "fullyShipped": null,
  "status": null,
  "lastModifiedDateTime": null,
  "phoneNumber": null,
  "email": null,
  "salesOrderLines": [
    { … }
  ],
  "customer": {
    "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": { … },
    "paymentTerm": { … },
    "shipmentMethod": { … },
    "paymentMethod": { … }
  },
  "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
  }
}

Deletes an object of type salesOrder in Dynamics 365 Business Central

Request

Path
company_idstring(uuid)required

(v1.0) id for company

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

(v1.0) id for salesOrder

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)/salesOrders(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

(v1.0) Succesfully deleted the specified salesOrder

Updates an object of type salesOrder in Dynamics 365 Business Central

Request

Path
company_idstring(uuid)required

(v1.0) id for company

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

(v1.0) id for salesOrder

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
externalDocumentnumberstring or null<= 35 characters

(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesOrder entity

Example: "SO-00003"
orderDatestring or null

(v1.0) The orderDate property for the Dynamics 365 Business Central salesOrder entity

Example: "2025-04-04"
customernumberstring or null<= 20 characters

(v1.0) The customerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: "2609"
billToCustomernumberstring or null<= 20 characters

(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: "2609"
shipToNamestring or null<= 100 characters

(v1.0) The shipToName property for the Dynamics 365 Business Central salesOrder entity

Example: "Taitain"
shipToContactstring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Taitain"
sellToAddressLine1string or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "1039 West University Avenue"
sellToAddressLine2string or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: ""
sellToCitystring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Georgetown"
sellToCountrystring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "US"
sellToStatestring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Texas"
sellToPostCodestring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "78628"
shipToAddressLine1string or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "1039 West University Avenue"
shipToAddressLine2string or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: ""
shipToCitystring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Georgetown"
shipToCountrystring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "US"
shipToStatestring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "Texas"
shipToPostCodestring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: "78628"
currencycodestring or null

(v1.0) The currencyCode property for the Dynamics 365 Business Central salesOrder entity

Example: "USD"
phonenumberstring or null<= 30 characters

(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesOrder entity

Example: "+15128680200"
emailstring or null<= 80 characters

(v1.0) The email property for the Dynamics 365 Business Central salesOrder entity

Example: "[email protected]"
salesOrderLinesArray of objects(salesOrderLines)
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)/salesOrders(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: true' \
  -d '{
    "externalDocumentnumber": "SO-00003",
    "orderDate": "2025-04-04",
    "customernumber": "2609",
    "billToCustomernumber": "2609",
    "shipToName": "Taitain",
    "shipToContact": "Taitain",
    "sellToAddressLine1": "1039 West University Avenue",
    "sellToAddressLine2": "",
    "sellToCity": "Georgetown",
    "sellToCountry": "US",
    "sellToState": "Texas",
    "sellToPostCode": "78628",
    "shipToAddressLine1": "1039 West University Avenue",
    "shipToAddressLine2": "",
    "shipToCity": "Georgetown",
    "shipToCountry": "US",
    "shipToState": "Texas",
    "shipToPostCode": "78628",
    "currencycode": "USD",
    "phonenumber": "+15128680200",
    "email": "[email protected]",
    "salesOrderLines": [
      {
        "lineType": "Item",
        "locationid": "2c3866a4-6008-f011-9346-000d3ac96156",
        "lineObjectNumber": "HSS002",
        "discountAmount": 0,
        "quantity": 1,
        "unitPrice": 539
      }
    ]
  }'

Responses

(v1.0) Succesfully updated the specifiedsalesOrder

Bodyapplication/json
idstring(uuid)

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

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

(v1.0) The number property for the Dynamics 365 Business Central salesOrder entity

Example: null
externalDocumentNumberstring or null<= 35 characters

(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
orderDatestring or null

(v1.0) The orderDate property for the Dynamics 365 Business Central salesOrder entity

Example: null
customerIdstring or null(uuid)

(v1.0) The customerId property for the Dynamics 365 Business Central salesOrder entity

Example: null
contactIdstring or null<= 250 characters

(v1.0) The contactId property for the Dynamics 365 Business Central salesOrder entity

Example: null
customerNumberstring or null<= 20 characters

(v1.0) The customerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
customerNamestring or null<= 100 characters

(v1.0) The customerName property for the Dynamics 365 Business Central salesOrder entity

Example: null
billToNamestring or null<= 100 characters

(v1.0) The billToName property for the Dynamics 365 Business Central salesOrder entity

Example: null
billToCustomerIdstring or null(uuid)

(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesOrder entity

Example: null
billToCustomerNumberstring or null<= 20 characters

(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
shipToNamestring or null<= 100 characters

(v1.0) The shipToName property for the Dynamics 365 Business Central salesOrder entity

Example: null
shipToContactstring or null<= 100 characters

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

Example: null
currencyIdstring or null(uuid)

(v1.0) The currencyId property for the Dynamics 365 Business Central salesOrder entity

Example: null
currencyCodestring or null

(v1.0) The currencyCode property for the Dynamics 365 Business Central salesOrder entity

Example: null
pricesIncludeTaxboolean or null

(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
paymentTermsIdstring or null(uuid)

(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesOrder entity

Example: null
shipmentMethodIdstring or null(uuid)

(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesOrder entity

Example: null
salespersonstring or null<= 20 characters

(v1.0) The salesperson property for the Dynamics 365 Business Central salesOrder entity

Example: null
partialShippingboolean or null

(v1.0) The partialShipping property for the Dynamics 365 Business Central salesOrder entity

Example: null
requestedDeliveryDatestring or null(date-time)

(v1.0) The requestedDeliveryDate property for the Dynamics 365 Business Central salesOrder entity

Example: null
discountAmountnumber or null(decimal)

(v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrder entity

Example: null
discountAppliedBeforeTaxboolean or null

(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
totalAmountExcludingTaxnumber or null(decimal)

(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
totalTaxAmountnumber or null(decimal)

(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrder entity

Example: null
totalAmountIncludingTaxnumber or null(decimal)

(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesOrder entity

Example: null
fullyShippedboolean or null

(v1.0) The fullyShipped property for the Dynamics 365 Business Central salesOrder entity

Example: null
statusstring or null

(v1.0) The status property for the Dynamics 365 Business Central salesOrder entity

Example: null
lastModifiedDateTimestring or null(date-time)

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

Example: null
phoneNumberstring or null<= 30 characters

(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesOrder entity

Example: null
emailstring or null<= 80 characters

(v1.0) The email property for the Dynamics 365 Business Central salesOrder entity

Example: null
salesOrderLinesArray of objects or null(salesOrderLine)
customerobject(customer)
currencyobject(currency)
paymentTermobject(paymentTerm)
shipmentMethodobject(shipmentMethod)
Response
application/json
{
  "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
  "number": null,
  "externalDocumentNumber": null,
  "orderDate": null,
  "customerId": null,
  "contactId": null,
  "customerNumber": null,
  "customerName": null,
  "billToName": null,
  "billToCustomerId": null,
  "billToCustomerNumber": null,
  "shipToName": null,
  "shipToContact": null,
  "currencyId": null,
  "currencyCode": null,
  "pricesIncludeTax": null,
  "paymentTermsId": null,
  "shipmentMethodId": null,
  "salesperson": null,
  "partialShipping": null,
  "requestedDeliveryDate": null,
  "discountAmount": null,
  "discountAppliedBeforeTax": null,
  "totalAmountExcludingTax": null,
  "totalTaxAmount": null,
  "totalAmountIncludingTax": null,
  "fullyShipped": null,
  "status": null,
  "lastModifiedDateTime": null,
  "phoneNumber": null,
  "email": null,
  "salesOrderLines": [
    { … }
  ],
  "customer": {
    "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": { … },
    "paymentTerm": { … },
    "shipmentMethod": { … },
    "paymentMethod": { … }
  },
  "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
  }
}

Performs the shipAndInvoice action for salesOrders entity

Request

Path
company_idstring(uuid)required

(v1.0) id for company

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

(v1.0) id for salesOrder

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
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)/salesOrders(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/Microsoft.NAV.shipAndInvoice' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

(v1.0) Succesfully performed a shipAndInvoice action on the Dynamic 365 Business Central salesOrders entity

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