ClientDocumentApprovalDto
The client's sign-off on a document: whether it was asked for, how it was asked for, who
answered and what they said, plus the chase schedule while it is outstanding.
Always present — SodiumHQ.DTOs.ClientDocument.ClientDocumentApprovalDto.Status is None for a document never sent for approval. Not to
be confused with the document's ReviewStatus, which is the practice's own internal check.
Properties
| Name | Type | Description |
|---|---|---|
| status | enum | None Pending Approved Rejected |
None Pending Approved Rejected | ||
| method | enum | Portal ESignature |
Portal ESignature | ||
| requestedByUser | CodeAndNameDto | |
| requestedDate | string | When client approval was requested |
When client approval was requested | ||
| contact | CodeAndNameDto | |
| string | Email address of the recipient who approved or rejected (from magic link token). | |
Email address of the recipient who approved or rejected (from magic link token). | ||
| date | string | When the client approved or rejected this document |
When the client approved or rejected this document | ||
| note | string | Note provided by the client when approving or rejecting |
Note provided by the client when approving or rejecting | ||
| ipAddress | string | IP address of the client who approved or rejected this document |
IP address of the client who approved or rejected this document | ||
| batchCode | string | Code of the approval batch this document was sent in, if any. Present for historic batches |
Code of the approval batch this document was sent in, if any. Present for historic batches | ||
| batchStatus | enum | Pending Approved Rejected Cancelled |
Pending Approved Rejected Cancelled | ||
| signature | ClientDocumentSignatureDto | |
| chase | ChaseScheduleDto | |
JSON Example
{
"status": "None",
"method": "Portal",
"requestedByUser": {
"code": "string",
"name": "string"
},
"requestedDate": "2024-01-01T00:00:00Z",
"contact": {
"code": "string",
"name": "string"
}
}