Overview

A contact is an individual or company that buys or sells goods or services from a business. Commonly referred to as a customer on a corresponding invoice or a vendor for a bill.

The Contacts Data Model represents an individual or company that buys or sells goods or services from a business. This unified model simplifies handling contact-related information across various accounting platforms.

• Unified contact properties: Essential contact details like name, contact person, currency, and tax number are standardized across different accounting platforms
• Comprehensive contact information: Contacts can include associated data like contact persons, phone numbers, addresses, and external links for a more detailed representation of each contact
• Status tracking: The model supports tracking the status of each contact, with values like ACTIVE, INACTIVE, SUSPENDED, ARCHIVED, and UNKNOWN, facilitating better organisation and reporting

Attributes

Contacts Attributes

Property	Type	Description
rootfi_id	integer	Unique identifier assigned by Commenda for this contact
rootfi_created_at	string	Timestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_at	string	Timestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_integration_type	enum
platform_id	string	Unique identifier for this contact in the source accounting platform
name	string	The name of the contact
contact_name	string	The name of the contact person for the contact
email	string
phone	string
tax_number	string	The contact’s tax number
type	enum	The type of contact
status	enum	The status of the contact
currency_id	enum	The ISO-4217 currency code of the contact
registration_number	string	The contact’s identifying or registration number
website	string
created_at	string
updated_at	string	The date and time the contact was last updated

Type Enum Values

Value	Description
CUSTOMER	Contact is a customer who receives invoices
VENDOR	Contact is a vendor who provides bills
BOTH	Contact acts as both customer and vendor
UNKNOWN	Type cannot be determined from the platform

Status Enum Values

Value	Description
ACTIVE	Contact is active and in good standing
INACTIVE	Contact has been voluntarily deactivated
SUSPENDED	Contact is suspended due to payment/fraud issues
ARCHIVED	Contact has been archived for record-keeping
UNKNOWN	Status cannot be determined from the platform

Expandable Attributes

Use the expand query parameter to include related objects:

• expand=addresses — includes the related Addresses object(s).
• expand=phone_numbers — includes the related Phone Numbers object(s).
• expand=external_links — includes the related External Links object(s).

Properties Supported

Fields accepted when creating or updating a record:

Property	Type	Description
platform_id	string	Unique identifier for this contact in the source accounting platform
name	string	The name of the contact
contact_name	string	The name of the contact person for the contact
email	string
phone	string
tax_number	string	The contact’s tax number
type	enum	The type of contact
status	enum	The status of the contact
currency_id	enum	The ISO-4217 currency code of the contact
registration_number	string	The contact’s identifying or registration number
website	string
created_at	string
updated_at	string	The date and time the contact was last updated