ClientDocumentDto

Represents a document associated with a client, such as letters, engagement letters, proposals, or other correspondence.
Documents may be stored in blob storage or an external platform (e.g., Google Drive).

The two things a document is "waiting on" are deliberately separate objects: SodiumHQ.DTOs.ClientDocument.ClientDocumentDto.File
for the bytes, and SodiumHQ.DTOs.ClientDocument.ClientDocumentDto.Approval for the client's sign-off. The practice's own internal
check stays at the top level as ReviewStatus — it is a different vocabulary from the client's
approval and the two are easily confused when they sit side by side.

Properties

Name	Type	Description
code	string	The unique code for this document
The unique code for this document
client	CodeAndNameDto
category	CodeAndNameDto
title	string	The title of the document
The title of the document
summary	string	A brief summary or description of the document
A brief summary or description of the document
date	string	The date the document is dated (not the creation date)
The date the document is dated (not the creation date)
file	ClientDocumentFileDto
approval	ClientDocumentApprovalDto
reviewStatus	enum	Approved PendingReview Rejected
Approved PendingReview Rejected
uploadedByContact	CodeAndNameDto
reviewedByUser	CodeAndNameDto
reviewedDate	string	When this document was reviewed
When this document was reviewed
visibleInClientPortal	boolean	Whether this document is visible to the client in the portal. Does not affect visibility in external storage providers — only controls portal access.
Whether this document is visible to the client in the portal. Does not affect visibility in external storage providers — only controls portal access.
portalFolderPath	string	Folder path controlling where this document appears in the client portal. Format: "/" separated folder names, e.g. "Tax Returns/2026". Null for root-level documents.
Folder path controlling where this document appears in the client portal. Format: "/" separated folder names, e.g. "Tax Returns/2026". Null for root-level documents.
createdDate	string	When the document record was created in the system
When the document record was created in the system
updatedDate	string	When the document record was last updated
When the document record was last updated
clientNotifiedDate	string	When the client was last notified about this document. Null if never notified.
When the client was last notified about this document. Null if never notified.
clientNotifiedByUser	CodeAndNameDto
documentRequest	CodeAndNameDto
task	CodeAndNameDto
taskCategory	CodeAndNameDto

JSON Example

{
  "code": "string",
  "client": {
    "code": "string",
    "name": "string"
  },
  "category": {
    "code": "string",
    "name": "string"
  },
  "title": "string",
  "summary": "string"
}

ClientDocumentDto

Properties

JSON Example

Used By Operations

Contained in Schemas