backbone-inventory 0.17.2

Inventory: stock ledger of record (SLE) + moving-average valuation; emits COGS/asset AccountingPost (Delivery/Receipt -> GL)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# =============================================================================
# Domain: Inventory
# Entity: PickingBatch (Odoo `stock.picking.batch`)
# =============================================================================
# The picking-batch satellite: a wave/batch document that groups transfers so a
# picker works them as one unit. Membership is one-directional — a transfer
# belongs to at most one batch (`transfers.batch_id`, the membership column the
# verbs on the batch service write).
#
# CRITICAL (spec misc-features.md SB, flag SB-1, ADR-0016): PickingBatch.state
# is a STORED COMPUTE PROJECTED from its member pickings — never a hand-driven
# state machine and has NO state_machines entry anywhere. The projection bands
# onto the member TransferState vocabulary:
#     draft     — any live member still draft/confirmed (not ready to pick)
#     waiting   — every live member at least waiting
#     ready     — every live member at least assigned (the wave can run)
#     done      — every live member done
#     cancel    — no live member remains (all cancelled), OR the batch was
#                 emptied after having had members (SB-1 auto-cancel-empty)
# The engine's picking recompute cascades the batch recompute on every
# member-state change; the membership verbs (add/remove) reproject on every
# membership write. The entity is mounted read_only over HTTP so no generic
# write path can hand-set the projection.
#
# Tenancy: none, by design (ADR-0029). The module is tenant-agnostic; the
# composing service's decorator owns org scoping. A batch and every member
# anchor at one org unit (the decorator's fill stamps the acting unit); the
# same-unit membership check the add verb performs rides the org axis.
# =============================================================================

models:
  # ===========================================================================
  # Entity: PickingBatch — a wave of transfers worked as one unit
  # ===========================================================================
  - name: PickingBatch
    collection: picking_batches
    read_only: true
    description: "A batch/wave of pickings worked as one unit. state is a stored compute projected from its member pickings (SB-1, ADR-0016) — never a hand-driven state machine; the member pickings own the lifecycle"

    fields:
      id:
        type: uuid
        attributes: ["@id", "@default(uuid)"]
        description: "Unique batch identifier"

      name:
        type: string
        attributes: ["@required", "@max(40)", "@default(\"/\")"]
        description: "Reference (sequence-filled; unique per org unit — the R3 posture the transfer carries)"

      note:
        type: string?
        attributes: ["@max(2000)"]
        description: "Free-form notes"

      state:
        type: PickingBatchState
        attributes: ["@default(draft)"]
        lifecycle: projection
        description: "PROJECTED from the member pickings' states (SB-1, ADR-0016): done when every live member is done; ready when every live member is at least assigned; waiting when every live member is at least waiting; draft when any live member is still draft/confirmed; cancel when no live member remains or the batch was emptied after having grouped members. NO per-batch state machine exists — reprojected on every member-state change and every membership write"

      is_wave:
        type: bool
        attributes: ["@default(false)"]
        description: "Marks a wave batch (pick-to-light / zone waves) versus an ordinary batch"

      user_id:
        type: uuid?
        attributes: ["@exclude_from_foreign_key_check"]
        description: "The operator responsible for the batch # logical FK to sapiens.User.id"

      scheduled_date:
        type: datetime
        attributes: ["@default(now)"]
        description: "Scheduled time"

      had_members:
        type: bool
        attributes: ["@default(false)"]
        description: "True once the batch has ever grouped a picking — the SB-1 discriminator: a batch that never grouped anything stays draft when empty, a batch emptied after grouping auto-cancels (set only by the membership write path, never a free write)"


      metadata:
        type: Metadata
        attributes: ["@audit_metadata"]
        description: "Audit metadata"

    relations:
      pickings:
        type: Transfer[]
        attributes: ["@one_to_many"]
        description: "The member pickings — the batch's state projects from these (SB-1)"
        inverse: batch

    indexes:
      - type: index
        fields: [state]
        description: "The projected value is still indexed (hot filter)"
      - type: index
        fields: [user_id]

# =============================================================================
# Enums
# =============================================================================

enums:
  - name: PickingBatchState
    description: "stock.picking.batch.state — a STORED COMPUTE projected from the member pickings' states, never hand-set (SB-1, ADR-0016)"
    variants:
      - name: draft
        description: "Any live member still draft/confirmed (not ready to pick), or the batch groups nothing yet"
        default: true
      - name: waiting
        description: "Every live member at least waiting"
      - name: ready
        description: "Every live member at least assigned (the wave can run)"
      - name: done
        description: "Every live member done"
      - name: cancel
        description: "No live member remains (all cancelled) or the batch was emptied after grouping members (SB-1 auto-cancel-empty)"