Skip to content

CustomerState ​

Type: Object

A customer entity representing a business or individual client

Fields ​

NameTypeArgsDescriptionDeprecated
addresses[AddressState!]!Addresses for this customer. Requires address:list permission.
contacts[ContactState!]!Contacts for this customer. Requires contact:list permission.
createdAtString!Creation timestamp (ISO8601)
creditCurrencyCurrencyISOCurrency for credit limit (ISO 4217)
creditHoldReasonStringReason for credit hold
creditLimitFloatCredit limit amount (nil = no limit enforced)
defaultTaxCodeIdTaxCodeIDDefault tax code applied to this customer's documents
emailStringPrimary email address
externalIdStringExternal system reference for integration
idCustomerID!Unique identifier
isActiveBoolean!Whether the customer is active
isCreditHoldBoolean!Whether the customer is on credit hold
isTaxExemptBoolean!Whether the customer is tax exempt
nameString!Customer name (business or individual)
notesStringGeneral notes about the customer
paymentTermsDaysIntNet payment terms in days (0 = prepayment, nil = not set)
phoneStringPrimary phone number
taxExemptReferenceStringTax exemption reference (e.g. VAT registration number)
updatedAtString!Last update timestamp (ISO8601)

Connect machines, automate workflows, and build custom apps for print production.