This article outlines the tables, and fields that are available for querying in Karbon Practice Intelligence. These tables contain information about clients, client groups, tasks, users, work items, utilization and work hours, etc. If you have any other needs, please let us know in the Karbon Community.
Index
CONTACT_MEMBER_RELATIONSHIP
This table holds relationships between Karbon contacts. It is used in the Contact filters of Power BI workbooks.
Field | Description |
RELATIONSHIP_TYPE | Describes the nature of the relationship. Possible values include self relationship, client group member, and organization member. |
CONTACT_ID | The unique identifier of the contact. |
CONTACT | The name of the contact. |
CONTACT_TYPE | The type of the contact. It can be one of Person, Organisation, or Client Group. |
RELATED_CONTACT_ID | The unique identifier of the subordinate contact in the relationship. |
RELATED_CONTACT | The name of the subordinate contact in the relationship. |
RELATED_CONTACT_TYPE | The type of the subordinate contact in the relationship. It can be one of Person, Organisation, or Client Group. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
DIMN_CLIENT
This table holds attributes about a client.
Field | Description |
CLIENT_ID | The unique identifier of the client. |
CLIENT | The name of the client. |
DATE_CREATED | The date when the client was created in the system. |
CLIENT_TYPE | The type of client. It can be one of Individual (Contact), Organisation, Client Group. |
CLIENT_SUBTYPE | This is a further sub classification of a client. |
CLIENT_PRIMARY_EMAIL_ADDRESS | The primary email address of the client. |
USER_DEFINED_CLIENT_ID | An id created by the user for internal use. |
CLIENT_OWNER_USER_ID | The identifier of the User Profile who owns the responsibilities of this client. |
CLIENT_OWNER_USER_NAME | The name of the User Profile who owns the responsibilities of this client. |
CLIENT_MANAGER_USER_ID | The identifier of the User Profile who manages the responsibilities of this client. |
CLIENT_MANAGER_USER_NAME | The name of the User Profile who manages the responsibilities of this client. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
DIMN_CLIENT_GROUP
This table holds the attributes about the client group.
Field | Description |
CLIENT_GROUP_ID | The unique identifier of a client group. D |
CLIENT_GROUP_NAME | The name of the client group. |
CLIENT_ID | The unique identifier of the client who is a member of this group. |
CLIENT | The name of the client who is a member of this group. |
CLIENT_GROUP_MEMBER_TYPE | The type of client. It can be one of an Individual (Contact), Organisation, or Client Group. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
DIMN_DATE
This is a date table that allows analysis across different time periods
Field | Description |
CALN_DATE | This is the calendar date. |
DAY_OF_WEEK | This is the numerical day of the current week. Sunday is considered to be 1. |
WEEK_STRT_DATE | The current week's start date (Sun - Sat) |
WEEK_END_DATE | The current weekend date. (Sun - Sat) |
ISO_DAY_OF_WEEK | This is the ISO numerical day of the calendar date in the current week. Monday is considered to by 1. |
ISO_WEEK_STRT_DATE | The current week's start date is as per ISO standards. (MON - SUN) |
ISO_WEEK_END_DATE | The current weekend date is as per ISO standards. (MON - SUN) |
DAY_OF_WEEK_NAME | The name of the day. |
DAY_OF_MNTH | The numerical day of the current month. |
DAY_OF_YEAR | The numerical day of the current year. |
WEEK_OF_YEAR | The week number of the current year. |
CALN_MNTH | The numerical month of the current year. |
CALN_MNTH_NAME | The name of the month of the current year. |
MNTH_STRT_DATE | The month start date. |
MNTH_END_DATE | The month-end date. |
PRVS_MNTH_STRT_DATE | The previous month's start date |
PRVS_MNTH_END_DATE | The previous month's end date |
QRTR_OF_YEAR | The current numerical quarter of the year. |
QRTR_STRT_DATE | The quarter start date. |
QRTR_END_DATE | The quarter end date. |
PRVS_QRTR_STRT_DATE | The previous quarter's start date. |
PRVS_QRTR_END_DATE | The previous quarter's end date. |
CALN_YEAR | The calendar year. |
YEAR_STRT_DATE | The year start date. |
YEAR_END_DATE | The year-end date. |
PRVS_YEAR_STRT_DATE | The previous year's start date. |
PRVS_YEAR_END_DATE | The previous year-end date. |
DIMN_TASK_TYPE
This table holds the attributes that define a task type.
Field | Description |
TASK_TYPE_ID | The unique identifier for the task type. |
TASK_TYPE_NAME | The name of the task type. |
IS_TASK_TYPE_BILLABLE | A flag saying whether the task type is billable. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
DIMN_USER
This table holds the attributes that define a user / employee.
Field | Description |
USER_NAME | The name of the user profile. |
USER_ID | The unique identifier of the user profile. |
USER_JOB_TITLE | The job title of the user profile. |
USER_EMAIL_ADDRESS | The email address of the user profile. |
CREATED_DATE | The date when the user profile was created in the system. |
ACTIVATED_DATE | The date when the user profile was activated in the system. |
EXPECTED_BILLABLE_MINUTES | The weekly billable minutes of the user profile is expected to work. |
EXPECTED_NONBILLABLE_MINUTES | The weekly non-billable minutes the user profile is expected to work. |
STATUS | The status of the user profile. |
IS_SUPPORT_USER | A flag indicating whether the user profile is a support user. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
DIMN_WORK_ITEM
This table holds the attributes that define information about a work item.
Field | Description |
WORK_ITEM_ID | The unique identifier for the work item whose details are being provided. |
WORK_TITLE | The title of the work item |
WORK_TYPE | The type of the work item. |
CREATED_DATETIME | The date time the work item was created. |
START_DATETIME | The date time the work item was started. |
DUE_DATETIME | The due DateTime of the work item. |
COMPLETED_DATETIME | The DateTime the work item was completed. |
PRIMARY_STATUS | The primary status of the work item |
SECONDARY_STATUS | The secondary status of the work item |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
USER_TIME_ENTRY_DETAIL
This table provides the individual time entries submitted by users
Field | Description |
REPORTING_DATE | The date on which the time entry was submitted for. |
USER_ID | The unique identifier of the user profile who submitted the time entry. |
USER_NAME | The name of the user profile who submitted the time entry. |
MINUTES | The amount of time in minutes submitted with the time entry. |
TOTAL_COST | The calculated cost for the time entry is based on the minutes, role and task type. |
CLIENT_ID | The unique identifier of the client. |
CLIENT | The name of the client. |
TASK_TYPE_ID | The unique identifier for the task type. |
TASK_TYPE | The name of the task type. |
IS_BILLABLE | A flag saying whether the task type is billable. |
ROLE_ID | The unique identifier of the role performed by the user. |
ROLE_NAME | The name of role performed by the user. |
WORK_ITEM_ID | The unique identifier for the work item whose details are being provided. |
WORK_ITEM_TITLE | The title of the work item. |
WORK_ITEM_TYPE | The type of the work item. |
DESCRIPTION | The description added to the submitted time entry. |
TIME_ENTRY_ID | The unique ID of the time entry. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
USER_WEEKLY_UTILIZATION_SUMMARY
This table provides a weekly comparison of the billable/non-billable expected and actual time for user profiles / employees.
Field | Description |
REPORTING_WEEK_START_DATE | The start date of the reporting week. |
REPORTING_WEEK_END_DATE | The end date of the reporting week. |
USER_ID | The unique identifier of the user profile. |
USER_NAME | The name of the user profile. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
EXPECTED_BILLABLE_MINUTES | The weekly billable minutes the user profile is expected to work. |
ACTUAL_BILLABLE_MINUTES | The weekly billable minutes the user profile actually worked. |
EXPECTED_NONBILLABLE_MINUTES | The weekly non-billable minutes the user profile is expected to work. |
ACTUAL_NONBILLABLE_MINUTES | The weekly non-billable minutes the user profile actually worked. |
USER_WORK_HOURS_SUMMARY
This table provides metrics around the actual time entries for user profiles / employees across different time periods.
Field | Description |
REPORTING_DATE | The date as of which the data is representative of. |
INTERNAL_CLIENT_ID | The User Profile to which the work item belongs to. |
INTERNAL_CLIENT | The name of the User to which the work item belongs to. |
USER_ID | The unique identifier of the user profile. |
USER_NAME | The name of the user profile. |
CLIENT_ID | The unique identifier of the client. |
CLIENT | The name of the client. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
TASK_TYPE_ID | The unique identifier for the task type. |
TASK_TYPE | The name of the task type. |
TASK_TYPE_BILLABLE_FLAG | A flag saying whether the task type is billable. |
ROLE_ID | The unique identifier of the role performed by the user. |
ROLE_NAME | The name of role performed by the user. |
WORK_ITEM_TYPE_ID | The type code of the work item. |
WORK_ITEM_TYPE | The type of the work item. |
REPORTING_DATE_TIME_MINUTES | Minutes the user logged for the given reporting date. |
MTD_TIME_MINUTES | Minutes the user logged this month till reporting date. |
QTD_TIME_MINUTES | Minutes the user logged this quarter till reporting date. |
YTD_TIME_MINUTES | Minutes the user logged this year till reporting date. |
PREVIOUS_MONTH_TIME_MINUTES | Minutes the user logged in the previous month. |
PREVIOUS_QUARTER_TIME_MINUTES | Minutes the user logged in the previous quarter. |
PREVIOUS_YEAR_TIME_MINUTES | Minutes the user logged in the previous year. |
REPORTING_DATE_TIME_COST | The total cost amount is based on the minutes logged by the user for the given reporting date. |
MTD_COST | The total cost amount is based on the minutes logged by the user this month till the reporting date. |
QTD_COST | The total cost amount is based on the minutes logged by the user this quarter till the reporting date. |
YTD_COST | The total cost amount is based on the minutes logged by the user this year till the reporting date. |
PREVIOUS_MONTH_COST | The total cost amount is based on the minutes logged by the user in the previous month. |
PREVIOUS_QUARTER_COST | The total cost amount is based on the minutes logged by the user in the previous quarter. |
PREVIOUS_YEAR_COST | The total cost amount is based on the minutes logged by the user in the previous year. |
REPORTING_DATE_RECORD_COUNT | The total number of time entries logged for the given reporting date. |
MTD_RECORD_COUNT | The total number of time entries logged this month till reporting date. |
QTD_RECORD_COUNT | The total number of time entries logged this quarter till reporting date. |
YTD_RECORD_COUNT | The total number of time entries logged this year till reporting date. |
PREVIOUS_MONTH_RECORD_COUNT | The total number of time entries logged in the previous month. |
PREVIOUS_QUARTER_RECORD_COUNT | The total number of time entries logged in the previous quarter. |
PREVIOUS_YEAR_RECORD_COUNT | The total number of time entries logged in the previous year. |
WORK_ITEM_BUDGET_VS_ACTUAL
This table compares the budgeted minutes / cost against the actual minutes and costs for work items.
Field | Description |
REPORTING_DATE | The date of which the data is representative of. |
WORK_ITEM_ID | The unique identifier for the work item whose details are being provided. |
WORK_TITLE | The title of the work item |
WORK_TYPE_ID | The type code of the work item. |
WORK_TYPE | The type of the work item. |
TASK_TYPE_ID | The unique identifier for the task type. |
TASK_TYPE | The name of the task type. |
TASK_TYPE_BILLABLE_FLAG | A flag saying whether the task type is billable. |
ROLE_ID | The unique identifier of the roles performed on the work item. |
ROLE_NAME | The name of the roles performed on the work item. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
USER_ID | The unique identifier of the user profile for whom the comparison is done. |
USER_NAME | The name of the user profile for whom the comparison is done. |
INTERNAL_CLIENT_ID | The User Profile to which the work item belongs to. |
INTERNAL_CLIENT | The name of the User to which the work item belongs to. |
CLIENT_ID | The client's unique identifier to which the work item belongs to. |
CLIENT | The client's name to which the work item belongs to. |
BUDGETED_MINUTES | Total minutes budget for the work item. |
ACTUAL_MINUTES | The actual minutes spent on the work item. |
BUDGETED_COST | The total budgeted cost for the work item. |
ACTUAL_COST | The actual cost incurred on the work item. |
WORK_ITEM_DAYS_IN_STATUS
This table provides information on the number of days a given work items was in a specific status.
Field | Description |
WORK_ITEM_ID | The unique identifier for the work item whose details are being provided. |
WORK_ITEM_TITLE | The title of the work item |
WORK_ITEM_CREATED_AT | The DateTime when the work item was created. |
ASSIGNED_TO_ID | The user identifier to whom the work item was assigned to. |
ASSIGNED_TO | The name of the user to whom the work item was assigned to. |
CLIENT_ID | The client's unique identifier to which the work item belongs to. |
CLIENT_NAME | The client's name to which the work item belongs to. |
USER_ID | The User Profile to which the work item belongs to. |
USER_NAME | The name of the User to which the work item belongs to. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
PRIMARY_STATUS_ID | The primary status code in which the work item currently sits. |
PRIMARY_STATUS_NAME | The primary status name in which the work item currently sits. |
SECONDARY_STATUS_ID | The secondary status code in which the work item currently sits. |
SECONDARY_STATUS_NAME | The secondary status name in which the work item currently sits. |
STATUS_ENTRY_DATE | The date on which the work item entered the given primary and secondary status. |
STATUS_EXIT_DATE | The date on which the work item exited the given primary and secondary status. |
DAYS_IN_STATUS | The number of days the work item was in the given primary and secondary status. |
WORK_ITEM_DETAILS
This table provides all the details about a work item.
Field | Description |
WORK_ITEM_ID | The unique identifier for the work item whose details are being provided. |
REPORTING_DATE | The business date for which the report is run. |
WORK_TITLE | The title of the work item |
CLIENT_ID | The client's unique identifier to which the work item belongs to. |
CLIENT | The client's name to which the work item belongs to. |
CLIENT_TYPE | The client's type to which the work item belongs to. Can be one of - Individual, Organization or Client Group. |
INTERNAL_CLIENT_ID | The User Profile to which the work item belongs to. |
INTERNAL_CLIENT | The name of the User to which the work item belongs to. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
WORK_TYPE_ID | The type code of the work item. |
WORK_TYPE | The type of the work item. |
PRIMARY_STATUS_ID | The primary status code in which the work item currently sits. |
SECONDARY_STATUS_ID | The secondary status code in which the work item currently sits. |
PRIMARY_STATUS | The primary status name in which the work item currently sits. |
SECONDARY_STATUS | The secondary status name in which the work item currently sits. |
CREATED_DATETIME | The date and time when the work item was created. |
CREATED_BY_ID | The user profile's unique identifier who created the work item. |
CREATED_BY | The user profile's name who created the work item. |
START_DATETIME | The date and time when the work item was started. In <timezone> |
ASSIGNED_TO_ID | The user profile's unique identifier to whom the work item is currently assigned to. |
ASSIGNED_TO | The user profile's name to whom the work item is currently assigned to. |
DUE_DATETIME | The date and time when the work item is expected to be completed. |
COMPLETED_DATETIME | The date and time when the work item is completed. In <timezone> |
COMPLETED_BY_ID | The user profile's unique identifier who completed the work item. |
COMPLETED_BY | The user profile's name who completed the work item. |
USER_DEFINED_CLIENT_ID | An id created by the user for internal use. |
FIXED_FEE_ESTIMATED_COST | The estimated fixed fee cost associated with the work item. |
BUDGETED_MINUTES | The budgeted minutes for a work item. |
BUDGETED_COST | The budgeted cost for a work item. |
EXPENSE_AMOUNT | The total expense amount against the work item. |
BILLABLE_EXPENSE_AMOUNT | The billable expense amount against the work item. |
TIME_ENTRY_MINUTES | Total time entries in minutes against the work item. |
TIME_ENTRY_COST | Total time entry costs against the work item. |
WORK_ITEM_STATUS_HISTORY
This table provides the status life cycle of a work item.
Field | Description |
WORK_ITEM_ID | The unique identifier for the work item whose details are being provided. |
CHANGED_AT_DATETIME | The DateTime when the status changed from previous to current. |
WORK_TITLE | The title of the work item |
WORK_TYPE_ID | The id for the work type to which the work item belongs. |
WORK_TYPE | The work type name to which the work item belongs. |
ASSIGNED_TO_ID | The user identifier to whom the work item was assigned to. |
ASSIGNED_TO | The name of the user to whom the work item was assigned to. |
CHANGED_BY_ID | The user identifier who changed the work item status. |
CHANGED_BY | The name of the user who changed the work item status. |
CLIENT_ID | The client's unique identifier to which the work item belongs to. |
CLIENT | The client's name to which the work item belongs to. |
INTERNAL_CLIENT_ID | The User Profile to which the work item belongs to. |
INTERNAL_CLIENT | The name of the User to which the work item belongs to. |
ACCOUNT_ID | The tenant's unique identifier to whom the Work Item belongs to. |
ACCOUNT_NAME | The tenant's name to whom the Work Item belongs to. |
CHANGED_AT_DATE | The date when the status changed from previous to current. |
PREVIOUS_PRIMARY_STATUS_ID | The primary status id of the work item before the change. |
PREVIOUS_PRIMARY_STATUS | The primary status name of the work item before the change. |
PREVIOUS_SECONDARY_STATUS_ID | The secondary status id of the work item before the change. |
PREVIOUS_SECONDARY_STATUS | the secondary status name of the work item before the change. |
PRIMARY_STATUS_ID | The primary status id of the work item after the change |
PRIMARY_STATUS | the primary status name of the work item after the change. |
SECONDARY_STATUS_ID | The secondary status id of the work item after the change. |
SECONDARY_STATUS | the secondary status name of the work item after the change. |
AUTOMATICALLY_UPDATED | Flag indicating if the status change was done by an automator. |
CLIENT_EMAIL_CONVERSATION_RESPONSE_DETAIL
This table provides a detailed summary of email responses.
Field | Description |
CONTACT | The client's name with who the response email interacted. |
CLIENT_MANAGER | The name of the User Profile who manages the responsibilities of this client. Defined on the Details tab of the contact. |
CLIENT_MANAGER_ID | The identifier of the User Profile who manages the responsibilities of this client. |
CLIENT_OWNER | The name of the User Profile who owns the responsibilities of this client. Defined on the Details tab of the contact. |
CLIENT_OWNER_ID | The identifier of the User Profile who owns the responsibilities of this client. |
CONTACT_ID | The client's unique identifier with who the response email interacted. |
CONTACT_TYPE | The type of client: Individual (Contact), Organisation, Client Group. |
CONVERSATION_ID | The ID of the thread of emails in which the response email is included. |
EMAIL_SUBJECT | The subject line of the response email. |
EMAIL_MESSAGE_ID | The identifier of the response email. |
RESPONSE_DATETIME | The timestamp of the response email. |
RESPONSE_DIRECTION | The categorization of response email into "sent" or "received". Sent means the email was sent to the client, and received means the email was received by the client. |
EMAIL_SENT_BY | The name of the user who sent the response email. |
EMAIL_SENT_BY_ID | The identifier of the user who sent the response email. |
RESPONSE_TIME_HOURS | The time (in hours) it took the user to respond. |
RESPONSE_TIME_MINUTES | The time (in minutes) it took the user to respond. |
ACCOUNT_NAME | The tenant's name to whom the email belongs to. |
ACCOUNT_ID | The tenant's unique identifier to whom the email belongs to. |
CLIENT_EMAIL_INTERACTION_DAILY_SUMMARY
This table summarizes daily email interactions.
Field | Description |
INTERACTION_DATE | The date the email was sent. |
INTERACTION_DIRECTION | The categorization of email into "sent" or "received". Sent means the email was sent to the client, and received means the email was received by the client. |
CONTACT_ID | The client's unique identifier to who the email interacted. Defined on the Details tab of the contact. |
EMAIL_SENT_BY_ID | The unique identifier for who sent the email. |
ACCOUNT_ID | The tenant's unique identifier to whom the email belongs to. |
ACCOUNT_NAME | The tenant's name to whom the email belongs to. |
CLIENT_OWNER_ID | The unique identifier of the User Profile who owns the responsibilities of this client. |
CLIENT_OWNER | The name of the User Profile who owns the responsibilities of this client. Defined on the Details tab of the contact. |
CLIENT_MANAGER_ID | The identifier of the User Profile who manages the responsibilities of this client. |
CLIENT_MANAGER | The name of the User Profile who manages the responsibilities of this client. Defined on the Details tab of the contact. |
CONTACT | The client's name with who the email interacted. |
CONTACT_TYPE | The type of client: Individual (Contact), Organisation, Client Group. |
EMAIL_SENT_BY | The name of the user who sent the email. |
TOTAL_INTERACTION_COUNT | The count of emails both sent and received. |
EMAIL_DETAIL
This table shows all emails from both Karbon Contacts and non-contacts.
Field | Description |
ACCOUNT_ID | The tenant's unique identifier to whom the email belongs to. |
ACCOUNT_NAME | The tenant's unique identifier to whom the email belongs to. |
CONTACT_ID | The client's unique identifier to who the response email interacted with. |
CONTACT | The client's name to who the response email interacted with. |
CONTACT_TYPE | The type of client: Individual (Contact), Organisation, Client Group. |
CONVERSATION_ID | The ID of the thread of emails in which the response email is included. |
CLIENT_OWNER_ID | The identifier of the User Profile who owns the responsibilities of this client. |
CLIENT_OWNER | The name of the User Profile who owns the responsibilities of this client. Defined on the Details tab of the contact. |
CLIENT_MANAGER_ID | The identifier of the User Profile who manages the responsibilities of this client. |
CLIENT_MANAGER | The name of the User Profile who manages the responsibilities of this client. Defined on the Details tab of the contact. |
EMAIL_SUBJECT | The subject line of the response email. |
EMAIL_MESSAGE_ID | The identifier of the response email. |
EMAIL_SENT_BY | The name of user who sent the response email. |
EMAIL_SENT_BY_ID | The identifier of user who sent the response email. |
RESPONSE_TIME_MINUTES | The time (in minutes) it took the user to respond. |
RESPONSE_DATETIME | The timestamp of the response email. |
RESPONSE_DIRECTION | The categorization of response email into "sent" or "received". Sent means the email was sent to the client, received means the email was received by the client. |
EXTERNAL_BALANCE_SHEET__ASSET
This table represents sub-sections of a company's balance sheet listing the assets.
Field | Description |
BALANCE_SHEET_ASSET_ID | Unique key. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
BALANCE_SHEET_ID | ID from unified API for the balance sheet to which this report item belongs. |
EXTERNAL_BALANCE_SHEET_ASSET_ID | Report item's ID in third party system. This column is not a unique key as it can have null values. |
NAME | The report item's name. |
VALUE | The report item's value. |
SUB_ITEMS | A sub item of this report item. |
COMPANY_ID | Company ID in unified API. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_BALANCE_SHEET__EQUITY
This table represents sub-sections of a company's balance sheet listing the equity items.
Field | Description |
BALANCE_SHEET_EQUITY_ID | Unique key. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
BALANCE_SHEET_ID | ID from unified API for the balance sheet to which this report item belongs. |
EXTERNAL_BALANCE_SHEET_EQUITY_ID | Report item's ID in third party system. This column is not a unique key as it can have null values. |
NAME | The report item's name. |
VALUE | The report item's value. |
SUB_ITEMS | A sub item of this report item. |
COMPANY_ID | Company ID in unified API. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_BALANCE_SHEET__LIABILITY
This table represents sub-sections of a company's balance sheet listing the liabilities.
Field | Description |
BALANCE_SHEET_LIABILITY_ID | Unique key. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
BALANCE_SHEET_ID | ID from unified API for the balance sheet to which this report item belongs. |
EXTERNAL_BALANCE_SHEET_LIABILITY_ID | Report item's ID in third party system. This column is not a unique key as it can have null values. |
NAME | The report item's name. |
VALUE | The report item's value. |
SUB_ITEMS | A sub item of this report item. |
COMPANY_ID | Company ID in unified API. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_BALANCE_SHEET
This table contains balance sheets which belong to a company and exist in the third party system.
Field | Description |
EXTERNAL_COMPANY_ID | Company ID in third party system. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
BALANCE_SHEET_ID | Unique key. Object ID in unified API. |
EXTERNAL_BALANCE_SHEET_ID | Object ID in third party system. This column is not a unique key as it can have null values. |
NAME | The report item's name. |
CURRENCY | The currency of the balance sheet |
COMPANY_ID | ID from unified API for company to which this balance sheet belongs. |
DATE | The balance sheet's date. The balance sheet data will reflect the company's financial position at this point in time. |
NET_ASSETS | The balance sheet's net assets. |
REMOTE_GENERATED_AT | The time this object was generated by the accounting system. |
REMOTE_WAS_DELETED | Indicates whether or not this object has been deleted by third party webhooks. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_COMPANY__ADDRESS
This table contains the addresses of contacts or companies in the third party system.
Field | Description |
COMPANY_ADDRESS_ID | Unique key. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
COMPANY_ID | ID from unified API for company to which this information belongs. |
EXTERNAL_COMPANY_ADDRESS_ID | Object ID in third party system. This column is not a unique key as it can have null values. |
STREET_1 | Line 1 of the address's street. |
STREET_2 | Line 2 of the address's street. |
CITY | The address's city. |
STATE | The address's state or region. |
COUNTRY | The address's country. |
COUNTRY_SUBDIVISION | The address's state or region. |
ZIP_CODE | The address's zip code. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_COMPANY__PHONE_NUMBER
This table contains the phone numbers of contacts or companies in the third party system.
Field | Description |
COMPANY_PHONE_NUMBER_ID | Unique key. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
COMPANY_ID | ID from unified API for company to which this information belongs. |
EXTERNAL_COMPANY_PHONE_NUMBER_ID | Object ID in third party system. This column is not a unique key as it can have null values. |
NUMBER | The company's phone number. |
TYPE | The phone number's type. (Ex. “Mobile”) |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_COMPANY
This table represents a company in the third party system. Each company object can have multiple address and phone numbers.
Field | Description |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
COMPANY_ID | Unique key. ID from unified API. |
EXTERNAL_COMPANY_ID | Object ID in third party system. This column is not a unique key as it can have null values. |
NAME | The company's name. |
LEGAL_NAME | The company's legal name. |
TAX_NUMBER | The company's tax number. |
FISCAL_YEAR_END_MONTH | The company's fiscal year end month. |
FISCAL_YEAR_END_DAY | The company's fiscal year end day. |
CURRENCY | The currency set in the company's accounting platform. |
REMOTE_CREATED_AT | When the third party's object was created. |
URLS | The company's urls. |
REMOTE_WAS_DELETED | Indicates whether or not this object has been deleted by third party webhooks. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_CONTACT
This table shows contacts listed in the third party system. Contacts can be either a supplier or a customer.
Field | Description |
EXTERNAL_COMPANY_ID | ID in third party system for company to which this contact belongs. This column is not a unique key as it can have null values. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
CONTACT_ID | Unique key. ID from unified API for contact. |
EXTERNAL_CONTACT_ID | Object ID in third party system. This column is not a unique key as it can have null values. |
NAME | The contact's name. |
IS_SUPPLIER | True or False if the contact is a supplier. |
IS_CUSTOMER | True or False if the contact is a customer. |
EMAIL_ADDRESS | The contact's email address. |
TAX_NUMBER | The contact's tax number. |
STATUS | "The contact's status Possible values include: ACTIVE, ARCHIVED, or - in cases where there is no clear mapping - the original value passed through." |
CURRENCY | The currency the contact's transactions are in. |
REMOTE_UPDATED_AT | When the third party's object was updated. |
COMPANY_ID | ID from unified API for company to which this contact belongs |
REMOTE_WAS_DELETED | Indicates whether or not this object has been deleted by third party webhooks. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_INCOME_STATEMENT__COST_OF_SALES
This table contains cost of sales items within an income statement.
Field | Description |
INCOME_STATEMENT_COST_OF_SALES_ID | Unique key. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
INCOME_STATEMENT_ID | ID from unified API for the income statement to which this report item belongs. |
EXTERNAL_INCOME_STATEMENT_COST_OF_SALES_ID | Report item's ID in third party system. This column is not a unique key as it can have null values. |
NAME | The report item's name. |
VALUE | The report item's value. |
SUB_ITEMS | A sub item of this report item. |
ACCOUNT_ID | Company ID in unified API. |
ACCOUNT_NAME | The tenant's unique identifier to whom this data belongs to. |
EXTERNAL_INCOME_STATEMENT__INCOME
This table contains income items within an income statement.
Field | Description |
INCOME_STATEMENT_INCOME_ID | Unique key. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
INCOME_STATEMENT_ID | ID from unified API for the income statement to which this report item belongs. |
EXTERNAL_INCOME_STATEMENT_INCOME_ID | Report item's ID in third party system. This column is not a unique key as it can have null values. |
NAME | The report item's name. |
VALUE | The report item's value. |
SUB_ITEMS | A sub item of this report item. |
ACCOUNT_ID | Company ID in unified API. |
ACCOUNT_NAME | The tenant's unique identifier to whom this data belongs to. |
EXTERNAL_INCOME_STATEMENT__NON_OPERATING_EXPENSES
This table contains non-operating expense items within an income statement.
Field | Description |
INCOME_STATEMENT_NON_OPERATING_EXPENSES_ID | Unique key. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
INCOME_STATEMENT_ID | ID from unified API for the income statement to which this report item belongs. |
EXTERNAL_INCOME_STATEMENT_NON_OPERATING_EXPENSES_ID | Report item's ID in third party system. This column is not a unique key as it can have null values. |
NAME | The report item's name. |
VALUE | The report item's value. |
SUB_ITEMS | A sub item of this report item. |
ACCOUNT_ID | Company ID in unified API. |
ACCOUNT_NAME | The tenant's unique identifier to whom this data belongs to. |
EXTERNAL_INCOME_STATEMENT__OPERATING_EXPENSES
This table contains operating expense items within an income statement.
Field | Description |
INCOME_STATEMENT_OPERATING_EXPENSES_ID | Unique key. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
INCOME_STATEMENT_ID | ID from unified API for the income statement to which this report item belongs. |
EXTERNAL_INCOME_STATEMENT_OPERATING_EXPENSES_ID | Report item's ID in third party system. This column is not a unique key as it can have null values. |
NAME | The report item's name. |
VALUE | The report item's value. |
SUB_ITEMS | A sub item of this report item. |
ACCOUNT_ID | Company ID in unified API. |
ACCOUNT_NAME | The tenant's unique identifier to whom this data belongs to. |
EXTERNAL_INCOME_STATEMENT
This table contains income statements which belong to a company.
Field | Description |
EXTERNAL_COMPANY_ID | ID in third party system for company to which this object belongs. This column is not a unique key as it can have null values. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
INCOME_STATEMENT_ID | Unique key. |
EXTERNAL_INCOME_STATEMENT_ID | Object ID in third party system. This column is not a unique key as it can have null values. |
NAME | The income statement's name. |
CURRENCY | The income statement's currency. |
COMPANY_ID | ID from unified API for the company to which this object belongs. |
START_PERIOD | The income statement's start period. |
END_PERIOD | The income statement's end period. |
GROSS_PROFIT | The income statement's gross profit. |
NET_OPERATING_INCOME | The income statement's net operating profit. |
NET_INCOME | The income statement's net income. |
REMOTE_WAS_DELETED | Indicates whether or not this object has been deleted by third party webhooks. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_INVOICE__LINE_ITEM
This table contains line items which are the sub-components of an invoice. Line items detail the amounts billed to accounts.
Field | Description |
EXTERNAL_COMPANY_ID | ID in third party system for the company to which this object belongs. This column is not a unique key as it can have null values. |
EXTERNAL_INVOICE_ID | ID in third party system for the invoice to which this object belongs. This column is not a unique key as it can have null values. |
EXTERNAL_LEDGER_ID | ID in third party system for the ledger to which this object belongs. This column is not a unique key as it can have null values. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
INVOICE_LINE_ITEM_ID | Unique key. |
EXTERNAL_INVOICE_LINE_ITEM_ID | Object ID in third party system. This column is not a unique key as it can have null values. |
DESCRIPTION | The line item's description. |
UNIT_PRICE | The line item's unit price. |
QUANTITY | The line item's quantity. |
TOTAL_AMOUNT | The line item's total amount. |
CURRENCY | The object's currency. |
EXCHANGE_RATE | The line item's exchange rate. |
LEDGER_ID | ID from unified API for the ledger to which this object belongs. |
COMPANY_ID | ID from unified API for the company to which this object belongs. |
INVOICE_ID | ID from unified API for the invoice to which this object belongs. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_INVOICE
This table contains invoices to a company. Invoices can have multiple invoices line items.
Field | Description |
EXTERNAL_COMPANY_ID | ID in third party system for the company to which this object belongs. This column is not a unique key as it can have null values. |
EXTERNAL_CONTACT_ID | ID in third party system for the contact to which this object belongs. This column is not a unique key as it can have null values. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
INVOICE_ID | Unique key. |
EXTERNAL_INVOICE_ID | Object ID in third party system. This column is not a unique key as it can have null values. |
TYPE | The invoice's type. Possible values include: ACCOUNTS_RECEIVABLE, ACCOUNTS_PAYABLE, or - in cases where there is no clear mapping - the original value passed through. |
CONTACT_ID | ID from unified API for the contact to which this object belongs. |
NUMBER | The invoice's number. |
ISSUE_DATE | The invoice's issue date. |
DUE_DATE | The invoice's due date. |
PAID_ON_DATE | The invoice's paid date. |
MEMO | The invoice's private note. |
COMPANY_ID | ID from unified API for the company to which this object belongs. |
CURRENCY | The object's currency. |
TOTAL_DISCOUNT | The invoice's total discount. |
SUB_TOTAL | The invoice's sub-total. |
TOTAL_TAX_AMOUNT | The invoice's total tax amount. |
TOTAL_AMOUNT | The invoice's total amount. |
BALANCE | The invoice's remaining balance. |
REMOTE_UPDATED_AT | When the third party's object was updated. |
REMOTE_WAS_DELETED | Indicates whether or not this object has been deleted by third party webhooks. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EXTERNAL_LEDGER
This table contains ledgers which businesses use to track transactions.
Field | Description |
EXTERNAL_COMPANY_ID | ID in third party system for the company to which this object belongs. This column is not a unique key as it can have null values. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
LEDGER_ID | Unique key. |
EXTERNAL_LEDGER_ID | Object ID in third party system. This column is not a unique key as it can have null values. |
LEDGER_NAME | The ledger's name. |
DESCRIPTION | The ledger's description. |
CLASSIFICATION | The ledgers classification. Possible values include: ASSET, EQUITY, EXPENSE, LIABILITY, REVENUE, or - in cases where there is no clear mapping - the original value passed through. |
TYPE | The ledger's type. |
STATUS | The ledgers status. Possible values include: ACTIVE, PENDING, INACTIVE, or - in cases where there is no clear mapping - the original value passed through. |
CURRENT_BALANCE | The ledger's current balance. |
CURRENCY | The object's currency. |
LEDGER_NUMBER | The ledger's number. |
PARENT_LEDGER_ID | ID from unified API for the parent ledger. |
COMPANY_ID | ID from unified API for the company to which this object belongs. |
REMOTE_WAS_DELETED | Indicates whether or not this object has been deleted by third party webhooks. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
DIMN_ORGANIZATION_MEMBER
This table shows the relationships between organizations and people (i.e. contacts)
Field | Description |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
ORGANIZATION | The name of the organization (one of three subtypes of clients.) |
ORGANIZATION_ID | The organization's unique identifier. |
PERSON | The name of an individual (contact) added in Karbon |
PERSON_ID | The individual's (contacts) unique identifer. |
REPORTING_DATE | The date as of which the data is representative of. |
BILLING_ITEM
This table shows the summary of billed items at the invoice line level.
Field | Description |
BILLING_ITEM_ID | The unique identifier for each line of an invoice, billable amount, and billed amount. |
INVOICE_APPROVED_DATE | The date the invoice was approved. |
INVOICE_APPROVED_AT | The timestamp the invoice was approved. |
TIME_ENTRY_ID | The unique identifier for time entries. |
EXPENSE_ID | The unique identifier for expenses. |
BILLING_ITEM_TYPE | The type of the billing item which can be work item, person, organization, client group, time entry, or expense. |
BILLING_TYPE | How this work is billed to the client. Possible values include Fixed Fee, Time and Materials, and Non-billable Fee. |
RECORDED_AND_BILLED_AMOUNT | The amount on invoice, not including adjustments. |
BILLED_AMOUNT | The final amount on invoice. |
INVOICE_NUMBER | The number of the invoice as seen in app. |
INVOICE_ID | The unique identifier for the invoice. |
INVOICE_LINE_ID | The unique identifier for each line item in the invoice. |
INVOICE_STATUS_ID | The corresponding identifier for each of the five invoice statuses. |
INVOICE_STATUS | The status of the invoice. Possible statuses include; Draft, Approved, Awaiting Payment, Paid, Exported, Voided |
IS_BILLED | Current status of the invoice is any status besides Draft or Voided. |
WORK_ITEM_ID | The unique identifier for the work item whose details are being provided. |
WORK_ITEM_TITLE | The title of the work item. |
CLIENT_ID | The unique identifier of the client. |
CREATED_BY_USER_ID | The unique identifier for the user who created the invoice. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
WIP_ITEM
This table is a daily historic record of WIP.
Field | Description |
ENTITY_ID | The unique identifier of the entity |
ENTITY_TYPE | The type of entity. Possible types of entities include work item, client, time entry, and expense. |
WORK_ITEM_ID | The work item's unique identifier assoicated with the WIP. |
WORK_TITLE | The work item's title assoicated with the WIP. |
CLIENT_ID | The client's unique identifier associated with the WIP. |
BILL_TO_CONTACT_ID | The default billing contact's unique identifier. This is customizable to each client in the billing settings. |
CLIENT | The client's name to who the WIP is associate with. |
BILL_TO_CONTACT | The default billing contact's name. This is customizable to each client in the billing settings. |
BILLING_TYPE | The billing type associated with the entity. Possible types include Time and Materials and Fixed Fee. |
TIME_RECORDED_AMOUNT | The total amount for the recorded time on work items or clients that are still in WIP. |
TIME_BILLED_AMOUNT | The amount that was billed on items in WIP, including adjustments (Time Billed Amount = Time Recorded and Billed + Time Write On/Off |
TIME_RECORDED_AND_BILLED_AMOUNT | The amount that was billed on items in WIP, excluding adjustments. |
TIME_ADJUSTMENT_AMOUNT | The amount written on or off on the invoice. |
TIME_WIP_AMOUNT | The difference between the Time Billed and Total Recorded (Time WIP = Time Recorded - Fixed Fee) |
FIXED_FEE_BILLED_AMOUNT | The amount of fixed fees from WIP that is still billable (Fixed Fee Billable = Fixed Fee - Fixed Fee Billed) |
FIXED_FEE_AMOUNT | The total fixed fee for work items in WIP. |
FIXED_FEE_WIP_AMOUNT | The difference between the Fixed Fee and Total Recorded (Fixed Fee WIP = Total Recorded - Fixed Fee) |
EXPENSE_AMOUNT | The total expenses added to work items or clients. |
EXPENSE_BILLED_AMOUNT | The amount of expenses billed, including adjustments. |
EXPENSE_RECORDED_AND_BILLED_AMOUNT | The amount of expense billed, excluding adjustments. |
EXPENSE_WIP_AMOUNT | The total amount of expenses that are still billable to the client for WIP (Expenses Billable WIP = Expenses Amount - Expenses Billed) |
TOTAL_WIP_AMOUNT | The combination of Time WIP, Fixed Fee WIP, and Expense WIP. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |
EFFECTIVE_AS_DATE | Date this table was last extracted from it's source. |
DEFAULT_BILLING_CONTRACT
This table shows the default billing contact for a corresponding entity.
Field | Description |
ENTITY_ID | The unique identifier of the entity |
ENTITY_TYPE | The type of entity. Possible types of entities include person, client group, work item, and organization. |
CONTACT | The name of the client/contact, when applicable. |
WORK_TITLE | The name of the work item, when applicable. |
BILL_TO_CONTACT_ID | The default billing contact's unique identifier. |
BILL_TO_CONTACT_TYPE | The default billing contact's type. |
BILL_TO_CONTACT | The default billing contact's name. |
ACCOUNT_ID | The tenant's unique identifier to whom this data belongs to. |
ACCOUNT_NAME | The tenant's name to whom this data belongs to. |