The Contacts object

A contact object represents a customer, supplier, or dual-role trading partner. Core identity fields (name, company, email) are complemented by a full UK postal address, banking details for payment tracking, and configurable defaults for payment terms and currency.

The isActive flag controls visibility in filtered lists. Contacts deactivated via the DELETE endpoint retain all data and relationships but default to hidden in list queries.

Attributes

idstring
Prefixed contact ID (e.g. cont_3). Immutable after creation.
contactTypestring
One of customer, supplier, or both. Determines which transaction flows the contact participates in. Contacts marked both appear in both customer and supplier filtered lists.
namestring
Primary display name. Required. Used for search matching alongside company and email.
companystring
Optional company or trading name. Searched alongside name and email in list queries.
emailstring
Optional email address. Validated format when provided. Used for invoice delivery.
phonestring
Optional phone number. Free-text, no format validation.
addressLine1string
First line of the postal address.
addressLine2string
Second line of the postal address.
citystring
City or town.
regionstring
County, region, or state.
postalCodestring
Postal code or ZIP code.
countrystring
Country name. Defaults to United Kingdom on creation.
vatNumberstring
VAT registration number. Free-text, no format validation. Used on invoices for compliance.
paymentTermsstring
Default payment terms in days. Integer 0–365, defaults to 30. Applied when creating invoices for this contact.
currencystring
ISO 4217 currency code. 3 characters, defaults to GBP. Determines the currency used on invoices for this contact.
bankNamestring
Name of the contact's bank. Optional, for payment reference.
bankSortCodestring
UK sort code. Optional, for payment reference.
bankAccountstring
Bank account number. Optional, for payment reference.
bankIbanstring
International Bank Account Number. Optional, for international payments.
isActivestring
Whether the contact is active. Inactive contacts are hidden from default list queries but retained for audit. Set to false automatically when a contact with invoices is deleted.
notesstring
Free-text notes. Up to 2,000 characters. Not visible on invoices.
metadatastring
Custom key-value pairs. Max 50 keys, values must be strings. Keys prefixed _sb_ are reserved. Uses merge semantics on update; send null to remove a key.
createdAtstring
ISO 8601 creation timestamp.
updatedAtstring
ISO 8601 last-updated timestamp.