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) | ||
| backgroundColor | string | Optional page background color in hex format. When null, no background-color is applied. |
Optional page background color in hex format. When null, no background-color is applied. | ||
| linkColor | string | Optional link color in hex format. When null, links inherit default text color. |
Optional link color in hex format. When null, links inherit default text color. | ||
| linkHoverColor | string | Optional link hover color in hex format. When null, no hover color change. |
Optional link hover color in hex format. When null, no hover color change. | ||
| primaryButton | ButtonStyleDto | |
| secondaryButton | ButtonStyleDto | |
| navBackgroundColor | string | Navigation background color for the client portal (e.g., "#1e293b") |
Navigation background color for the client portal (e.g., "#1e293b") | ||
| navTextColor | string | Navigation text color for the client portal |
Navigation text color for the client portal | ||
| navActiveBackgroundColor | string | Active navigation item highlight color (supports rgba, e.g., "rgba(255,255,255,0.15)") |
Active navigation item highlight color (supports rgba, e.g., "rgba(255,255,255,0.15)") | ||
| navActiveTextColor | string | Active navigation item text color |
Active navigation item text color | ||
| cardBackgroundColor | string | Card/panel background color in the content area |
Card/panel background color in the content area | ||
| borderRadius | integer | Global corner radius in pixels for cards, buttons, and inputs |
Global corner radius in pixels for cards, buttons, and inputs | ||
| navFontSize | number | Font size in points for the client portal navigation bar. Null falls back to body font size. |
Font size in points for the client portal navigation bar. Null falls back to body font size. | ||
| faviconUrl | string | URL to a tenant-specific favicon for the client portal |
URL to a tenant-specific favicon for the client portal | ||
| pageMargins | MarginsDto | |
| headerTextContentBlock | CodeAndNameDto | |
| footerContentBlock | CodeAndNameDto | |
| 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": "...",
"fontSize": 0,
"color": "string",
"bold": false,
"italic": false
},
"heading2": {
"fontFamily": "...",
"fontSize": 0,
"color": "string",
"bold": false,
"italic": false
}
}