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

id string
Prefixed contact ID (e.g. cont_3). Immutable after creation.
contactType string
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.
name string
Primary display name. Required. Used for search matching alongside company and email.
company string
Optional company or trading name. Searched alongside name and email in list queries.
email string
Optional email address. Validated format when provided. Used for invoice delivery.
phone string
Optional phone number. Free-text, no format validation.
addressLine1 string
First line of the postal address.
addressLine2 string
Second line of the postal address.
city string
City or town.
region string
County, region, or state.
postalCode string
Postal code or ZIP code.
country string
Country name. Defaults to United Kingdom on creation.
vatNumber string
VAT registration number. Free-text, no format validation. Used on invoices for compliance.
paymentTerms string
Default payment terms in days. Integer 0–365, defaults to 30. Applied when creating invoices for this contact.
currency string
ISO 4217 currency code. 3 characters, defaults to GBP. Determines the currency used on invoices for this contact.
bankName string
Name of the contact's bank. Optional, for payment reference.
bankSortCode string
UK sort code. Optional, for payment reference.
bankAccount string
Bank account number. Optional, for payment reference.
bankIban string
International Bank Account Number. Optional, for international payments.
isActive string
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.
notes string
Free-text notes. Up to 2,000 characters. Not visible on invoices.
metadata string
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.
createdAt string
ISO 8601 creation timestamp.
updatedAt string
ISO 8601 last-updated timestamp.