Dispatch the FS portal link
Who does this: FS Reviewer · Senior Accountant · Platform Admin When: The DOCX is ready and you want the client approver to sign off (or request revision) before publication. Result: A
PortalInvitationrow, a magic-link email in the client's inbox, and an activity-log entry.
Before you start
- [ ] Engagement at
NOTES_COMPLETEwith at least one DOCX export (see Export the DOCX). - [ ] Client has at least one active contact with
canApprove = true. - [ ] You hold
MANAGE_FS_ENGAGEMENT.
Steps
- Open the engagement detail page.
- Click Send to client for review.
- Pick the approver contact from the dropdown (only contacts with
canApprove = trueappear). - Submit. The handler creates a
PortalInvitationwith 30-day expiry and enqueues the outbound email.
How to know it worked
- One email in Mailpit (dev) or the client's inbox, subject Financial statements ready for review: {Legal Name} {Financial Year}.
- The activity log shows
fs.client.review_requested. - The engagement detail page shows the outstanding invitation with the expiry timestamp.
Common situations
| If you see… | It means… | What to do |
|---|---|---|
400 reason: "no_approver_contact" | The client has no canApprove = true contact | Open the client → Contacts; add one |
| Email didn't arrive | Mail delivery issue | Check Outbox; resend if stuck. See Verify an email was sent |
| Magic link expired before the client opened it | 30 days passed | Re-dispatch; the previous invitation is invalidated |