PDF document appearance
The logo, colors, and page format that a company uses on the PDF documents it issues.
- API name:
documentsettings - Domain: Features
- Modules: Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Font | font | Constant | Yes | Fixed option from the allowed set for this field. |
| Page size | pageSize | Constant | Yes | Fixed option from the allowed set for this field. |
| Primary color | primaryColor | Hex Color | Yes | |
| Secondary color | secondaryColor | Hex Color | Yes | Watermark color on draft documents. |
| Table header fill opacity | tableHeaderFillOpacity | Percent | Yes | Rate expressed as a percent of a base amount. |
| Watermark fill opacity | watermarkFillOpacity | Percent | Yes | Rate expressed as a percent of a base amount. |
| Logo | logo | Image | ||
| Symbol | symbol | Image | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
Actions
What you can do with a record. Every action also sends the webhook event documentsettings.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new document appearance. | App · API · CLI |
| Edit | update | Save changes to this document appearance. | App · API · CLI |
| Delete | delete | Delete this document appearance and the data that belongs with it. This cannot be undone. | App · API · CLI |