Contact data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNo
first_namestringNo
last_namestringNo
emailsAccountingEmail[]No
emails[].emailstringNo
emails[].typeenumNoValues: WORK, HOME, OTHER
telephonesAccountingTelephone[]No
telephones[].telephonestringNo
telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
currencystringNo
billing_addressobjectNo
billing_address.address1stringNo
billing_address.address2stringNo
billing_address.citystringNo
billing_address.regionstringNoRegional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province.
billing_address.region_codestringNoShort form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province.
billing_address.postal_codestringNo
billing_address.countrystringNo
billing_address.country_codestringNoCountry code for the country, in ISO 3166 A-2 format
shipping_addressobjectNo
shipping_address.address1stringNo
shipping_address.address2stringNo
shipping_address.citystringNo
shipping_address.regionstringNoRegional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province.
shipping_address.region_codestringNoShort form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province.
shipping_address.postal_codestringNo
shipping_address.countrystringNo
shipping_address.country_codestringNoCountry code for the country, in ISO 3166 A-2 format
is_activebooleanNo
tax_exemptionenumNoValues: FEDERAL_GOV, REGION_GOV, LOCAL_GOV, TRIBAL_GOV, CHARITABLE_ORG, RELIGIOUS_ORG, EDUCATIONAL_ORG, MEDICAL_ORG, RESALE, FOREIGN, OTHER
tax_numberstringNoThe ID/number of the customer's tax number. This is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global).
is_customerbooleanNo
is_supplierbooleanNo
portal_urlstringNoURL for the contact’s portal
payment_methodsAccountingContactPaymentMethod[]No
payment_methods[].idstringNo
payment_methods[].typeenumYesValues: ACH, ALIPAY, CARD, GIROPAY, IDEAL, OTHER, PAYPAL, WIRE, CHECK
payment_methods[].namestringNo
payment_methods[].defaultbooleanNo
company_namestringNo
identificationstringNocontact account numbers such as registration, A membership or identification reference to help to identify and search customers
associated_contactsAccountingAssociatedContact[]No
associated_contacts[].idstringNo
associated_contacts[].namestringNo
associated_contacts[].emailsAccountingEmail[]No
associated_contacts[].emails[].emailstringNo
associated_contacts[].emails[].typeenumNoValues: WORK, HOME, OTHER
organization_idstringNo
payment_termsenumNoValues: ON_RECEIPT, NET_7, NET_10, NET_15, NET_20, NET_25, NET_30, NET_45, NET_60, NET_90, OTHER
paymentterm_idstringNo
balance_amountnumberNoOutstanding AR/AP balance for this contact
websitestringNo
notesstringNo

TypeScript

TypeScript
export type AccountingContact = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string;
	first_name?: string;
	last_name?: string;
	emails?: [];
	telephones?: [];
	currency?: string;
	billing_address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; // Regional area of the employee's address.  For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. 
		region_code?: string; // Short form for the regional area of the employee's address.   For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. 
		postal_code?: string; 
		country?: string; 
		country_code?: string; // Country code for the country, in ISO 3166 A-2 format 
	};
	shipping_address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; // Regional area of the employee's address.  For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. 
		region_code?: string; // Short form for the regional area of the employee's address.   For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. 
		postal_code?: string; 
		country?: string; 
		country_code?: string; // Country code for the country, in ISO 3166 A-2 format 
	};
	is_active?: boolean;
	tax_exemption?: 'FEDERAL_GOV' | 'REGION_GOV' | 'LOCAL_GOV' | 'TRIBAL_GOV' | 'CHARITABLE_ORG' | 'RELIGIOUS_ORG' | 'EDUCATIONAL_ORG' | 'MEDICAL_ORG' | 'RESALE' | 'FOREIGN' | 'OTHER';
	tax_number?: string; // The ID/number of the customer's tax number.  This is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global).
	is_customer?: boolean;
	is_supplier?: boolean;
	portal_url?: string; // URL for the contact’s portal
	payment_methods?: [];
	company_name?: string;
	identification?: string; // contact account numbers such as registration, A membership or identification reference to help to identify and search customers
	associated_contacts?: [];
	organization_id?: string;
	payment_terms?: 'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER';
	paymentterm_id?: string;
	balance_amount?: number; // Outstanding AR/AP balance for this contact
	website?: string;
	notes?: string;
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodAccountingContact = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional(),
	first_name: z.string().optional(),
	last_name: z.string().optional(),
	emails: z.array().optional(),
	telephones: z.array().optional(),
	currency: z.string().optional(),
	billing_address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional().describe("Regional area of the employee's address.  For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province."),
			region_code: z.string().optional().describe("Short form for the regional area of the employee's address.   For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province."),
			postal_code: z.string().optional(),
			country: z.string().optional(),
			country_code: z.string().optional().describe("Country code for the country, in ISO 3166 A-2 format")
}).optional(),
	shipping_address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional().describe("Regional area of the employee's address.  For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province."),
			region_code: z.string().optional().describe("Short form for the regional area of the employee's address.   For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province."),
			postal_code: z.string().optional(),
			country: z.string().optional(),
			country_code: z.string().optional().describe("Country code for the country, in ISO 3166 A-2 format")
}).optional(),
	is_active: z.boolean().optional(),
	tax_exemption: z.enum("FEDERAL_GOV", "REGION_GOV", "LOCAL_GOV", "TRIBAL_GOV", "CHARITABLE_ORG", "RELIGIOUS_ORG", "EDUCATIONAL_ORG", "MEDICAL_ORG", "RESALE", "FOREIGN", "OTHER").optional(),
	tax_number: z.string().optional().describe("The ID/number of the customer's tax number.  This is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global)."),
	is_customer: z.boolean().optional(),
	is_supplier: z.boolean().optional(),
	portal_url: z.string().optional().describe("URL for the contact’s portal"),
	payment_methods: z.array().optional(),
	company_name: z.string().optional(),
	identification: z.string().optional().describe("contact account numbers such as registration, A membership or identification reference to help to identify and search customers"),
	associated_contacts: z.array().optional(),
	organization_id: z.string().optional(),
	payment_terms: z.enum("ON_RECEIPT", "NET_7", "NET_10", "NET_15", "NET_20", "NET_25", "NET_30", "NET_45", "NET_60", "NET_90", "OTHER").optional(),
	paymentterm_id: z.string().optional(),
	balance_amount: z.number().optional().describe("Outstanding AR/AP balance for this contact"),
	website: z.string().optional(),
	notes: z.string().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AccountingContactTax_exemption(str, Enum):
	FEDERAL_GOV = 'FEDERAL_GOV'
	REGION_GOV = 'REGION_GOV'
	LOCAL_GOV = 'LOCAL_GOV'
	TRIBAL_GOV = 'TRIBAL_GOV'
	CHARITABLE_ORG = 'CHARITABLE_ORG'
	RELIGIOUS_ORG = 'RELIGIOUS_ORG'
	EDUCATIONAL_ORG = 'EDUCATIONAL_ORG'
	MEDICAL_ORG = 'MEDICAL_ORG'
	RESALE = 'RESALE'
	FOREIGN = 'FOREIGN'
	OTHER = 'OTHER'

@dataclasses.dataclass
class AccountingContactPayment_terms(str, Enum):
	ON_RECEIPT = 'ON_RECEIPT'
	NET_7 = 'NET_7'
	NET_10 = 'NET_10'
	NET_15 = 'NET_15'
	NET_20 = 'NET_20'
	NET_25 = 'NET_25'
	NET_30 = 'NET_30'
	NET_45 = 'NET_45'
	NET_60 = 'NET_60'
	NET_90 = 'NET_90'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PropertyAccountingContactBilling_address:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	"""Regional area of the employee's address.  For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province."""
	region: Optional[str]
	"""Short form for the regional area of the employee's address.   For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province."""
	region_code: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]
	"""Country code for the country, in ISO 3166 A-2 format"""
	country_code: Optional[str]

@dataclasses.dataclass
class PropertyAccountingContactShipping_address:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	"""Regional area of the employee's address.  For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province."""
	region: Optional[str]
	"""Short form for the regional area of the employee's address.   For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province."""
	region_code: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]
	"""Country code for the country, in ISO 3166 A-2 format"""
	country_code: Optional[str]

@dataclasses.dataclass
class AccountingContact:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	name: Optional[str]
	first_name: Optional[str]
	last_name: Optional[str]
	emails: Optional[PropertyAccountingContactEmails]
	telephones: Optional[PropertyAccountingContactTelephones]
	currency: Optional[str]
	billing_address: Optional[PropertyAccountingContactBilling_address]
	shipping_address: Optional[PropertyAccountingContactShipping_address]
	is_active: Optional[bool]
	tax_exemption: Optional[AccountingContactTax_exemption]
	"""The ID/number of the customer's tax number.  This is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global)."""
	tax_number: Optional[str]
	is_customer: Optional[bool]
	is_supplier: Optional[bool]
	"""URL for the contact’s portal"""
	portal_url: Optional[str]
	payment_methods: Optional[PropertyAccountingContactPayment_methods]
	company_name: Optional[str]
	"""contact account numbers such as registration, A membership or identification reference to help to identify and search customers"""
	identification: Optional[str]
	associated_contacts: Optional[PropertyAccountingContactAssociated_contacts]
	organization_id: Optional[str]
	payment_terms: Optional[AccountingContactPayment_terms]
	paymentterm_id: Optional[str]
	"""Outstanding AR/AP balance for this contact"""
	balance_amount: Optional[int]
	website: Optional[str]
	notes: Optional[str]
Are we missing anything? Let us know
Was this page helpful?