API Docs / Schemas / ClientDocumentDto

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
codestring

The unique code for this document

The unique code for this document

clientCodeAndNameDto
categoryCodeAndNameDto
titlestring

The title of the document

The title of the document

summarystring

A brief summary or description of the document

A brief summary or description of the document

datestring

The date the document is dated (not the creation date)

The date the document is dated (not the creation date)

originalFileNamestring

Original file name provided during upload

Original file name provided during upload

contentTypestring

MIME type of the document (e.g., application/pdf)

MIME type of the document (e.g., application/pdf)

fileSizeinteger

File size in bytes

File size in bytes

storageTypeenum

AzureBlob External

AzureBlob External

reviewStatusenum

Approved PendingReview Rejected

Approved PendingReview Rejected

uploadedByContactCodeAndNameDto
reviewedByUserCodeAndNameDto
reviewedDatestring

When this document was reviewed

When this document was reviewed

clientApprovalStatusenum

None Pending Approved Rejected

None Pending Approved Rejected

clientApprovalRequestedByUserCodeAndNameDto
clientApprovalRequestedDatestring

When client approval was requested

When client approval was requested

clientApprovalNotestring

Note provided by the client when approving or rejecting

Note provided by the client when approving or rejecting

clientApprovalContactCodeAndNameDto
clientApprovalDatestring

When the client approved or rejected this document

When the client approved or rejected this document

clientApprovalIpAddressstring

IP address of the client who approved or rejected this document

IP address of the client who approved or rejected this document

downloadUrlstring

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.

createdDatestring

When the document record was created in the system

When the document record was created in the system

updatedDatestring

When the document record was last updated

When the document record was last updated

documentRequestCodeAndNameDto

JSON Example

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

Used By Operations

Contained in Schemas