customers resource type (v1.0)

NEW VERSION This is v1.0 of the Business Central API. For the newest version, see Business Central API (V2.0).

Represents a customer in Business Central.

Note


For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET customerscustomersGets a customer.
POST customerscustomersCreates a customer.
PATCH customerscustomersUpdates a customer.
DELETE customersnoneDeletes a customer.
NavigationReturn TypeDescription
PicturepictureGets the picture of customer.
defaultDimensionsdefaultDimensionGets the defaultDimension of customer.
customerFinancialDetailcustomerFinancialDetailGets the customerFinancialDetails of customer.
currencycurrencyGets the currency of customer.
paymentTermpaymentTermGets the paymentTerm of customer.
shipmentMethodshipmentMethodGets the shipmentMethod of customer.
paymentMethodpaymentMeth0dGets the paymentMethod of customer.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the item. Non-editable.
numberstringThe customer number.
displayNamestringSpecifies the customer's name. This name will appear on all sales documents for the customer.
typestringSpecifies the type of customer, can be "Company" or "Person".
addressNAV.PostalAddressSpecifies the customer's address. This address will appear on all sales documents for the customer.
phoneNumberstringSpecifies the customer's telephone number.
emailstringSpecifies the customer's email address.
websitestringSpecifies the customer's home page address.
taxLiablebooleanSpecifies if the customer or vendor is liable for sales tax. Set to true if the customer is tax liable.
taxAreaIdGUIDSpecifies which tax area the customer belongs to.
taxAreaDisplayNamestringSpecified the display name of the tax area the customer belongs to.
taxRegistrationNumberstring, maximum size 20Specified the tax registration number of the customer.
currencyIdGUIDSpecifies which currency the customer uses.
currencyCodenumericThe default currency code for the customer.
paymentTermsIdGUIDSpecifies which payment term the customer uses.
paymentMethodIdGUIDSpecifies which payment method the customer uses.
shipmentMethodIdGUIDSpecifies which shipment method the customer uses.
blockedstringSpecifies that transactions with the customer cannot be posted. Set to All, if the customer is blocked, set to blank if not blocked.
lastModifiedDateTimedatetimeThe last datetime the customer was modified. Read-Only.

Relationships

A Currency(currencyCode) must exist in the Currencies table.

A Payment Term(paymentTerms) must exist in the Payment Terms table.

A Shipment Method(shipmentMethod) must exist in the Shipment Method table.

A Payment Method(paymentMethod) must exist in the Payment Method table.

A Tax Area(taxArea) must exist in the Tax Area table.

Financial details of the customer (customerFinancialDetails) can be retrieved.

JSON representation

Here is a JSON representation of the resource.

{
    "id": "GUID",
    "number": "string",
    "displayName": "string",
    "type": "string",
    "address": NAV.PostalAddress,
    "phoneNumber": "string",
    "email": "string",
    "website": "string",
    "taxLiable": "boolean",
    "taxAreaId": "GUID",
    "taxAreaDisplayName": "string",
    "taxRegistrationNumber": "string",
    "currencyCode": "string",
    "paymentTermsId": "GUID",
    "shipmentMethod": NAV.ShipmentMethod,
    "paymentMethod":  NAV.PaymentMethod,
    "blocked": "string",
    "balance": "decimal",
    "overdueAmount": "numeric",
    "totalSalesExcludingTax": "numeric",
    "lastModifiedDateTime": "datetime"
}

Get Customers
Post Customers
Patch Customers
Delete Customers