Outstanding counts for each kind of item on the Requests page, in one call.
Every count is null when the caller's role cannot read that area, rather than zero:
zero means "nothing outstanding", null means "not yours to see". Callers rendering
these as tiles should hide a null rather than show a dash.
Properties
| Name | Type | Description |
|---|---|---|
| readyToSend | integer | Manual-mode workflow steps assigned to the calling user and ready to send. |
Manual-mode workflow steps assigned to the calling user and ready to send. | ||
| scheduled | integer | Pending scheduled sends (Scheduled and Failed), scoped to the send types the caller can manage |
Pending scheduled sends (Scheduled and Failed), scoped to the send types the caller can manage | ||
| formsAwaitingResponse | integer | Data form requests sent and not yet responded to |
Data form requests sent and not yet responded to | ||
| documentApprovalsPending | integer | Documents sent for client approval and still awaiting a decision |
Documents sent for client approval and still awaiting a decision | ||
| documentRequestsOpen | integer | Document requests still open with the client |
Document requests still open with the client | ||
| documentRequestsSubmitted | integer | Document requests the client has submitted, waiting on the practice to accept or reject |
Document requests the client has submitted, waiting on the practice to accept or reject | ||
| confirmationsOpen | integer | Client confirmations sent and not yet confirmed |
Client confirmations sent and not yet confirmed | ||
JSON Example
{
"readyToSend": 0,
"scheduled": 0,
"formsAwaitingResponse": 0,
"documentApprovalsPending": 0,
"documentRequestsOpen": 0
}