Status workflow and timeline

Move a case to Documents received

Documents are ready for review. The guide then takes you through the correct route, the checks to complete before making changes, the workflow in order, and the evidence to review afterwards.

Audience: CRM staffPermission: Edit Licence ApplicationsModule v1.0.0
Jump to steps
Where to goAdmin Area → Licence Applications → Case → Update Status
Before you start
  • Use the exact navigation above and confirm the intended invoice, case, client, property, document or environment.
  • Verify module activation and the stated permission before attempting the action.
  • Use a controlled test record for payments, emails, public/portal access, provider calls and deletion.

What you’ll accomplish

Documents are ready for review. These instructions follow the supplied module’s live hooks, menus, controllers, forms, model rules and downstream effects.

Follow these steps

  1. Go to the intended case.
  2. In Update Status, select Documents received.
  3. Enter a clear status note suitable for the landlord timeline.
  4. Submit.
  5. Check the status label and action-required badge.

Fields and options to review

Status keydocuments_received
Landlord action requiredNo
Final statusNo
Category/help-centre/category/licence-applications/
Topic/help-centre/topic/licence-applications-status-timeline/

Rules the system enforces

  • The installed status key is documents_received.
  • Landlord action required becomes 0.
  • This seeded status is not marked final, so it does not by itself set completed_at.

How to confirm it worked

  • Move a case to Documents received completes through the supplied module flow.
  • Reopen the source record or settings page and verify the stored value, status, payment, file, timeline entry or notification.

Security, privacy and operational checks

  • Use the least-privilege account that has the stated permission.
  • Use a controlled test record before applying provider, financial, public-link, email or destructive actions in production.