CustomerState
A customer entity representing a business or individual client
Fields
Unique identifier
Customer name (business or individual)
External URL for the calling integration, or the primary identity for unscoped callers.
All linked external identities, including identities belonging to other integrations.
Integration instance that originally created this record, when known.
IaC stack that originally created this record, when known.
External system reference for integration
The tenant's own account number for this customer, as shown on quotes and invoices. Unique per tenant; distinct from externalId, which identifies the record in another system.
Primary email address
Primary phone number
General notes about the customer
Whether the customer is active
Credit limit amount (nil = no limit enforced)
Currency for credit limit (ISO 4217)
Net payment terms in days (0 = prepayment, nil = not set)
Whether the customer is on credit hold
Reason for credit hold
Default tax code applied to this customer's documents
Whether the customer is tax exempt
Tax exemption reference (e.g. VAT registration number)
Creation timestamp (ISO8601)
Last update timestamp (ISO8601)
Contacts for this customer. Requires contact:list permission.
Addresses for this customer. Requires address:list permission.
Referenced by (11)
Exact type SDL
"""A customer entity representing a business or individual client"""
type CustomerState {
"""Unique identifier"""
id: CustomerID!
"""Customer name (business or individual)"""
name: String!
"""
External URL for the calling integration, or the primary identity for unscoped callers.
"""
externalUrl: String @iac_computed
"""
All linked external identities, including identities belonging to other integrations.
"""
externalIdentities: [RecordExternalIdentity!]! @iac_computed
"""Integration instance that originally created this record, when known."""
createdByIntegrationId: IntegrationInstanceID @iac_computed @iac_ref(resource: "integration_instance")
"""IaC stack that originally created this record, when known."""
createdByStackId: IaCStackID @iac_computed
"""External system reference for integration"""
externalId: String
"""
The tenant's own account number for this customer, as shown on quotes and invoices. Unique per tenant; distinct from externalId, which identifies the record in another system.
"""
customerNumber: 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!]!
}