Skip to main content
The Customer Data Model simplifies the handling and retrieval of customer-related information across various payments platforms.
  • Unified customer properties: The model unifies essential customer details, such as name, customer person, currency, and tax number, enabling easier access and management of customer data from different platforms.
  • Comprehensive customer information: Customer can include associated data like phone numbers, addresses, and external links for a more detailed representation of each customer.
  • Status tracking: The model supports tracking the status of each customer, with values like ACTIVE, ARCHIVED, and UNKNOWN, facilitating better organisation and reporting.

​
Attributes

​
Customer Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the customer
rootfi_created_atstringThe ISO 8601 timestamp at which the record was created in RootFi
rootfi_updated_atstringThe ISO 8601 timestamp at which the record was last updated in RootFi
rootfi_company_idintegerThe RootFi company ID associated with the customer
platform_idstringThe Platform’s ID for the customer
platform_unique_idstringThe platform’s unique identifier for the customer
namestringName of the customer on the platform
created_atstringThe ISO 8601 timestamp at which the data was created on the platform
tax_numberstringCustomer’s tax number (i.e. GST, EIN, VAT)
currency_idstringThe currency id of the customer
updated_atstringThe ISO 8601 timestamp at which the information was updated on the platform
external_linksExternal LinkThe external links associated with the customer
phone_numbersPhone NumberThe phone numbers associated with the customer
addressesAddressThe addresses associated with the customer

​
Address Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the address
platform_idstringThe Platform’s ID for the address
platform_unique_idstringThe platform’s unique identifier for the address
typeAddressTypeThe type of address (SHIPPING, BILLING, COMPANY)
data_model_idstringThe ID of the parent data model this address belongs to
streetstringThe street address
localitystringThe locality or neighborhood
citystringThe city
statestringThe state or province
pincodestringThe postal or zip code
countrystringThe country

​
Phone Number Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the phone number
platform_idstringThe Platform’s ID for the phone number
numberstringThe phone number
typeContactNumberTypeThe type of phone number (MOBILE, TELEPHONE, FAX)
PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the external link
platform_idstringThe Platform’s ID for the external link
linkstringThe URL or email address
typeExternalLinkTypeThe type of external link (WEBSITE, EMAIL)

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the customer
namestringName of the customer on the platform
created_atstringThe ISO 8601 timestamp at which the data was created
tax_numberstringCustomer’s tax number (i.e. GST, EIN, VAT)
currency_idstringThe currency id of the customer
updated_atstringThe ISO 8601 timestamp at which the information was updated on the platform
external_linksExternal LinkThe external links associated with the customer
phone_numbersPhone NumberThe phone numbers associated with the customer
addressesAddressThe addresses associated with the customer
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "123456",
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.465Z",
  "name": "John Doe",
  "tax_number": "1234567890",
  "currency_id": "1234567890",
  "external_links": [
    {
      "rootfi_id": 278264,
      "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_WEBSITE",
      "link": "https://www.google.com",
      "type": "WEBSITE"
    }
  ],
  "phone_numbers": [
    {
      "rootfi_id": 278264,
      "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_PHONE",
      "number": "1234567890",
      "type": "MOBILE"
    }
  ],
  "addresses": [
    {
      "rootfi_id": 278264,
      "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
      "platform_unique_id": "123456",
      "type": "BILLING",
      "data_model_id": "123456",
      "street": "123 Main Street",
      "locality": "Main Street",
      "city": "New York",
      "state": "New York",
      "pincode": "123456",
      "country": "USA"
    }
  ]
}