IntroductionBefore you beginTerminologyGetting startedGroupsFilesFoldersTemplatesEmail templatesAppsErrors
Authorization
Accounts
User accounts
Introduction
An entity is a real world object. In SmartVault, many of these entities will be related to accounting.
Entities exist only on structured plans and its hierarchy can be browsed using the path /nodes/entity for entities themselves and /nodes/entity-definition for the entities definition. This path allows the service to provide display and behavioral information about entities, primarily for client use.
You can find a correspondence between the entity name and its name in the API nomenclature in the "SmartVault entities" table below.
SmartVault entities
FirmSmartVault.Accounting.Firm
ClientSmartVault.Accounting.Client
Tax engagementSmartVault.Accounting.TaxEngagement
Sales tax engagementSmartVault.Accounting.SalesTaxEngagement
Payroll engagementSmartVault.Accounting.PayrollEngagement
Wealth management engagementSmartVault.Accounting.WealthManagementEngagement
Financial services engagementSmartVault.Accounting.FinancialServicesEngagement
Investment engagementSmartVault.Accounting.InvestmentEngagement
User associationSmartVault.Core.UserAssociation
Simple entitySmartVault.Core.SimpleEntity
Internal documentsSmartVault.Core.InternalDocuments
Public documentsSmartVault.Core.PublicDocuments
Role associationSmartVault.Core.RoleAssociation
EngagementSmartVault.Core.Engagement
General annual engagementSmartVault.Core.GeneralAnnualEngagement
Entity relationships associate entities with each other.
For example, an employee will have a firm to employee relationship with the firm he is a member of.
Client relationship
Client tax engagementSmartVault.Accounting.ClientTaxEngagement
Client sales tax engagementSmartVault.Accounting.ClientSalesTaxEngagement
Client payroll engagementSmartVault.Accounting.ClientPayrollEngagement
Client wealth management engagementSmartVault.Accounting.ClientWealthManagementEngagement
Client financial services engagementSmartVault.Accounting.ClientFinancialServicesEngagement
Client investment engagementSmartVault.Accounting.ClientInvestmentEngagement
Client general annual engagementSmartVault.Core.ClientGeneralAnnualEngagement
Entity relationship example: Firm
Firm relationship
Firm clientSmartVault.Accounting.FirmClient
Firm to employeeSmartVault.Accounting.FirmToEmployee
Firm to internal documentsSmartVault.Accounting.FirmToInternalDocuments