typestring required
Type identifier (always 'CustomerData')
idstring uuid required
Unique identifier for the customer
external_idstring required
Your unique identifier for this customer (used for idempotency)
reference_numberstring required
Customer reference number for invoices and statements
individual_namestring required
Individual/contact person name (required if company_name not provided)
company_namestring required
Registered company name (required if individual_name not provided)
display_namestring required
Display name for the customer (auto-generated from company_name or individual_name)
emailstring email required
Primary email address for the customer
mobile_phonestring required
office_phonestring required
Office/landline phone number
address_line1string required
address_line2string required
Street address line 2 (building, suite, etc.)
state_countystring required
postal_codestring required
countrystring required
ISO 3166-1 alpha-2 country code
full_addressstring required
Complete formatted address with all fields
address_stringstring required
Single-line formatted address
vat_numberstring required
VAT registration number (for UK: GB followed by 9 digits)
tax_exemptboolean required
Whether customer is exempt from tax/VAT
statusstring required
Customer status (ACTIVE or ARCHIVED)
is_activeboolean required
Whether the customer is active (read-only)
is_archivedboolean required
Whether the customer is archived (read-only)
notesstring required
Internal notes about the customer
payment_terms_daysinteger required
Number of days for payment terms (e.g., 30 for Net 30)
credit_limitinteger required
Maximum credit limit in cents (e.g., 100000 for £1,000)
credit_limit_centsinteger required
Maximum credit limit in cents (e.g., 100000 for £1,000)
outstanding_balanceinteger required
Current outstanding balance in cents (read-only, computed)
created_atstring date-time required
Date and time when the customer was created
updated_atstring date-time required
Date and time when the customer was last updated
archived_atstring date-time required
Date and time when the customer was archived (null if active)