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).

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)
originalFileName	string	Original file name provided during upload
Original file name provided during upload
contentType	string	MIME type of the document (e.g., application/pdf)
MIME type of the document (e.g., application/pdf)
fileSize	integer	File size in bytes
File size in bytes
storageType	enum	AzureBlob External
AzureBlob External
reviewStatus	enum	Approved PendingReview Rejected
Approved PendingReview Rejected
uploadedByContact	CodeAndNameDto
reviewedByUser	CodeAndNameDto
reviewedDate	string	When this document was reviewed
When this document was reviewed
clientApprovalStatus	enum	None Pending Approved Rejected
None Pending Approved Rejected
clientApprovalRequestedByUser	CodeAndNameDto
clientApprovalRequestedDate	string	When client approval was requested
When client approval was requested
clientApprovalNote	string	Note provided by the client when approving or rejecting
Note provided by the client when approving or rejecting
clientApprovalContact	CodeAndNameDto
clientApprovalDate	string	When the client approved or rejected this document
When the client approved or rejected this document
clientApprovalIpAddress	string	IP address of the client who approved or rejected this document
IP address of the client who approved or rejected this document
clientApprovalEmail	string	Email address of the recipient who approved or rejected (from magic link token).
Email address of the recipient who approved or rejected (from magic link token).
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.
downloadUrl	string	URL for downloading/viewing the document. For Azure Blob: a time-limited SAS URL. For External: a link to the file in the external platform.
URL for downloading/viewing the document. For Azure Blob: a time-limited SAS URL. For External: a link to the file in the external platform.
portalFolderPath	string	Folder path controlling where this document appears in the client portal. Format: "folderId:FolderName/folderId:FolderName". Null for root-level documents.
Folder path controlling where this document appears in the client portal. Format: "folderId:FolderName/folderId:FolderName". 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
lastChasedDate	string	When this document approval was last chased. Null if never chased.
When this document approval was last chased. Null if never chased.
chaseFrequencyDays	integer	How often (in days) this document approval is chased. Null means chasing is disabled.
How often (in days) this document approval is chased. Null means chasing is disabled.
nextChaseDate	string	When this document approval is next due for chasing.
When this document approval is next due for chasing.
documentRequest	CodeAndNameDto
task	CodeAndNameDto
taskCategory	CodeAndNameDto

JSON Example

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

Used By Operations

Contained in Schemas

ClientDocumentDtoPagedResult
ClientDocumentPortalViewResult Paginated list of client documents with portal folder navigation, as seen by the client. Used by the...
DocumentRequestDetailDto Detailed response DTO for a document request, including documents and responses