> ## 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.TemplateVariablesParameters

# <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters" /> Class TemplateVariablesParameters

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for TemplateVariablesParameters.
Parameters specifying source and properties for template variable substitution.

```csharp theme={null}
public class TemplateVariablesParameters : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[TemplateVariablesParameters](SuperOffice.WebApi.Data.TemplateVariablesParameters.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)

## Constructors

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters__ctor" /> TemplateVariablesParameters()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public TemplateVariablesParameters()
```

## Properties

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_AppointmentId" /> AppointmentId

Identifier for an appointment

```csharp theme={null}
public virtual int AppointmentId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_ContactId" /> ContactId

Identifier for a contact

```csharp theme={null}
public virtual int ContactId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_CultureName" /> CultureName

Name of culture to be used for culture-sensitive data, such as dates or multi-language texts. Use a blank string to accept current culture that is set on the server.

```csharp theme={null}
public virtual string CultureName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_CustomTags" /> CustomTags

Array with custom tags and values. Array may be of unlimited height, but need to be exactly 2 in width.

```csharp theme={null}
public virtual string[][] CustomTags { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)\[]\[]

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_DocumentEntity" /> DocumentEntity

Custom document entity to use for data retrieval. Useful for unsaved data.  DocumentEntity.DocumentId need to match the DocumentId specified in separate property.

```csharp theme={null}
public virtual DocumentEntity DocumentEntity { get; set; }
```

#### Property Value

[DocumentEntity](SuperOffice.WebApi.Data.DocumentEntity.md)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_DocumentId" /> DocumentId

Identifier for a document

```csharp theme={null}
public virtual int DocumentId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_Encoding" /> Encoding

Encoding of source string. Non-text formats such as MsWord or Excel should be Base64 encoded in the source string.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public GeneratorEncoding? Encoding { get; set; }
```

#### Property Value

[GeneratorEncoding](SuperOffice.WebApi.Data.GeneratorEncoding.md)?

#### See Also

[TemplateVariablesParameters](SuperOffice.WebApi.Data.TemplateVariablesParameters.md).[Encoding\_String](SuperOffice.WebApi.Data.TemplateVariablesParameters.md#SuperOffice_WebApi_Data_TemplateVariablesParameters_Encoding_String)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_Encoding_String" /> Encoding\_String

Encoding of source string. Non-text formats such as MsWord or Excel should be Base64 encoded in the source string.
Raw string enum value.

```csharp theme={null}
[JsonProperty("Encoding")]
public string Encoding_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[TemplateVariablesParameters](SuperOffice.WebApi.Data.TemplateVariablesParameters.md).[Encoding](SuperOffice.WebApi.Data.TemplateVariablesParameters.md#SuperOffice_WebApi_Data_TemplateVariablesParameters_Encoding)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_PersonId" /> PersonId

Identifier for a person

```csharp theme={null}
public virtual int PersonId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_ProductKey" /> ProductKey

Product key

```csharp theme={null}
public virtual string ProductKey { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_ProjectId" /> ProjectId

Identifier for a project

```csharp theme={null}
public virtual int ProjectId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_QuoteAlternativeId" /> QuoteAlternativeId

Quote alternative id

```csharp theme={null}
public virtual int QuoteAlternativeId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_QuoteLineId" /> QuoteLineId

Quote line id

```csharp theme={null}
public virtual int QuoteLineId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_SaleId" /> SaleId

Identifier for a sale

```csharp theme={null}
public virtual int SaleId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_SelectionId" /> SelectionId

Identifier for a selection

```csharp theme={null}
public virtual int SelectionId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_SourceInput" /> SourceInput

Source string to parse for template variables. Such variables must have delimiters corresponding to the standard for the given generator encoding.Non-text source data (such as the binary content of a .doc file) should be passed in as Base64.

```csharp theme={null}
public virtual string SourceInput { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_TemplateVariablesParameters_TicketId" /> TicketId

Identifier for ticket

```csharp theme={null}
public virtual int TicketId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

## See Also

[DocumentAgent](SuperOffice.WebApi.Agents.DocumentAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.Document SubstituteTemplateVariablesExRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Document_SubstituteTemplateVariablesExRequest.md)
- [SuperOffice.WebApi.Agents.DocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DocumentAgent.md)
- [SuperOffice.WebApi.Agents.IDocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IDocumentAgent.md)
- [SuperOffice.WebApi.Data.ExtAppEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ExtAppEntity.md)
- [SuperOffice.WebApi.Data.Document SubstituteTemplateVariablesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Document_SubstituteTemplateVariablesRequest.md)
- [SuperOffice.WebApi.Data.Document SubstituteMergeDocumentTemplateVariablesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Document_SubstituteMergeDocumentTemplateVariablesRequest.md)