Skip to main content
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, and UNKNOWN, facilitating better organisation and reporting.

​
Attributes

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the contact
namestringName of the customer on the accounting platform
contact_namestringName of the contact person for the contact
contact_typeenumThe type of customer. Values are either CUSTOMER or VENDOR
currencystringThe ISO-4217 currency code
tax_numberstringContact’s tax number
registration_numberstringContact’s identifying number
statusenumThe status of the customer. Values are: ACTIVE, ARCHIVED, UNKNOWN
contact_personsContact PersonList of contacts stored for the contact.
external_linksExternal LinkThe external links associated with the contact
phone_numbersPhone NumberThe phone numbers associated with the contact
addressesAddressThe addresses associated with the contact
updated_atdateThe last ISO 8601 timestamp at which the data was updated
{
  "platform_id": "1234567890123456789",
  "currency_id": "3770712000000000099",
  "name": "Darth Vader",
  "contact_name": "Darth Vader",
  "contact_type": "CUSTOMER",
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 0,
      "updated_at": null
    }
  },
  "tax_number": "ODSPS1279G",
  "registration_number": "07CEUPK5322M1ZX",
  "status": "ACTIVE",
  "contact_persons": {},
  "external_links": {
    "data": [
      {
        "platform_id": "CONTACTS_3770712000001721005_WEBSITE",
        "data_model": "CONTACTS",
        "data_model_id": "3770712000001721005",
        "link": "https://www.rootfi.dev",
        "type": "WEBSITE",
        "updated_at": "2023-11-05T00:00:00.000Z"
      }
    ]
  },
  "phone_numbers": {
    "data": [
      {
        "platform_id": "CONTACTS_3770712000001721005_MOBILE",
        "data_model": "CONTACTS",
        "data_model_id": "3770712000001721005",
        "number": "+919*********",
        "type": "MOBILE",
        "updated_at": "2023-11-05T00:00:00.000Z"
      }
    ]
  },
  "addresses": {
    "data": [
      {
        "platform_id": "3770712000001721013_CONTACTS_3770712000001721005_SHIPPING",
        "type": "SHIPPING",
        "data_model": "CONTACTS",
        "data_model_id": "3770712000001721005",
        "street": "21 street house",
        "locality": "Koramanager",
        "city": "Hyderabad",
        "state": "Bengalore",
        "country": "India",
        "pincode": "500045",
        "updated_at": "2023-11-05T00:00:00.000Z"
      }
    ]
  },
  "updated_at": "2023-11-05T00:00:00.000Z"
}