Customer

Represents a customer entity in Dynamics 365 Business Central. Customers are the parties to whom the company sells goods or services. Each customer record contains contact information, financial settings, and trading terms.

Business ManagementDynamics NAVERPFinanceInventoryMicrosoftNavision

Properties

Name Type Description
@odata.etag string ETag for optimistic concurrency control
id string The unique identifier (GUID) of the customer record
number string The customer number, a unique business identifier assigned automatically or manually
displayName string The display name of the customer (individual or company name)
type string Specifies whether the customer is an individual person or a company
addressLine1 string The first line of the customer's street address
addressLine2 string The second line of the customer's street address
city string The city of the customer's address
state string The state or province code of the customer's address
country string The country/region code of the customer's address
postalCode string The postal or ZIP code of the customer's address
phoneNumber string The customer's primary phone number
email string The customer's email address
website string The customer's website URL
salespersonCode string The code of the salesperson assigned to this customer
balanceDue number The total balance due from the customer (read-only, computed)
creditLimit number The maximum credit amount allowed for the customer
taxLiable boolean Indicates whether the customer is liable for sales tax
taxAreaId string The unique identifier of the tax area assigned to the customer
taxAreaDisplayName string The display name of the tax area (read-only)
taxRegistrationNumber string The customer's tax registration number (VAT number or similar)
currencyId string The unique identifier of the currency used for this customer
currencyCode string The currency code (e.g., USD, EUR) used for transactions with this customer
paymentTermsId string The unique identifier of the payment terms assigned to the customer
shipmentMethodId string The unique identifier of the shipment method
paymentMethodId string The unique identifier of the payment method
blocked string Specifies which transactions are blocked for the customer: blank (none), Ship, Invoice, or All
lastModifiedDateTime string The date and time the customer record was last modified (read-only)
View JSON Schema on GitHub

JSON Schema

customer.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://example.com/schemas/navision/customer.json",
  "title": "Customer",
  "description": "Represents a customer entity in Dynamics 365 Business Central. Customers are the parties to whom the company sells goods or services. Each customer record contains contact information, financial settings, and trading terms.",
  "type": "object",
  "properties": {
    "@odata.etag": {
      "type": "string",
      "description": "ETag for optimistic concurrency control"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier (GUID) of the customer record"
    },
    "number": {
      "type": "string",
      "maxLength": 20,
      "description": "The customer number, a unique business identifier assigned automatically or manually"
    },
    "displayName": {
      "type": "string",
      "maxLength": 100,
      "description": "The display name of the customer (individual or company name)"
    },
    "type": {
      "type": "string",
      "enum": ["Person", "Company"],
      "description": "Specifies whether the customer is an individual person or a company"
    },
    "addressLine1": {
      "type": "string",
      "maxLength": 100,
      "description": "The first line of the customer's street address"
    },
    "addressLine2": {
      "type": "string",
      "maxLength": 50,
      "description": "The second line of the customer's street address"
    },
    "city": {
      "type": "string",
      "maxLength": 30,
      "description": "The city of the customer's address"
    },
    "state": {
      "type": "string",
      "maxLength": 20,
      "description": "The state or province code of the customer's address"
    },
    "country": {
      "type": "string",
      "maxLength": 10,
      "description": "The country/region code of the customer's address"
    },
    "postalCode": {
      "type": "string",
      "maxLength": 20,
      "description": "The postal or ZIP code of the customer's address"
    },
    "phoneNumber": {
      "type": "string",
      "maxLength": 30,
      "description": "The customer's primary phone number"
    },
    "email": {
      "type": "string",
      "maxLength": 80,
      "format": "email",
      "description": "The customer's email address"
    },
    "website": {
      "type": "string",
      "maxLength": 80,
      "format": "uri",
      "description": "The customer's website URL"
    },
    "salespersonCode": {
      "type": "string",
      "maxLength": 20,
      "description": "The code of the salesperson assigned to this customer"
    },
    "balanceDue": {
      "type": "number",
      "description": "The total balance due from the customer (read-only, computed)",
      "readOnly": true
    },
    "creditLimit": {
      "type": "number",
      "description": "The maximum credit amount allowed for the customer"
    },
    "taxLiable": {
      "type": "boolean",
      "description": "Indicates whether the customer is liable for sales tax"
    },
    "taxAreaId": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the tax area assigned to the customer"
    },
    "taxAreaDisplayName": {
      "type": "string",
      "description": "The display name of the tax area (read-only)",
      "readOnly": true
    },
    "taxRegistrationNumber": {
      "type": "string",
      "maxLength": 20,
      "description": "The customer's tax registration number (VAT number or similar)"
    },
    "currencyId": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the currency used for this customer"
    },
    "currencyCode": {
      "type": "string",
      "maxLength": 10,
      "description": "The currency code (e.g., USD, EUR) used for transactions with this customer"
    },
    "paymentTermsId": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the payment terms assigned to the customer"
    },
    "shipmentMethodId": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the shipment method"
    },
    "paymentMethodId": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the payment method"
    },
    "blocked": {
      "type": "string",
      "enum": [" ", "Ship", "Invoice", "All"],
      "description": "Specifies which transactions are blocked for the customer: blank (none), Ship, Invoice, or All"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the customer record was last modified (read-only)",
      "readOnly": true
    }
  },
  "required": ["id", "displayName"],
  "additionalProperties": false
}