Contacts
Overview
A contact is an individual or company that buys or sells goods or services from a business. Commonly referred to a customer on a corresponding invoice or a vendor for a bill
The Contacts Data Model simplifies the handling and retrieval of contact-related information across various accounting platforms.
- Unified contact properties: The model unifies essential contact details, such as name, contact person, currency, and tax number, enabling easier access and management of contact data from different 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,ARCHIVED, andUNKNOWN, facilitating better organisation and reporting.
Properties Supported
| Property | Type | Description |
|---|---|---|
| platform_id | string | The Platform’s ID for the contact |
| name | string | Name of the customer on the accounting platform |
| contact_name | string | Name of the primary contact person for the contact |
| contact_type | enum | The type of customer. Value are: CUSTOMER, VENDOR |
| currency | string | The ISO-4217 currency code |
| tax_number | string | Contact’s tax number |
| registration_number | string | Contact’s identifying number |
| status | enum | The status of the customer. Values are: ACTIVE, ARCHIVED, UNKNOWN |
| bank_account | object | Bank Account associated with this contact |
| updated_at | date | The date at which the information was updated on the accounting platform |
Expandable Attributes
You can expand the following attributes to get the related data
| Property | Data Model | Description |
|---|---|---|
| currency | Currencies | The default currency for this contact |
| phone_numbers | Phone Numbers | The phone numbers associated with this contact |
| addresses | Addresses | The addresses associated with this contact |
| external_links | External Links | The external links associated with this contact |
| contact_persons | Contact Persons | The contact persons associated with this contact |
| invoices | Invoices | The invoices that belong to this contact |
| bills | Bills | The bills that belong to this contact |
| purchase_orders | Purchase Orders | The purchase orders that belong to this contact |
| bank_transactions | Bank Transactions | The bank transactions that belong to this contact |
| sales_orders | Sales Orders | The sales orders that belong to this contact |
| invoice_payments | Invoice Payments | The invoice payments that belong to this contact |
| bill_payments | Bill Payments | The bill payments that belong to this contact |
| expenses | Expenses | The expenses that belong to this contact |
Phone Numbers
| Property | Type | Description |
|---|---|---|
| platform_id | string | The Platform's ID for the phone number |
| data_model | string | The data model to which this number is linked. Values are: COMPANY_INFO, CONTACTS |
| data_model_id | string | The unique identifier for the data model associated with this number |
| number | string | The number of the contact person. |
| type | enum | The type of the number. Values are: MOBILE, TELEPHONE, FAX. |
| updated_at | date | The date and time at which the number information was last updated in the accounting platform |
Addresses
| Property | Type | Description |
|---|---|---|
| platform_id | string | Platform's ID for the address |
| type | enum | The type of address. Values are: BILLING, SHIPPING. |
| data_model | string | The data model to which this address is linked. Values are COMPANY_INFO, CONTACTS, INVOICES, BILLS, EXPENSES, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, SALES_ORDERS, PURCHASE_ORDERS |
| data_model_id | string | The unique identifier for the data model associated with this address |
| street | string | The street information of the address |
| locality | string | The locality or neighborhood information of the address |
| city | string | The city information of the address |
| state | string | The state or region information of the address |
| country | string | The country information of the address |
| pincode | string | The postal or zip code of the address |
| updated_at | date | The date and time at which the address information was last updated in the accounting platform |
External Links
| Property | Type | Description |
|---|---|---|
| platform_id | string | The Platform's ID for the external link |
| data_model | string | The data model to which this link is related. Values are: COMPANY_INFO, CONTACTS |
| data_model_id | string | The unique identifier for the data model associated with this link |
| link | string | The URL or email data. |
| type | enum | The type of link. Values are: WEBSITE, EMAIL. |
| updated_at | date | The date and time at which the link information was last updated in the accounting platform |