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 | ||
| downloadUrl | string | URL for downloading/viewing the document. |
URL for downloading/viewing the document. | ||
| 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 | ||
| documentRequest | CodeAndNameDto | |
JSON Example
{
"code": "string",
"client": {
"code": "string",
"name": "string"
},
"category": {
"code": "string",
"name": "string"
},
"title": "string",
"summary": "string"
}
Used By Operations
-
POST
Upload Document to Request
/tenants/{tenant}/clients/{client}/documentrequest/{code}/documents
-
POST
Create Document for Client
/tenants/{tenant}/clients/{client}/clientdocument
-
GET
Get Document for Client
/tenants/{tenant}/clients/{client}/clientdocument/{code}
-
PUT
Update Document for Client
/tenants/{tenant}/clients/{client}/clientdocument/{code}
-
PUT
Review Document
/tenants/{tenant}/clients/{client}/clientdocument/{code}/review
-
PUT
Request Client Approval
/tenants/{tenant}/clients/{client}/clientdocument/{code}/request-approval
-
PUT
Cancel Client Approval Request
/tenants/{tenant}/clients/{client}/clientdocument/{code}/cancel-approval