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

Method	Return Type	Description
GET customer	customer	Gets a customer object.
DELETE customer	none	Deletes a customer object.
POST customer	customer	Creates a customer object.
PATCH customer	customer	Updates a customer object.

Navigation

Navigation	Return Type	Description
currency	currency	Gets the currency of the customer.
paymentTerm	paymentTerm	Gets the paymentterm of the customer.
shipmentMethod	shipmentMethod	Gets the shipmentmethod of the customer.
paymentMethod	paymentMethod	Gets the paymentmethod of the customer.
customerFinancialDetail	customerFinancialDetail	Gets the customerfinancialdetail of the customer.
picture	picture	Gets the picture of the customer.
defaultDimensions	defaultDimensions	Gets the defaultdimensions of the customer.
agedAccountsReceivable	agedAccountsReceivable	Gets the agedaccountsreceivable of the customer.
contactsInformation	contactsInformation	Gets the contactsinformation of the customer.
documentAttachments	documentAttachments	Gets the documentattachments of the customer.

Properties

Property	Type	Description
id	GUID	The unique ID of the customer. Non-editable.
number	string	Specifies the number of the customer.
displayName	string	Specifies the customer's name. This name will appear on all sales documents for the customer.
type	NAV.contactType	Specifies the type of customer, can be "Company" or "Person".
addressLine1	string	Specifies the customer's address. This address will appear on all sales documents for the customer.
addressLine2	string	Specifies the customer's address. This address will appear on all sales documents for the customer.
city	string	Specifies the customer's city.
state	string	Specifies the customer's state.
country	string	Specifies the customer's country.
postalCode	string	Specifies the customer's postal code.
phoneNumber	string	Specifies the customer's telephone number.
email	string	Specifies the customer's email address.
website	string	Specifies the customer's home page address.
salespersonCode	string
balanceDue	decimal	Specifies total balance due.
creditLimit	decimal
taxLiable	boolean	Specifies if the customer or vendor is liable for sales tax. Set to true if the customer is tax liable.
taxAreaId	GUID	Specifies which tax area the customer belongs to.
taxAreaDisplayName	string	Specified the display name of the tax area the customer belongs to.
taxRegistrationNumber	string	Specified the tax registration number of the customer.
currencyId	GUID	Specifies which currency the customer uses.
currencyCode	string	The default currency code for the customer.
paymentTermsId	GUID	Specifies which payment term the customer uses.
shipmentMethodId	GUID	Specifies which shipment method the customer uses.
paymentMethodId	GUID	Specifies which payment method the customer uses.
blocked	NAV.customerBlocked	Specifies which transactions with the customer cannot be posted. It can be " ", "Ship", "Invoice" or "All".
lastModifiedDateTime	datetime	The last datetime the customer was modified. Read-Only.

JSON representation

Here is 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"
}

See Also

GET customer
DELETE customer
POST customer
PATCH customer