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
Method | Return Type | Description |
---|---|---|
GET customers | customers | Gets a customer. |
POST customers | customers | Creates a customer. |
PATCH customers | customers | Updates a customer. |
DELETE customers | none | Deletes a customer. |
Navigation
Navigation | Return Type | Description |
---|---|---|
Picture | picture | Gets the picture of customer. |
defaultDimensions | defaultDimension | Gets the defaultDimension of customer. |
customerFinancialDetail | customerFinancialDetail | Gets the customerFinancialDetails of customer. |
currency | currency | Gets the currency of customer. |
paymentTerm | paymentTerm | Gets the paymentTerm of customer. |
shipmentMethod | shipmentMethod | Gets the shipmentMethod of customer. |
paymentMethod | paymentMeth0d | Gets the paymentMethod of customer. |
Properties
Property | Type | Description |
---|---|---|
id | GUID | The unique ID of the item. Non-editable. |
number | string | The customer number. |
displayName | string | Specifies the customer's name. This name will appear on all sales documents for the customer. |
type | string | Specifies the type of customer, can be "Company" or "Person". |
address | NAV.PostalAddress | Specifies the customer's address. This address will appear on all sales documents for the customer. |
phoneNumber | string | Specifies the customer's telephone number. |
string | Specifies the customer's email address. | |
website | string | Specifies the customer's home page address. |
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, maximum size 20 | Specified the tax registration number of the customer. |
currencyId | GUID | Specifies which currency the customer uses. |
currencyCode | numeric | The default currency code for the customer. |
paymentTermsId | GUID | Specifies which payment term the customer uses. |
paymentMethodId | GUID | Specifies which payment method the customer uses. |
shipmentMethodId | GUID | Specifies which shipment method the customer uses. |
blocked | string | Specifies that transactions with the customer cannot be posted. Set to All, if the customer is blocked, set to blank if not blocked. |
lastModifiedDateTime | datetime | The 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"
}
Related information
Get Customers
Post Customers
Patch Customers
Delete Customers