DataFormRequestDto

A form request sent to a client

Properties

Name	Type	Description
code	string	The unique code for this form request
The unique code for this form request
dataForm	CodeAndNameDto
client	CodeAndNameDto
status	enum	PendingResponse ResponseReceived
PendingResponse ResponseReceived
submittedAt	string	The date and time the client submitted their answers, if submitted
The date and time the client submitted their answers, if submitted
submittedByEmail	string	Email address of the recipient who submitted (from magic link token).
Email address of the recipient who submitted (from magic link token).
notifyUser	CodeAndNameDto
autoAcceptData	boolean	When true, submitted data is automatically accepted and copied to the client record without manual review
When true, submitted data is automatically accepted and copied to the client record without manual review
message	string	A message from the sender explaining what the client needs to do
A message from the sender explaining what the client needs to do
sentToEmails	array of string	The email addresses the form notification was sent to
The email addresses the form notification was sent to
sentAt	string	When the notification email was sent
When the notification email was sent
magicLinkToken	string	The magic link token for this request. Only populated on detail responses for pending requests.
The magic link token for this request. Only populated on detail responses for pending requests.
answers	array of DataFormAnswerDto	The submitted answers. Only populated on detail (GetByCode) responses.
The submitted answers. Only populated on detail (GetByCode) responses.
pendingReviewCount	integer	Number of answers still awaiting review (ReviewStatus = Pending)
Number of answers still awaiting review (ReviewStatus = Pending)
task	CodeAndNameDto
createdDate	string	The date and time this request was created (i.e. sent to the client)
The date and time this request was created (i.e. sent to the client)

JSON Example

{
  "code": "string",
  "dataForm": {
    "code": "string",
    "name": "string"
  },
  "client": {
    "code": "string",
    "name": "string"
  },
  "status": "PendingResponse",
  "submittedAt": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas

DataFormRequestDtoPagedResult