Update customers

Update the properties of a customer object for Dynamics 365 Business Central.

HTTP request

PATCH /businesscentral/companies({id})/customers({id})

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json.
If-Match Required. When this request header is included and the eTag provided does not match the current tag on the customers, the customers will not be updated.

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.


If successful, this method returns a 200 OK response code and an updated customers object in the response body.



Here is an example of the request.

PATCH https://api.businesscentral.dynamics.com/v1.0/api/beta/companies({id})/customers({id})
Content-type: application/json

  "displayName": "Coho Winery Inc.",
  "phoneNumber": "(555) 555-1234"


Here is an example of the response.


The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json

  "id": "id-value",
  "number": "10000",
  "displayName": "Coho Winery Inc.",
  "type": "Company",
  "address": {
    "street": "192 Market Square",
    "city": "Atlanta",
    "state": "GA",
    "countryLetterCode": "US",
    "postalCode": "31772"
  "phoneNumber": "(555) 555-1234"
  "email": "jim.glynn@cronuscorp.net",
  "website": "",
  "taxLiable": true,
  "taxAreaId": "taxAreaId-value",
  "taxAreaDisplayName": "tax area",
  "taxRegistrationNumber": "28012001T",
  "currencyId": "currencyId-value",
  "currencyCode": "USD",
  "paymentTermsId": "3bb5b4b6-ea4c-43ca-ba1c-3b69e29a6668",
  "shipmentMethodId": "shipmentMethodId-value",
  "shipmentMethod": null,
  "paymentMethodId": "paymentMethod-value",
  "paymentMethod": {
    "code": "BANK",
    "description": "Bank Transfer"
  "blocked": " ",
  "balance": 0,
  "overdueAmount": 0
  "totalSalesExcludingTax": 0,
  "lastModifiedDateTime": "2017-03-07T00:35:28.983Z"

See also

Working with Dynamics 365 Business Central in Microsoft Graph
Enabling the APIs for Microsoft Dynamics NAV
Endpoints for the APIs
Error Codes
Get Customers
Post Customers
Delete Customers