CustomerState
A customer entity representing a business or individual client
Unique identifier
nameString!Customer name (business or individual)
externalIdStringExternal system reference for integration
emailStringPrimary email address
phoneStringPrimary phone number
notesStringGeneral notes about the customer
isActiveBoolean!Whether the customer is active
creditLimitFloatCredit limit amount (nil = no limit enforced)
Currency for credit limit (ISO 4217)
Net payment terms in days (0 = prepayment, nil = not set)
isCreditHoldBoolean!Whether the customer is on credit hold
creditHoldReasonStringReason for credit hold
Default tax code applied to this customer's documents
isTaxExemptBoolean!Whether the customer is tax exempt
taxExemptReferenceStringTax exemption reference (e.g. VAT registration number)
createdAtString!Creation timestamp (ISO8601)
updatedAtString!Last update timestamp (ISO8601)
Contacts for this customer. Requires contact:list permission.
Addresses for this customer. Requires address:list permission.
View exact SDL
"""A customer entity representing a business or individual client"""
type CustomerState {
"""Unique identifier"""
id: CustomerID!
"""Customer name (business or individual)"""
name: String!
"""External system reference for integration"""
externalId: String
"""Primary email address"""
email: String
"""Primary phone number"""
phone: String
"""General notes about the customer"""
notes: String
"""Whether the customer is active"""
isActive: Boolean!
"""Credit limit amount (nil = no limit enforced)"""
creditLimit: Float
"""Currency for credit limit (ISO 4217)"""
creditCurrency: CurrencyISO
"""Net payment terms in days (0 = prepayment, nil = not set)"""
paymentTermsDays: Int
"""Whether the customer is on credit hold"""
isCreditHold: Boolean!
"""Reason for credit hold"""
creditHoldReason: String
"""Default tax code applied to this customer's documents"""
defaultTaxCodeId: TaxCodeID
"""Whether the customer is tax exempt"""
isTaxExempt: Boolean!
"""Tax exemption reference (e.g. VAT registration number)"""
taxExemptReference: String
"""Creation timestamp (ISO8601)"""
createdAt: String!
"""Last update timestamp (ISO8601)"""
updatedAt: String!
"""Contacts for this customer. Requires contact:list permission."""
contacts: [ContactState!]!
"""Addresses for this customer. Requires address:list permission."""
addresses: [AddressState!]!
}One stable address across all schema views. Follow a field’s type to explore connections between domains.