> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # SuperOffice.WebApi.Data.DocumentTemplateEntity # Class DocumentTemplateEntity Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\ Assembly: SuperOffice.WebApi.dll Carrier object for DocumentTemplateEntity. The template a document is based on is stored in the SO\_arc\template folder on the server. This will return the name as displayed in the GUI, and not the physical document name, of the template the document object is based on. ```csharp theme={null} public class DocumentTemplateEntity : Carrier ``` #### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Carrier](SuperOffice.WebApi.Data.Carrier.md) ← [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md) #### Inherited Members [Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight), [Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties), [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring), [object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)), [object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)), [object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), [object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode), [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype), [object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone) ## Examples Get DocumentTemplateEntity 123 using the WebApi client:

var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var documentTemplateEntity = agent.GetDocumentTemplateEntity( 123 );

## Constructors ### DocumentTemplateEntity() Default constructor - defaults any enum props to 0. ```csharp theme={null} public DocumentTemplateEntity() ``` ## Properties ### AutoeventId Which document plugin is responsible for the documents generated from this template ```csharp theme={null} public virtual int AutoeventId { get; set; } ``` #### Property Value [int](https://learn.microsoft.com/dotnet/api/system.int32) ### DefaultOref Processed via tag substitution to give document reference ```csharp theme={null} public virtual string DefaultOref { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### Deleted True if deleted ```csharp theme={null} public virtual bool Deleted { get; set; } ``` #### Property Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ### Direction 1 = incoming, 2 = outgoing, see EAppntDirection NULL if unknown enum value. ```csharp theme={null} [JsonIgnore] public DocTmplDirection? Direction { get; set; } ``` #### Property Value [DocTmplDirection](SuperOffice.WebApi.Data.DocTmplDirection.md)? #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[Direction\_String](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_Direction_String) ### Direction\_String 1 = incoming, 2 = outgoing, see EAppntDirection Raw string enum value. ```csharp theme={null} [JsonProperty("Direction")] public string Direction_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[Direction](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_Direction) ### DocumentTemplateId Primary key ```csharp theme={null} public virtual int DocumentTemplateId { get; set; } ``` #### Property Value [int](https://learn.microsoft.com/dotnet/api/system.int32) ### DocumentTypeKey The document type to use when creating a blank document. Plugin-specific. Used when not creating template from a local file. ```csharp theme={null} public virtual int DocumentTypeKey { get; set; } ``` #### Property Value [int](https://learn.microsoft.com/dotnet/api/system.int32) ### EmailSubject Subject to use if document template is an email. ```csharp theme={null} public virtual string EmailSubject { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### Filename Relative to TemplatePath, or extref for other document plugins. i.e URL or full path. ```csharp theme={null} public virtual string Filename { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### IncludeSignature True if the email signature should be added in bottom of mail if this an email template ```csharp theme={null} public virtual bool IncludeSignature { get; set; } ``` #### Property Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ### IntentId What is the intention of this document (used by SAINT) ```csharp theme={null} public virtual int IntentId { get; set; } ``` #### Property Value [int](https://learn.microsoft.com/dotnet/api/system.int32) ### InvitationDocType Type for sending email meeting invitation. Not an invitation type template = 0, New = 1, Changed = 2, Cancelled = 3 NULL if unknown enum value. ```csharp theme={null} [JsonIgnore] public DocTmplInvitationType? InvitationDocType { get; set; } ``` #### Property Value [DocTmplInvitationType](SuperOffice.WebApi.Data.DocTmplInvitationType.md)? #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[InvitationDocType\_String](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_InvitationDocType_String) ### InvitationDocType\_String Type for sending email meeting invitation. Not an invitation type template = 0, New = 1, Changed = 2, Cancelled = 3 Raw string enum value. ```csharp theme={null} [JsonProperty("InvitationDocType")] public string InvitationDocType_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[InvitationDocType](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_InvitationDocType) ### IsDefaultPublished Published to external persons ```csharp theme={null} public virtual bool IsDefaultPublished { get; set; } ``` #### Property Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ### IsInUseInGuides True if the template is in use in a project or sales guide ```csharp theme={null} public virtual bool IsInUseInGuides { get; set; } ``` #### Property Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ### LoadTemplateFromPlugin Which document plugin is responsible for this template's contents ```csharp theme={null} public virtual int LoadTemplateFromPlugin { get; set; } ``` #### Property Value [int](https://learn.microsoft.com/dotnet/api/system.int32) ### MimeType The mime type ```csharp theme={null} public virtual string MimeType { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### Name The template list item ```csharp theme={null} public virtual string Name { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### PrivacyDocType Indicator that this document template has a functional role, related to privacy/GDPR NULL if unknown enum value. ```csharp theme={null} [JsonIgnore] public DocTmplPrivacyType? PrivacyDocType { get; set; } ``` #### Property Value [DocTmplPrivacyType](SuperOffice.WebApi.Data.DocTmplPrivacyType.md)? #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[PrivacyDocType\_String](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_PrivacyDocType_String) ### PrivacyDocType\_String Indicator that this document template has a functional role, related to privacy/GDPR Raw string enum value. ```csharp theme={null} [JsonProperty("PrivacyDocType")] public string PrivacyDocType_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[PrivacyDocType](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_PrivacyDocType) ### QuoteDocType The role this document plays in the Quote system, if any NULL if unknown enum value. ```csharp theme={null} [JsonIgnore] public DocTmplQuoteType? QuoteDocType { get; set; } ``` #### Property Value [DocTmplQuoteType](SuperOffice.WebApi.Data.DocTmplQuoteType.md)? #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[QuoteDocType\_String](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_QuoteDocType_String) ### QuoteDocType\_String The role this document plays in the Quote system, if any Raw string enum value. ```csharp theme={null} [JsonProperty("QuoteDocType")] public string QuoteDocType_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[QuoteDocType](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_QuoteDocType) ### Rank Rank order ```csharp theme={null} public virtual short Rank { get; set; } ``` #### Property Value [short](https://learn.microsoft.com/dotnet/api/system.int16) ### RecordType 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes NULL if unknown enum value. ```csharp theme={null} [JsonIgnore] public DocTmplType? RecordType { get; set; } ``` #### Property Value [DocTmplType](SuperOffice.WebApi.Data.DocTmplType.md)? #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[RecordType\_String](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_RecordType_String) ### RecordType\_String 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes Raw string enum value. ```csharp theme={null} [JsonProperty("RecordType")] public string RecordType_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[RecordType](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_RecordType) ### SaveInDb 1 = save document records in DB; otherwise not. ```csharp theme={null} public virtual short SaveInDb { get; set; } ``` #### Property Value [short](https://learn.microsoft.com/dotnet/api/system.int16) ### SenderEmailAddress If email template, default senderaddress when template is of type quote email or privacy email. ```csharp theme={null} public virtual string SenderEmailAddress { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### SenderEmailMode If email template, when DocType is Privacy or quote email, it is possible to make sender address like our contact, or our support contact, or always one address NULL if unknown enum value. ```csharp theme={null} [JsonIgnore] public SenderMailMode? SenderEmailMode { get; set; } ``` #### Property Value [SenderMailMode](SuperOffice.WebApi.Data.SenderMailMode.md)? #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[SenderEmailMode\_String](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_SenderEmailMode_String) ### SenderEmailMode\_String If email template, when DocType is Privacy or quote email, it is possible to make sender address like our contact, or our support contact, or always one address Raw string enum value. ```csharp theme={null} [JsonProperty("SenderEmailMode")] public string SenderEmailMode_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [DocumentTemplateEntity](SuperOffice.WebApi.Data.DocumentTemplateEntity.md).[SenderEmailMode](SuperOffice.WebApi.Data.DocumentTemplateEntity.md#SuperOffice_WebApi_Data_DocumentTemplateEntity_SenderEmailMode) ### ShowCurrents True if when using this template there should be shown a place for editing current choices of person, compant, sale, project etc ```csharp theme={null} public virtual bool ShowCurrents { get; set; } ``` #### Property Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ###