Flow
ServicesOnboarding Service

Onboarding will manage property drafts and consumer handoff

The planned service will support property-scoped draft worksheets, one-way consumer handoff, and read-only onboarding records.

Onboarding will accept CSV files in a common format agreed with the building and own the editable draft inputs. Property-authorized accountants and service-owner users will correct those inputs through worksheets, then publish a reviewed snapshot. Once the property is onboarded, its onboarding data becomes read-only.

Domain
Services
Kind
Go HTTP service
Lifecycle
Planned
flowctl project
None
Stacks
Runs on its own

Planning only

The service has an implementation plan. It has no runtime, migrations, deployed endpoints, or worksheet UI yet. The current direction is onboarding-owned draft inputs with one-way distribution. Exact schemas and consumer contracts still need review with each owning team.

Implementation plan

The complete proposal lives in services/onboarding/IMPLEMENTATION_PLAN.md. It covers:

  • Common CSV contracts, source provenance, service ownership, and tables still to be built.
  • Onboarding-owned drafts, atomic cross-sheet saves, and transactional-outbox events.
  • Validation, review, immutable publication, partial delivery, and recovery.
  • Property-scoped RBAC, GET-only consumer APIs, read-only completion, milestones, and tests.

The plan includes Mermaid diagrams for the architecture and the draft-to-read-only lifecycle. They show where a local save ends, asynchronous consumer processing begins, and the final edit lock applies.

Onboarding saves input changes and outgoing facts in one local transaction. Consumers process them independently and own their operational records; receiving a draft does not authorize live business effects. Consumer writes never flow back into the worksheet. Cross-service acceptance remains asynchronous, not one global transaction.

The integration surface is GET-only. Authenticated UI-serving commands are still needed for worksheet/import changes, with server-enforced property roles and lifecycle checks. No edit or reopen path exists after the property is onboarded.

Frontend plan

services/onboarding/FRONTEND_PLAN.md describes the planned worksheet app, import wizard, atomic saves, conflict resolution, property RBAC, review/publication, completed read-only mode, accessibility, and FE milestones. It follows the Flow frontend seed, theme, and layered component conventions.

See services/onboarding/README.md for the directory's current status and platform architecture for the binding service and transaction boundaries.

On this page