customer resource type

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 customercustomerGets a customer object.
DELETE customernoneDeletes a customer object.
POST customercustomerCreates a customer object.
PATCH customercustomerUpdates a customer object.
GET customercustomerGets a customer object.
NavigationReturn TypeDescription
currencycurrencyGets the currency of the customer.
paymentTermpaymentTermGets the paymentterm of the customer.
shipmentMethodshipmentMethodGets the shipmentmethod of the customer.
paymentMethodpaymentMethodGets the paymentmethod of the customer.
customerFinancialDetailcustomerFinancialDetailGets the customerfinancialdetail of the customer.
picturepictureGets the picture of the customer.
defaultDimensionsdefaultDimensionsGets the defaultdimensions of the customer.
agedAccountsReceivableagedAccountsReceivableGets the agedaccountsreceivable of the customer.
contactsInformationcontactsInformationGets the contactsinformation of the customer.
documentAttachmentsdocumentAttachmentsGets the documentattachments of the customer.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the customer. Non-editable.
numberstringSpecifies the number of the customer.
displayNamestringSpecifies the customer's name. This name will appear on all sales documents for the customer.
typeNAV.contactTypeSpecifies the type of customer, can be "Company" or "Person".
addressLine1stringSpecifies the customer's address. This address will appear on all sales documents for the customer.
addressLine2stringSpecifies the customer's address. This address will appear on all sales documents for the customer.
citystringSpecifies the customer's city.
statestringSpecifies the customer's state.
countrystringSpecifies the customer's country.
postalCodestringSpecifies the customer's postal code.
phoneNumberstringSpecifies the customer's telephone number.
emailstringSpecifies the customer's email address.
websitestringSpecifies the customer's home page address.
salespersonCodestring
balanceDuedecimalSpecifies total balance due.
creditLimitdecimal
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.
taxRegistrationNumberstringSpecified the tax registration number of the customer.
currencyIdGUIDSpecifies which currency the customer uses.
currencyCodestringThe default currency code for the customer.
paymentTermsIdGUIDSpecifies which payment term the customer uses.
shipmentMethodIdGUIDSpecifies which shipment method the customer uses.
paymentMethodIdGUIDSpecifies which payment method the customer uses.
blockedNAV.customerBlockedSpecifies which transactions with the customer can't be posted. It can be " ", "Ship", "Invoice" or "All".
lastModifiedDateTimedatetimeThe last datetime the customer was modified. Read-Only.

JSON representation

Here's a JSON representation of the customer resource.

{
    "id": "GUID",
    "number": "string",
    "displayName": "string",
    "type": "NAV.contactType",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string",
    "phoneNumber": "string",
    "email": "string",
    "website": "string",
    "salespersonCode": "string",
    "balanceDue": "decimal",
    "creditLimit": "decimal",
    "taxLiable": "boolean",
    "taxAreaId": "GUID",
    "taxAreaDisplayName": "string",
    "taxRegistrationNumber": "string",
    "currencyId": "GUID",
    "currencyCode": "string",
    "paymentTermsId": "GUID",
    "shipmentMethodId": "GUID",
    "paymentMethodId": "GUID",
    "blocked": "NAV.customerBlocked",
    "lastModifiedDateTime": "datetime"
}

GET customer
DELETE customer
POST customer
PATCH customer