DocumentRequestDto
Response DTO for a document request
Properties
| Name | Type | Description |
|---|---|---|
| code | string | Unique code for this document request |
Unique code for this document request | ||
| client | CodeAndNameDto | |
| title | string | Title describing what documents are needed |
Title describing what documents are needed | ||
| description | string | Detailed description of what is needed |
Detailed description of what is needed | ||
| status | enum | Draft Open Submitted Accepted Rejected |
Draft Open Submitted Accepted Rejected | ||
| deadline | string | Optional deadline for the client to respond by |
Optional deadline for the client to respond by | ||
| documentCount | integer | Number of documents attached to this request |
Number of documents attached to this request | ||
| notifyUser | CodeAndNameDto | |
| createdByUser | CodeAndNameDto | |
| task | CodeAndNameDto | |
| createdDate | string | When the request was created |
When the request was created | ||
| updatedDate | string | When the request was last updated |
When the request was last updated | ||
JSON Example
{
"code": "string",
"client": {
"code": "string",
"name": "string"
},
"title": "string",
"description": "string",
"status": "Draft"
}
Used By Operations
-
POST
Create Document Request
/tenants/{tenant}/clients/{client}/documentrequest
-
GET
Get Document Request for Client
/tenants/{tenant}/clients/{client}/documentrequest/{code}
-
PUT
Update Document Request for Client
/tenants/{tenant}/clients/{client}/documentrequest/{code}
-
PUT
Open Document Request
/tenants/{tenant}/clients/{client}/documentrequest/{code}/open