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. |
| POST customer | customer | Creates a customer object. |
| PATCH customer | customer | Updates a customer object. |
| DELETE customer | customer | Deletes a customer object |
Navigation
| Navigation | Return Type | Description |
|---|---|---|
| countryRegion | countryRegion | Gets the countryregion of the customer. |
| 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. |
Properties
| Property | Type | Description | Max Length |
|---|---|---|---|
| 🔑 id | GUID | The unique ID of the customer. Non-editable. | |
| number | string | Specifies the number of the customer. | 20 |
| displayName | string | Specifies the customer's name. This name will appear on all sales documents for the customer. | 100 |
| 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. | 100 |
| addressLine2 | string | Specifies the customer's address. This address will appear on all sales documents for the customer. | 50 |
| city | string | Specifies the customer's city. | 30 |
| state | string | Specifies the customer's state. | 30 |
| country | string | Specifies the customer's country. | 10 |
| postalCode | string | Specifies the customer's postal code. | 20 |
| phoneNumber | string | Specifies the customer's telephone number. | 30 |
| string | Specifies the customer's email address. | 80 | |
| website | string | Specifies the customer's home page address. | 80 |
| 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. | 20 |
| 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". | |
| languageCode | string | Specifies the language code of the customer. | 10 |
| responsibilityCenter | string | Specifies the responsibility center of the customer. | 10 |
| generalBusinessPostingGroupCode | string | Specifies the general business posting group of the customer. | 20 |
| customerPostingGroup | string | Specifies the customer posting group of the customer. | 20 |
| vatBusinessPostingGroup | string | Specifies the VAT business posting group of the customer. | 20 |
| customerPriceGroup | string | Specifies the customer price group of the customer. | 10 |
| customerDiscoutGroup | string | Specifies the customer discount group of the customer. | 20 |
| allowLineDiscount | boolean | Specifies whether the customer is allowed to have a line discount. | |
| invoiceDiscountCode | string | Specifies the invoice discount group of the customer. | 20 |
| lastModifiedDateTime | datetime | The last datetime the customer was modified. Read-Only. |