Collect a business unit’s documents in a new batch

Purpose

Finance staff establish a batch in which one business unit’s daily documents can collect before posting.

How It Works

Staff choose a business unit, supply a name and select the accounting date. Optional description and automatic-close information accompany the request. Rhythm establishes the fiscal context from the selected date. The creation response identifies the new Open batch. Staff can then use it for document intake. A conflicting name, unsuitable period or reserved system type prevents creation and gives staff a correction to make.

Relationships

Related outcome: Correct batch details before posting, which addresses the connected batch work.
Related outcome: Arrange automatic close and posting, which addresses the connected batch work.
Related outcome: Advance a scheduled stream and post its predecessor, which addresses the connected batch work.

Show evidence (sources, provenance, origins, pinned commits)

The Formal Contract

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

Outcomes: Staff receive an identified collection in the appropriate unit and fiscal context.
Surfaces: consoleapi
Preconditions: The selected business unit has a fiscal calendar covering the requested date.
Postconditions: Creation leaves an Open batch available for eligible document intake.
Constraints: The unit’s configuration reference excludes hyphens, preserving an unambiguous prefix on generated batch references.
Intent sources: services-accounting:docs/migrations/transaction-processing/batches/README.md#Status as actions (job tp-batch-lifecycle, Andrew's UI brief of 2026-10-15)services-accounting:docs/migrations/transaction-processing/batches/README.md#D14 and migration 0060 (Andrew, 2026-10-16)

Controls

20 controls apply, from the corpus control catalogue.

TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-IAM-006 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-006 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-TEN-004 TC-DAT-001 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-003 TC-PI-005

Permissions

Key	Checked at	Scope
`accounting.batches.create`	api	tenant

Business Rules

10 rules, 10 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

Id	Rule	Kind	Enforced at	Provenance
`01`must prove Proposed	Creation through the ordinary API starts a batch in Open and rejects any supplied status. ✓ A request with unit, date and name returns an Open batch.✗ Supplying Closed during creation fails without a write. origin: services-accounting:docs/migrations/transaction-processing/batches/README.md#Status as actions (Andrew's UI brief of 2026-10-15) proved by `ATS-ACC-BAT-001-01`, `ATS-ACC-BAT-001-11`, `ATS-ACC-BAT-001-12`, `ATS-ACC-BAT-001-13`, `ATS-ACC-BAT-003-11`, `ATS-ACC-BAT-005-06`, `ATS-ACC-BAT-008-06`, `TST-ACC-BAT-060`	validation	api	test services-accounting:modules/batches/tests/e2e/batches.e2e.spec.js#refuses a create naming the status 400: a new batch is always open
`02`must prove Proposed	Within a business unit, each batch name belongs to one batch; another unit can use the same name. ✓ Different units can both use the name Daily.✗ Reusing Daily within the same unit fails. origin: services-accounting:docs/migrations/transaction-processing/batches/README.md#D14 and migration 0060 (Andrew, 2026-10-16) proved by `ATS-ACC-BAT-001-02`, `ATS-ACC-BAT-001-14`, `ATS-ACC-BAT-010-09`, `TST-ACC-BAT-064`, `TST-ACC-BAT-085`	validation	service, database	test services-accounting:modules/batches/tests/integration/services/persistence/batches.integration.spec.js#refuses a name another batch of the unit has 409, name_in_use, in 1.0’s sentence (D14)
`03`must prove Proposed	The date determines the fiscal year and period, replacing submitted fiscal values and refusing dates outside the unit’s fiscal calendar. ✓ An October date derives the October fiscal context.✗ A date beyond all configured fiscal years fails. proved by `ATS-ACC-BAT-001-03`, `TST-ACC-BAT-085`	calculation	service	test services-accounting:modules/batches/tests/integration/services/persistence/batches.integration.spec.js#refuses a date no fiscal year of the unit holds
`04`must prove Proposed	A new batch cannot use a date in a period that is not open, and the refusal identifies that period without duplicating its name. ✓ An Open October period accepts a batch dated within it.✗ A February date fails once that fiscal period is closed. proved by `ATS-ACC-BAT-001-04`, `TST-ACC-BAT-006`, `TST-ACC-BAT-085`, `TST-ACC-BAT-122`	validation	service	test services-accounting:modules/batches/tests/integration/services/persistence/batches.integration.spec.js#refuses a date in a closed period
`05`must prove Proposed	Creation fills an omitted currency with the unit’s base currency and rejects a different currency. proved by `ATS-ACC-BAT-001-05`, `TST-ACC-BAT-085`	validation	service	test services-accounting:modules/batches/tests/integration/services/persistence/batches.integration.spec.js#refuses a currency other than the unit’s base currency
`06`must prove Proposed	A batch name must contain at least one non-space character. proved by `ATS-ACC-BAT-001-06`, `TST-ACC-BAT-060`	validation	api, database, console	test services-accounting:modules/batches/tests/e2e/batches.e2e.spec.js#refuses a create without a name 400, naming the field
`07`must prove Proposed	An automatically assigned batch reference begins with the business unit’s reference, and an existing reference cannot be assigned to a second batch. proved by `ATS-ACC-BAT-001-07`, `TST-ACC-BAT-085`	validation	service	test services-accounting:modules/batches/tests/integration/services/persistence/batches.integration.spec.js#refuses an id already in use
`08`must prove Proposed	Staff creation allows transaction and legacy types, while deferred revenue and cost of goods sold types belong to fiscal close. proved by `ATS-ACC-BAT-001-08`, `TST-ACC-BAT-063`, `TST-ACC-BAT-134`	policy	service	observed services-accounting:modules/batches/aws/api/batches.schemas.ts:batchRequestSchema; services-accounting:modules/batches/services/rules/batch-rules.ts:assertNotSystemType
`09`must prove Proposed	The caller needs batch-create permission to create a batch. proved by `ATS-ACC-BAT-001-09`, `TST-ACC-BAT-027`, `TST-ACC-BAT-060`	permission	api, console	test services-accounting:modules/batches/tests/e2e/batches.e2e.spec.js#refuses a create to a caller without accounting.batches.create 403
`10`must prove Proposed	Creation uses the authorized workspace and rejects a body naming another workspace. proved by `ATS-ACC-BAT-001-10`, `TST-ACC-BAT-028`, `TST-ACC-BAT-060`	validation	api	test services-accounting:modules/batches/tests/e2e/batches.e2e.spec.js#refuses a create naming another tenant in the body 400

Scenarios

Id	Given	When	Then	Provenance
`01`	The association’s October period is Open and its base currency is US dollars.	Staff submit an October receivables batch dated the twentieth.	The response shows an empty Open batch in the October period and base currency.	test services-accounting:modules/batches/tests/e2e/batches.e2e.spec.js#creates the batch: 200, an id of faa’s prefix, the fiscal period of today, faa’s base currency, open
`02`	The unit already holds a batch named Daily.	Staff submit another Daily batch in that unit.	Creation refuses the duplicate name without adding a batch.	test services-accounting:modules/batches/tests/e2e/batch-actions.e2e.spec.js#refuses a create whose name another batch of the unit has 409, name_in_use, in 1.0’s sentence
`03`	The association’s February period has closed.	Staff request a batch dated in mid-February.	The refusal identifies the closed period, while a request dated in a current Open period succeeds.	documented services-accounting:docs/milestones/walkthroughs/ACCT-M3-handoff.md#Start here (step 8)

Planning

Implementation

Collect a business unit’s documents in a new batch ​

Purpose ​

How It Works ​

Relationships ​