customer resource type (Beta)

Important

The finance reports API is announced as deprecated starting with Business Central 2026 release wave 2 and will be removed in Business Central 2027 release wave 1. We recommend that you transition to the Analytics API instead. Learn more in Analytics API overview.

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.

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	string
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.
salespersonCode	string
balanceDue	decimal	Specifies total balance due.
creditLimit	decimal
currencyCode	string	The default currency code for the customer.
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.

JSON representation

Here is a JSON representation of the customer resource.

{
    "id": "GUID",
    "number": "string",
    "displayName": "string",
    "type": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string",
    "salespersonCode": "string",
    "balanceDue": "decimal",
    "creditLimit": "decimal",
    "currencyCode": "string",
    "blocked": "string",
    "lastModifiedDateTime": "datetime"
}

Related information

GET customer