Skip to main content
All CollectionsFAQGeneral
๐Ÿ•ฎ System Field Glossary
๐Ÿ•ฎ System Field Glossary

Everything you need to know about system fields

Christian Dreyer avatar
Written by Christian Dreyer
Updated over a week ago

System fields are fields that have been created by us and they're also populated by us. We have a wide range of system fields across several different objects. If you hover over your avatar in the bottom left corner and go to "Fields", you will see all of the different objects. Each object can contain a range of system and custom fields, the cog icon next to the field name means it's a system field.

๐Ÿ“Œ Important to note: to access the "Fields" page you will need to have the permission: "Admin access" enabled.

To help you understand what information each of these system fields are displaying and how they're populated we have created the glossary below ๐Ÿค“.


Company

  • Accumulated MRR/ARR ({Currency}): total Annual/Monthly Recurring Revenue accumulated on the account.
    โ€‹
    โ€‹

  • Accumulated NRR: total Non-Recurring Revenue accumulated on the account.
    โ€‹
    โ€‹

  • Address: a text field that's used to store an address.
    โ€‹
    โ€‹

  • City: a text field that's used to store the city.
    โ€‹
    โ€‹

  • Co-Owner: a team member field that's used to store the account co-owner.
    โ€‹
    โ€‹

  • Collaborators: a team members field that's used to give users the ability to access accounts (they won't receive account notifications). For example, if you have an external contractor or partner with the CSM role helping you with specific customers, you can add them as a collaborator and they will only have access to those accounts and not the broader data in Planhat.


    โ€‹

  • Country: a text field that's used to store the country.
    โ€‹
    โ€‹

  • CSM Score: a rating field that you can use to set a score between 1 and 5. The CSM Score is a manual score that you and your team can set. Many use it to indicate the status of the relationship between their company to the customer.
    โ€‹
    โ€‹

  • Customer Since:

    • date field that looks at your license data and displays the earliest start date, when setting Set "Customer Since" Field Manually is disabled;

    • with setting "Set "Customer Since" Field Manually" enabled, this field will be editable and it won't get automatically set with the earliest license start date.

  • Customer To: a date field that looks at your license data and displays the latest end date.
    โ€‹
    โ€‹

  • Customer Status: displays the status of the account which is determined by the account's license information. Below we have listed all of the different customer statuses and we have explained when each of them will be applied:
    โ€‹
    โ€‹

    • Prospect: there are no licenses mapped to the account.
      โ€‹
      โ€‹

    • Coming: a license with the status โ€œongoingโ€ is starting somewhere in the future.
      โ€‹
      โ€‹

    • Customer: the account has an โ€œongoingโ€ license today.
      โ€‹
      โ€‹

    • Canceled: the last license(s) in the account has been marked as "renewed" or โ€œlostโ€ and will end in the future.
      โ€‹
      โ€‹

    • Lost: the last license(s) were marked as lost and have already expired.
      โ€‹
      โ€‹

  • Description: a rich text field that's typically used to add a description about the customer.
    โ€‹
    โ€‹

  • External Id: a text field that is used to store the unique identifier for the account. This field ensures updates and usage data are all mapped to the correct account. It's defined by you and the best practice for this field is to ensure it matches a unique identifier given to companies in your own internal database.
    โ€‹
    โ€‹

  • Followers: a team members field. When a user is added to the "Followers" field they will receive notifications from the customers they follow. Notifications received as a follower can be modified in the notification preferences section.
    โ€‹
    โ€‹

  • Group MRR/ARR ({Currency}): this is a number field that displays the MRR/ARR value of the individual account that's part of a group structure.
    โ€‹
    โ€‹

  • Hlth Diff: this is the change in health score, for example, if my score changes from "5" to "7" then the "Hlth Diff" field will display "2".
    โ€‹
    โ€‹

  • Hlth Diff (date): this is the date that the health score last changed.
    โ€‹
    โ€‹

  • Last Seen (date): a date field that displays the date that an end-user was last seen in your product. This field takes the date from the most recent user activity in Planhat.
    โ€‹
    โ€‹

  • Last Touch (date): this field will display the date that the customer was last reached out to and the contact type. Emails, tickets, calls, chats and external Conversation Types are touchpoints.
    โ€‹
    โ€‹

  • Matching Filters: displays a list of filters that the account is in on the Company object.
    โ€‹
    โ€‹

  • MR: a number field that stands for "Monthly Revenue" and it's displaying the MRR value plus NRR Last 30.
    โ€‹
    โ€‹

  • MRR/ARR value ({Currency}): on the "Settings" page if you scroll down until you see "Reporting Options" you have the option to view your data as MRR or ARR. Depending on the option that you select you will either see the field name: "MRR Value ({Currency})" or "ARR Value ({Currency})". This field displays the total monthly or annual recurring revenue on the account. The field sums the values on all licenses on the account that have started and haven't ended.
    โ€‹
    โ€‹

  • Name: a text field that displays the company name.
    โ€‹
    โ€‹

  • NPS Score: a number field that takes all of the associated end-user NPS scores and calculates the mean, median or mode. On the "Settings" page there's a setting called "NPS Calculation Base", you can choose if you would like the NPS score to be calculated using the mean, median or mode.
    โ€‹
    โ€‹

  • NRR Last 30: a number field that displays the total non-recurring revenue that has been registered in the past 30 days.
    โ€‹
    โ€‹

  • Owner: a team member field that's used to display the account owner.
    โ€‹
    โ€‹

  • Phone & Phone 2: you don't have to leave Planhat to be able to call a customer. Just click on the phone icon on the and Planhat will open up the browser's default dialer. If you're using our integration with Aircall, it will open up the Aircall app automatically if you have it downloaded on your desktop. Read more about it here.
    โ€‹
    โ€‹

  • Phase: a list field that you can use to keep track of your customers lifecycle. The field is customizable which means you can add new phases and edit existing phases. Learn more about this field here.
    โ€‹
    โ€‹

  • Renewal: this field uses the information from the licenses that are on the account. There are a few different values that this field can display:
    โ€‹
    โ€‹

    • Renewal date: this is the license end date of the license that's due to end the soonest and has the status set to "ongoing".
      โ€‹
      โ€‹

    • Lost: the license end date has passed and the status isn't set to "ongoing".
      โ€‹
      โ€‹

    • Canceled: the license status isn't set to "ongoing" and the license end date is in the future.
      โ€‹
      โ€‹

    • Open ended: the license status is set to "ongoing" and it's not fixed term (no end date).
      โ€‹
      โ€‹

  • Related Domains: email domains related to a company. For example, at Planhat our domain is planhat.com. This field ensures your customer communications are logged against the correct account in Planhat (e.g. calendar events, emails, tickets and chats).

    This field allows for the automatic creation of new contacts. When we receive user tracking events or sync emails and calendar events, we match the email domains of involved contacts with the domains of existing companies, and create new contacts. Related Domains can be manually added or removed from a company's profile and can also be set/updated/removed by using our /companies API endpoint.


    โ€‹

  • SourceId (CRM): the unique identifier for companies synced with an external CRM system such as HubSpot and Salesforce. This field ensures your companies in Planhat sync with the correct companies in your external CRM system.

    When you integrate an external CRM system with Planhat and a new company is created in Planhat, the Source ID field will automatically populate. If you manually create a company in Planhat after completing the integration and want to ensure it syncs correctly, you can manually add the Source ID located in the 'data' section.

    You can also set this using our /companies API endpoint.

    HubSpot = Company ID
    Salesforce = Salesforce ID
    Pipedrive = Organization ID
    โ€‹
    โ€‹

  • Total Group MRR/ARR ({Currency}): this is a number field that displays the combined MRR/ARR value of all accounts in a group structure.
    โ€‹
    โ€‹

  • Website: a URL field that enables you to add a website address and when you click on the address the web page will open e.g. https://www.planhat.com.
    โ€‹
    โ€‹

  • Zip: a text field where you would enter the account's zip code.


End Users

  • Beat: total activities (clicks, logins, downloads etc) over the past 14 days.
    โ€‹
    โ€‹

  • Total beats: total activities since the date we started tracking usage.
    โ€‹
    โ€‹

  • Create Date: a date field that contains the date the end-user was created in Planhat.
    โ€‹
    โ€‹

  • Email: an email field that contains the end-user's email address.
    โ€‹
    โ€‹

  • Experience: the end-user's total activities since the date we started tracking usage and the experience % shows their relative usage compared to all other users in your system.
    โ€‹
    โ€‹

  • ExternalId: a text field that contains the end-user unique identifier. This field ensures updates and usage data are all mapped to the correct end-user. It's defined by you and the best practice for this field is to ensure it matches a unique identifier given to end-users in your own internal database.


    โ€‹

  • Featured: a checkbox field that's used to mark an end-user as featured. Marking an end-user as featured can help you determine who is important to reach out to or get in contact with when there is something happening with the company's account, or the time for renewal is up
    โ€‹
    โ€‹

  • First Name: a text field used to store the end-user's first name.
    โ€‹
    โ€‹

  • Last Name: a text field used to store the end-user's last name.
    โ€‹
    โ€‹

  • LinkedIn URL: a text field used to store the end-user's LinkedIn profile URL.
    โ€‹
    โ€‹

  • Matching Filters: displays a list of filters that the end-user is a part of.
    โ€‹
    โ€‹

  • NPS: this is the NPS score that hasn't yet expired. There could be a more recent NPS score but if the previous NPS score hasn't expired, then we will display that score. If you would like to modify your NPS expiry date settings, hover over your avatar in the bottom left corner > go to "Settings" > search for "Nps Scores Expiry Days" and enter an integer into that field (you must be an administrator to do this).
    โ€‹
    โ€‹

  • Phone: you don't have to leave Planhat to be able to call a customer. Just click on the phone icon on the and Planhat will open up the browser's default dialer. If you're using our integration with Aircall, it will open up the Aircall app automatically if you have it downloaded on your desktop. Read more about it here.
    โ€‹
    โ€‹

  • Position: a text field used to enter the end-user's position.
    โ€‹
    โ€‹

  • Primary: depending on your business structure and how you've set up your account in Planhat, there could be a user with the same email that needs to be a user in multiple accounts. In this case, Planhat will have their activity data displayed on all of the accounts that end-user is associated with. However, if you'd like Planhat to display this user's activity and touch point data on one main account you can do so by using the "Primary" checkbox field.
    โ€‹
    โ€‹

  • Relevance: a home-grown secret algorithm looking at an End Users Beat, Beat trend and recent Conversations (emails, tickets, meeting attendance etc) in the context of all your End Users and scoring them with High, Medium or Low relevance. More points in the algorithm are attributed to more recent engagement in your product or with your team. High relevance means an End User is highly engaged with your product and team relative to all other End Users.
    โ€‹
    โ€‹

  • Secondary Emails: if the end-user has additional emails then you can list them here. The email sync will include those email addresses when mapping emails to the correct profiles.


User (Team Member)

  • Active: a checkbox field that needs to be enabled otherwise the user won't be able to access Planhat.
    โ€‹
    โ€‹

  • Currency: a list field that enables each user to set their own currency. For example, if the base currency is set to USD the user can set the "Currency" field to GBP which means when they next create a license, it will appear in GBP by default instead of USD.
    โ€‹
    โ€‹

  • Default meeting length (minutes): a number field to store the default meeting length. When planning an event Planhat will set the default meeting length for you using the value in this field.
    โ€‹
    โ€‹

  • Email: an email field that stores the user's email address.
    โ€‹
    โ€‹

  • ExternalId: a text field that holds the user's externalId. Typically this will be an Id that you have in your own system which makes it easy to map the user from your own system to Planhat. If you have this field populated in Planhat you can use it to update the user.
    โ€‹
    โ€‹

  • First Name: a text field used to store the user's first name.
    โ€‹
    โ€‹

  • GMT Time Offset: a number field that's used to set the environment's time zone. This setting will override the tenant GMT Time Offset setting. Each user can set their own time zone and this will impact: logs, tasks metrics etc.
    โ€‹
    โ€‹

  • Last Name: a text field used to store the user's last name.
    โ€‹
    โ€‹

  • Nick Name: a text field that's used to store the user's nickname. The nickname is visible in the top left corner of the user's profile.
    โ€‹
    โ€‹

  • SlackId: a text field that's used to store your SlackId so that you can utilize our Slack bot to retrieve your customer's information. To use the Slack bot, you will need to have the Slack integration setup and this article explains how to do that.
    โ€‹
    โ€‹

    • Where do I find my SlackID? - This is your member ID which is stored on your Slack profile.

  • Start Page: a list field that contains eight different options and they determine which area of Planhat will open when you login e.g. Companies, Today's Tasks, Bubble Room etc.


License

  • Auto Renewal: a checkbox field that determines if a license will automatically renew. If you would like a license to automatically renew, it's important to note that you must also have the setting "Automatically Renew Licenses (automaticRenewal)" enabled. If you are an administrator, hover over your avatar in the bottom left corner > go to "Settings" and under "Revenue" you will see that setting.
    โ€‹
    โ€‹

  • Currency: a list field that displays a range of different currencies. To add and remove currencies from the list field you will need "Admin Access". If you are an administrator, hover over your avatar in the bottom left corner > go to "Settings" > search or scroll down until you see a blue button that says "Add Currency" > click on that and then select the currency that you would like to add. To remove a currency, hover over the currency and click on the small trash can icon.
    โ€‹
    โ€‹

  • Cycle interval in months: on the "Invoice Cycle" field if you select "Custom" from the drop-down list the "Cycle interval in months" field will appear giving you the option to select a specific invoice cycle (in months).
    โ€‹
    โ€‹

  • Display Value: a number field that's used to store and display the total license value.
    โ€‹
    โ€‹

  • Fixed Period: a checkbox field that's used to determine if the license has a specified end date or if it's ongoing for the foreseeable future:
    โ€‹
    โ€‹

    • Fixed Period (Yes): a license end date must be provided.

    • Fixed Period (No): the license is ongoing and no end date is required.
      โ€‹
      โ€‹

  • Invoice Cycle: a list field that displays a range of different invoice cycle options:
    โ€‹
    โ€‹

    • All upfront

    • Monthly

    • Quarterly

    • Semi annual

    • Yearly

    • Custom
      โ€‹
      โ€‹

  • Invoice Muted: a checkbox field that determines if invoices are automatically generated when a license automatically renews.
    โ€‹
    โ€‹

  • License start date: a date field that displays the license start date.
    โ€‹
    โ€‹

  • License end date: a date field that displays the license end date.
    โ€‹
    โ€‹

  • Next term start date: a date field that's used to predetermine a license start date if it gets renewed.
    โ€‹
    โ€‹

  • Next term length (months): a number field that's used to predetermine the length of a license when it gets renewed.
    โ€‹
    โ€‹

  • Notice Period: a number field that's used to set a notice period for licenses that auto-renew e.g. 30 days. You also have the option to include the notice period in the renewal date. If you are an administrator, hover over your avatar in the bottom left corner > go to "Settings" > under "Revenue" you will see a setting called "Include notice period in renewal date (includeNoticeInRenewalDate)".
    โ€‹
    โ€‹

  • Notice Unit: a list field that's used in conjunction with the "Notice Period" field. When you're setting up the notice period, the "Notice Unit" field gives you the option to use display the notice period in "days", "weeks" and "months".
    โ€‹
    โ€‹

  • Product: a list field that contains the names of your recurring revenue products. Users with "Admin Access" can update the items in that field by going to the "Settings" page, searching for "Recurring Products" and then clicking on the button called "Add Recurring Product".
    โ€‹
    โ€‹

  • Renewal ARR: a number field that's used to predetermine the ARR value of a license if it gets renewed.
    โ€‹

  • Status: a list field that displays the license status:
    โ€‹
    โ€‹

    • Ongoing: the license is active

    • Renewed: the license has been renewed (not active)

    • Lost: the license is lost (not active)


Sale (NRR)

  • Currency: a list field that contains a list of different currencies.
    โ€‹
    โ€‹

  • Product: a list field that contains the names of your non-recurring revenue products. Users with "Admin Access" can update the items in that field by going to the "Settings" page, searching for "Non-Recurring Products" and then clicking on the button called "Add Non-Recurring Product".
    โ€‹
    โ€‹

  • Sales Date: a date field that stores the date of the sale.
    โ€‹
    โ€‹

  • Value: a number field that stores the Non-Recurring Product value.


Opportunity

No system fields.


Churn

No system fields.


Invoice

  • Due Date: a date field that contains the invoice due date.
    โ€‹
    โ€‹

  • Invoice Date: a date field that contains the invoice date.
    โ€‹
    โ€‹

  • Paid Date: a date field that contains the date that the invoice was paid.
    โ€‹
    โ€‹

  • Paid: a checkbox field that records whether the invoice has been paid.


Conversation

  • Involved Contacts: an endusers field that can store multiple end-users that were involved in the conversation.


Task

  • Involved Contacts: an endusers field that's used to display end-users that are involved on the task/event. When an end-user is selected the task/event will appear on the end-user's profile.
    โ€‹
    โ€‹

  • Main Type: a list field that gives you two options: "Task" and "Event". If you would like to plan a meeting or customer event and push it to Google Calendar then you would use "Event". For everything else, you would use "Task".
    โ€‹
    โ€‹

  • Repeat Interval: a list field that displays several different repeat options. When you create a task, you can automatically repeat the task in a day, week, month, year etc by using this field.
    โ€‹
    โ€‹

  • Repeat Interval (days): if you select "custom" from the list field "Repeat Interval", a number field will appear. For example, if you would like the task to repeat in three days then you would input "3".
    โ€‹
    โ€‹

  • Shared: a checkbox field that determines if the task can be shared on the Customer Portal.


Project

  • Currency: a list field that gives you the option to select one of the following currencies: USD, EUR, SEK, AUD and GBP.
    โ€‹
    โ€‹

  • End Date: a date field that contains the project end date.
    โ€‹
    โ€‹

  • External Id: a text field that holds the Project externalId. Typically this will be an Id that you have in your own system which makes it easy to map the Project from your own system to Planhat.
    โ€‹
    โ€‹

  • MRR: a number field that displays the Project's MRR.
    โ€‹
    โ€‹

  • Name: a text field that displays the name of the project.
    โ€‹
    โ€‹

  • NRR: a number field that displays the Project's NRR.
    โ€‹
    โ€‹

  • Start Date: a date field that contains the project start date.
    โ€‹
    โ€‹

  • Source Id: the unique identifier for Projects synced with an external CRM system such as Salesforce. This field ensures your Projects in Planhat sync with the correct Projects in your external CRM system.


Issue

  • Created: a date field that contains the date the Issue was created.
    โ€‹
    โ€‹

  • Description: a text field that's used to store the Issue description.
    โ€‹
    โ€‹

  • Issue Type: a text field that's used to store the type of issue.
    โ€‹
    โ€‹

  • Priority: a text field that's used to store the issue's priority e.g. low, medium and high.
    โ€‹
    โ€‹

  • Project Id: a text field that's used to store the Jira project ID.
    โ€‹
    โ€‹

  • Status: a list field that's used to display an issue's current status. There are three different options to choose from: "Open", "In Progress" and "Done".
    โ€‹
    โ€‹

  • Source Key: a text field that stores the Issue key that syncs directly from Jira. Use the Source Key to map data between Jira and Planhat.
    โ€‹
    โ€‹

  • Source: a text field that stores the Jira source e.g. Jira.
    โ€‹
    โ€‹

  • Source Id: the unique identifier for issues synced with Jira. This field ensures your issues in Planhat sync with the correct issues in Jira.
    โ€‹
    โ€‹

  • Source Url: a text field that's used to store a link to the issue in Jira.
    โ€‹
    โ€‹

  • Title: a text field that displays the Issue title.
    โ€‹
    โ€‹

  • Updated: a date field that displays the date that the Issue was last updated.


Asset

  • External Id: a text field that holds the Asset externalId. Typically this will be an Id that you have in your own system which makes it easy to map the Asset from your own system to Planhat.
    โ€‹
    โ€‹

  • Name: a text field that's used to store the name of the Asset.
    โ€‹
    โ€‹

  • Source Id: the unique identifier for assets synced with an external CRM system such as Salesforce. This field ensures your assets in Planhat sync with the correct assets in your external CRM system.


Workflow

  • Expected Days: a number field that's used to store the number of days expected to complete the Workflow. The field is called "Days to Complete" when you're editing the Workflow template. This can be used to measure the performance of the Workflow
    โ€‹
    โ€‹

  • Start Date: a date field that displays the date that the Workflow was applied.


NPS

No system fields.


Automation

  • Enabled: a checkbox field that's used to turn the automation on and off.

Did this answer your question?