API Docs / Schemas / DocumentRequestDetailDto

DocumentRequestDetailDto

Detailed response DTO for a document request, including documents and responses

Properties

Name Type Description
codestring

Unique code for this document request

Unique code for this document request

clientCodeAndNameDto
titlestring

Title describing what documents are needed

Title describing what documents are needed

descriptionstring

Detailed description of what is needed

Detailed description of what is needed

statusenum

Draft Open Submitted Accepted Rejected

Draft Open Submitted Accepted Rejected

deadlinestring

Optional deadline for the client to respond by

Optional deadline for the client to respond by

documentCountinteger

Number of documents attached to this request

Number of documents attached to this request

notifyUserCodeAndNameDto
createdByUserCodeAndNameDto
taskCodeAndNameDto
taskCategoryCodeAndNameDto
createdDatestring

When the request was created

When the request was created

updatedDatestring

When the request was last updated

When the request was last updated

lastChasedDatestring

When this request was last chased. Null if never chased.

When this request was last chased. Null if never chased.

chaseFrequencyDaysinteger

How often (in days) this request is chased. Null means chasing is disabled.

How often (in days) this request is chased. Null means chasing is disabled.

nextChaseDatestring

When this request is next due for chasing.

When this request is next due for chasing.

documentsarray of ClientDocumentDto

Documents attached to this request

Documents attached to this request

responsesarray of DocumentRequestResponseDto

Submission responses for this request

Submission responses for this request

JSON Example

{
  "code": "string",
  "client": {
    "code": "string",
    "name": "string"
  },
  "title": "string",
  "description": "string",
  "status": "Draft"
}

Used By Operations