DesignThemeDto
Complete visual styling and branding configuration for generated documents (proposals, engagement letters, reports, etc.).
Defines typography, colors, layout, headers, footers, and custom CSS to ensure consistent professional branding.
Design themes can be applied to document templates to control the appearance of generated PDFs and HTML documents.
Properties
| Name | Type | Description |
|---|---|---|
| code | string | Unique identifier for the design theme |
Unique identifier for the design theme | ||
| name | string | Display name for the theme (e.g., "Professional Blue", "Corporate Standard") |
Display name for the theme (e.g., "Professional Blue", "Corporate Standard") | ||
| isDefault | boolean | Whether this is the default theme for the tenant. Only one theme per tenant should be marked as default. |
Whether this is the default theme for the tenant. Only one theme per tenant should be marked as default. | ||
| heading1 | FontSettingsDto | |
| heading2 | FontSettingsDto | |
| heading3 | FontSettingsDto | |
| body | FontSettingsDto | |
| tableHeader | FontSettingsDto | |
| tableCell | FontSettingsDto | |
| logoUrl | string | URL to the company logo image (used in document headers) |
URL to the company logo image (used in document headers) | ||
| primaryColor | string | Primary brand color in hex format (used for main headings and borders) |
Primary brand color in hex format (used for main headings and borders) | ||
| secondaryColor | string | Secondary brand color in hex format (used for subheadings) |
Secondary brand color in hex format (used for subheadings) | ||
| accentColor | string | Accent color in hex format (used for highlights and calls to action) |
Accent color in hex format (used for highlights and calls to action) | ||
| pageMargins | MarginsDto | |
| showPageNumbers | boolean | Whether to display page numbers at the bottom of document pages |
Whether to display page numbers at the bottom of document pages | ||
| headerTextContentBlock | CodeAndNameDto | |
| footerContentBlock | CodeAndNameDto | |
| footerRepeatOnEveryPage | boolean | Whether the footer should appear on every page or just the last page |
Whether the footer should appear on every page or just the last page | ||
| customCSS | string | Additional custom CSS rules for advanced styling beyond the standard options |
Additional custom CSS rules for advanced styling beyond the standard options | ||
| createdDate | string | When this theme was created |
When this theme was created | ||
| updatedDate | string | When this theme was last updated |
When this theme was last updated | ||
JSON Example
{
"code": "string",
"name": "string",
"isDefault": false,
"heading1": {
"fontFamily": "string",
"fontSize": 0,
"color": "string",
"bold": false,
"italic": false
},
"heading2": {
"fontFamily": "string",
"fontSize": 0,
"color": "string",
"bold": false,
"italic": false
}
}