API Docs / Schemas / ClientDocumentDto

ClientDocumentDto

Represents a document associated with a client, such as letters, engagement letters, proposals, or other correspondence.
Documents are stored in blob storage and accessed via SAS URLs.

Properties

Name Type Description
codestring

The unique code for this document

The unique code for this document

clientCodeAndNameDto
documentTypeenum

EngagementLetters Proposal Misc ProfessionalClearanceLetters

EngagementLetters Proposal Misc ProfessionalClearanceLetters

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

downloadUrlstring

SAS URL for downloading the document (generated on-demand)

SAS URL for downloading the document (generated on-demand)

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

JSON Example

{
  "code": "string",
  "client": {
    "code": "string",
    "name": "string"
  },
  "documentType": "EngagementLetters",
  "title": "string",
  "summary": "string"
}

Used By Operations

Contained in Schemas