Contact data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
first_name | string | No | |
last_name | string | No | |
emails | AccountingEmail[] | No | |
emails[].email | string | No | |
emails[].type | enum | No | Values: WORK, HOME, OTHER |
telephones | AccountingTelephone[] | No | |
telephones[].telephone | string | No | |
telephones[].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE |
currency | string | No | |
billing_address | object | No | |
billing_address.address1 | string | No | |
billing_address.address2 | string | No | |
billing_address.city | string | No | |
billing_address.region | string | No | 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. |
billing_address.region_code | string | No | 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. |
billing_address.postal_code | string | No | |
billing_address.country | string | No | |
billing_address.country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
shipping_address | object | No | |
shipping_address.address1 | string | No | |
shipping_address.address2 | string | No | |
shipping_address.city | string | No | |
shipping_address.region | string | No | 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. |
shipping_address.region_code | string | No | 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. |
shipping_address.postal_code | string | No | |
shipping_address.country | string | No | |
shipping_address.country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
is_active | boolean | No | |
tax_exemption | enum | No | Values: FEDERAL_GOV, REGION_GOV, LOCAL_GOV, TRIBAL_GOV, CHARITABLE_ORG, RELIGIOUS_ORG, EDUCATIONAL_ORG, MEDICAL_ORG, RESALE, FOREIGN, OTHER |
tax_number | string | No | 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 | No | |
is_supplier | boolean | No | |
portal_url | string | No | URL for the contact’s portal |
payment_methods | AccountingContactPaymentMethod[] | No | |
payment_methods[].id | string | No | |
payment_methods[].type | enum | Yes | Values: ACH, ALIPAY, CARD, GIROPAY, IDEAL, OTHER, PAYPAL, WIRE, CHECK |
payment_methods[].name | string | No | |
payment_methods[].default | boolean | No | |
company_name | string | No | |
identification | string | No | contact account numbers such as registration, A membership or identification reference to help to identify and search customers |
associated_contacts | AccountingAssociatedContact[] | No | |
associated_contacts[].id | string | No | |
associated_contacts[].name | string | No | |
associated_contacts[].emails | AccountingEmail[] | No | |
associated_contacts[].emails[].email | string | No | |
associated_contacts[].emails[].type | enum | No | Values: WORK, HOME, OTHER |
organization_id | string | No | |
payment_terms | enum | No | Values: ON_RECEIPT, NET_7, NET_10, NET_15, NET_20, NET_25, NET_30, NET_45, NET_60, NET_90, OTHER |
paymentterm_id | string | No | |
balance_amount | number | No | Outstanding AR/AP balance for this contact |
website | string | No | |
notes | string | No |
Are we missing anything? Let us know