Rhythm 2.0 Specifications

Appearance

JNY-BIL-BIL-001An administrator reviews a dues-reminder run and follows up on refusals

Markdown

JNY-BIL-BIL-001

An administrator reviews a dues-reminder run and follows up on refusals

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationPartially observed

Planning

Feature
FEAT-BIL-BIL-02
Actor
ACT-BIL-001
Capabilities
CAP-BIL-BIL-002, CAP-BIL-BIL-001, CAP-BIL-BIL-003, CAP-BIL-BIL-004, CAP-BIL-BIL-005, CAP-BIL-BIL-008, CAP-BIL-BIL-009, CAP-BIL-BIL-006
Rules in play
BR-CAP-BIL-BIL-002-03, BR-CAP-BIL-BIL-002-09, BR-CAP-BIL-BIL-001-03, BR-CAP-BIL-BIL-003-02, BR-CAP-BIL-BIL-003-08, BR-CAP-BIL-BIL-004-05, BR-CAP-BIL-BIL-004-06, BR-CAP-BIL-BIL-005-01, BR-CAP-BIL-BIL-005-02, BR-CAP-BIL-BIL-009-02, BR-CAP-BIL-BIL-009-03, BR-CAP-BIL-BIL-009-04, BR-CAP-BIL-BIL-009-06, BR-CAP-BIL-BIL-006-03, BR-CAP-BIL-BIL-008-01

KindJourneyProduct areaBillingModuleBillingRevision1End-to-endRequired

Read atservices-accounting f47cb263react-console baf6dae3

An administrator reviews a dues-reminder run and follows up on refusals ​

Story ​

A finance administrator prepares a reminder for members with outstanding dues. Before starting, they inspect the named recipients and exclude members already contacted personally. The finished run records which reminders were requested and which members could not be reached. A missing e-mail address gives the team a reason to follow up another way. The administrator currently assigns the message template through the API, and must not rely on the monitor to display every update.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Goal
Send dues reminders to members selected by a saved query, review recipients before starting, and identify successful requests and refusals afterward.
Screens
/console/{tenantId}/configuration/notices/console/{tenantId}/configuration/billingTemplates/console/{tenantId}/accounting/billing/runs/new/console/{tenantId}/accounting/billing/runs/{runId}/console/{tenantId}/accounting/billing/runs

Steps

#SurfaceActionCapabilityExpectedProvenance
1createBillingNoticeSave an active notice through the API and assign its published message template. The console has no template selector.CAP-BIL-BIL-002An active notice is available.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0420.spec.ts#ACT-ACC-0420
2/console/{tenantId}/configuration/billingTemplatesSave a billing template that sends the notice to contacts selected by a saved query.CAP-BIL-BIL-001The business unit has a saved billing template.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0420.spec.ts#ACT-ACC-0420
3/console/{tenantId}/accounting/billing/runs/newChoose the template and today’s billing date, inspect the estimate, and request preparation.CAP-BIL-BIL-003The estimated population is displayed and preparation starts.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0420.spec.ts#ACT-ACC-0420
4/console/{tenantId}/accounting/billing/runs/{runId}Inspect the prepared member list and exclude recipients who should receive no reminder.CAP-BIL-BIL-004The ready run displays names and immediately reflects exclusions.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0427.spec.ts#ACT-ACC-0427
5/console/{tenantId}/accounting/billing/runs/{runId}Confirm that the reviewed run should start.CAP-BIL-BIL-005Execution begins under the identity of the person starting it.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0420.spec.ts#ACT-ACC-0420
6/console/{tenantId}/accounting/billing/runs/{runId}Follow progress and individual results in the monitor.CAP-BIL-BIL-008The desired monitor displays progress, settled recipients and refusals through completion; reliable delivery of those updates remains unproved.unknown
FND-BIL-BIL-033
7e-mail (test mailbox)Inspect the test mailbox for reminders to reachable members.CAP-BIL-BIL-009Each reachable member has one message rendered from the notice template.test
react-console:acceptance/accounting/playwright/journeys/cross-application/ACT-ACC-0809.spec.ts#ACT-ACC-0809
8/console/{tenantId}/accounting/billing/runsOpen the completed run and inspect its totals and refusals.CAP-BIL-BIL-006Completion records successful and refused members, including refusal reasons.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0420.spec.ts#ACT-ACC-0420

Alternate and Failure Paths

PathFrom stepConditionPath takenOutcomeProvenance
alternate4The membership team edits the saved query after the run is prepared.Refresh the prepared population before execution.Existing exclusions survive; new matches appear and former matches become ineligible. Execution uses the refreshed, reviewed population.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0427.spec.ts#ACT-ACC-0427
alternate2The notice targets organizations through specified affiliation roles.Resolve the organization’s primary contacts for the selected roles.Organizations without eligible recipients have named refusals; completion groups errors by reason.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0433.spec.ts#ACT-ACC-0433
failure1A notice is saved without a message template because the console offers no selector.Refuse each affected record with guidance to assign the missing template.No reminders are requested. The administrator assigns a template before creating another run.test
services-accounting:modules/billing/tests/integration/services/billing-runs/execute-billing-run.integration.spec.js#rejects every item communication_not_ready (no_template), saying to choose the notice’s template
failure3The creator cannot read the saved query or its contacts.End preparation with the access error returned by Platform.The run fails without creating items.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0451.spec.ts#ACT-ACC-0451

Assertions

IdStatementProvenance
01The selected message template produces one reminder for each reachable member.test
react-console:acceptance/accounting/playwright/journeys/cross-application/ACT-ACC-0809.spec.ts#ACT-ACC-0809
02A member without an e-mail address has a corresponding refusal, and the run finishes with errors.test
react-console:acceptance/accounting/playwright/journeys/cross-application/ACT-ACC-0809.spec.ts#ACT-ACC-0809
03Excluded members receive no reminder; the recorded outcomes reconcile with run totals.test
react-console:acceptance/accounting/playwright/journeys/billing/ACT-ACC-0427.spec.ts#ACT-ACC-0427

End-to-end policy: required: Browser coverage must exercise configuration, preparation, review, execution and message receipt together. The missing notice-template selector and unreliable live updates prevent the console path from being treated as complete.

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software