← API reference
CANONICAL TYPE REFERENCE

UpsertCustomerInput

Input for creating or updating a customer

ID for update; omit for create

nameString!

Customer name (required)

External system reference

emailString

Primary email address

phoneString

Primary phone number

notesString

General notes

isActiveBoolean

Whether the customer is active

Credit limit amount (nil = no limit)

Currency for credit limit (ISO 4217)

Net payment terms in days (0 = prepayment)

Place customer on credit hold

Reason for credit hold

Default tax code for this customer's documents

Whether the customer is tax exempt

Tax exemption certificate or VAT number

Override creation timestamp (ISO8601). Honored only on create — passing on update is rejected.

Override update timestamp (ISO8601). Honored on create or update; defaults to now.

View exact SDL
"""Input for creating or updating a customer"""
input UpsertCustomerInput {
  """ID for update; omit for create"""
  id: CustomerID
  """Customer name (required)"""
  name: String!
  """External system reference"""
  externalId: String
  """Primary email address"""
  email: String
  """Primary phone number"""
  phone: String
  """General notes"""
  notes: String
  """Whether the customer is active"""
  isActive: Boolean
  """Credit limit amount (nil = no limit)"""
  creditLimit: Float
  """Currency for credit limit (ISO 4217)"""
  creditCurrency: CurrencyISO
  """Net payment terms in days (0 = prepayment)"""
  paymentTermsDays: Int
  """Place customer on credit hold"""
  isCreditHold: Boolean
  """Reason for credit hold"""
  creditHoldReason: String
  """Default tax code for this customer's documents"""
  defaultTaxCodeId: TaxCodeID
  """Whether the customer is tax exempt"""
  isTaxExempt: Boolean
  """Tax exemption certificate or VAT number"""
  taxExemptReference: String
  """
  Override creation timestamp (ISO8601). Honored only on create — passing on update is rejected.
  """
  createdAt: ISO8601
  """
  Override update timestamp (ISO8601). Honored on create or update; defaults to now.
  """
  updatedAt: ISO8601
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.