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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

# =============================================================================
# Domain: Inventory
# Entity: Location (Odoo `stock.location`)
# =============================================================================
# Hierarchical stock location (supplier / view / internal / customer /
# inventory / production / transit). The spatial atom every quant, move and
# move line keys off. `usage` drives stock semantics: only `internal` holds
# on-hand stock; `view` is a grouping node that can never hold stock
# (guard R13); `inventory` is the scrap/adjustment sink; `transit` is the
# inter-unit holding pen.
#
# Tree shape: self-referential `location_id` parent + materialized
# `parent_path` (`_parent_store` in Odoo). The `_parent_path_id_idx
# (parent_path, id)` index is load-bearing for subtree walks and is
# preserved verbatim (spec flag: verbatim partial indexes).
#
# Tenancy: none, by design (ADR-0029). The module is tenant-agnostic; the
# composing service's decorator owns org scoping. Shared root locations
# (the virtual supplier/customer trees) anchor at the tenant ROOT under
# allow_root and every entitled scope sees them through the scope union; a
# location anchored at a regular unit is that unit's private location.
# =============================================================================

models:
  - name: Location
    collection: locations
    description: "A hierarchical stock location; usage drives stock semantics (only internal holds on-hand stock; view cannot hold stock)"

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

      name:
        type: string
        attributes: ["@required", "@max(150)"]
        description: "Location label"

      complete_name:
        type: string
        attributes: ["@max(500)"]
        description: "Full path including parents (recursive stored compute; recomputed on any parent/name change — trigger T8)"

      active:
        type: bool
        attributes: ["@default(true)"]
        description: "Archive support"

      usage:
        type: LocationUsage
        attributes: ["@required", "@default(internal)"]
        description: "Location kind; only internal holds on-hand stock, view is a grouping node (guard R13 rejects quants on view locations)"

      location_id:
        type: uuid?
        attributes: ["@foreign_key(Location.id)"]
        description: "Parent location (self-referential tree); null = root"

      parent_path:
        type: string
        attributes: ["@max(1000)"]
        description: "Materialized path of the location tree — load-bearing for subtree walks (index _parent_path_id_idx preserved verbatim)"

      barcode:
        type: string?
        attributes: ["@max(64)"]
        description: "Scannable barcode (unique per org unit — guard R4)"


      warehouse_id:
        type: uuid?
        attributes: ["@foreign_key(Warehouse.id)"]
        description: "The warehouse this location belongs to (derived from the tree; kept as a stored column)"

      cyclic_inventory_frequency:
        type: int
        attributes: ["@default(0)"]
        description: "Frequency in days for cyclic inventory checks (0 = off)"

      last_inventory_date:
        type: date?
        description: "Last actual inventory date at this location (readonly)"

      next_inventory_date:
        type: date?
        description: "Next planned count (last_inventory_date + cyclic_inventory_frequency)"

      valuation_account_id:
        type: uuid?
        attributes: ["@exclude_from_foreign_key_check"]
        description: "Per-location valuation account override — when set, inventory GL legs that touch this location resolve to it ahead of the door-header account (smallest-first override: location beats document header) # logical FK to accounting.Account.id"

      storage_category_id:
        type: uuid?
        attributes: ["@foreign_key(StorageCategory.id)"]
        description: "Storage-category capacity constraint — the source a putaway rule's T12 derived copy reads"

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

    indexes:
      - type: index
        name: _parent_path_id_idx
        fields: [parent_path, id]
        description: "Verbatim _parent_path_id_idx — parent_store hierarchy walks (spec flag: verbatim partial indexes)"
      - type: index
        fields: [location_id]
        description: "Parent lookup"
      - type: index
        fields: [usage]
        description: "Internal-location filtering"
      - type: index
        fields: [warehouse_id]
      - type: index
        fields: [storage_category_id]
        description: "Storage-capacity joins (the T12 derivation source)"

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

enums:
  - name: LocationUsage
    description: "stock.location.usage — only internal holds on-hand stock; view is a grouping node"
    variants:
      - name: supplier
        description: "Vendor location (virtual; goods enter from here on receipt)"
      - name: view
        description: "View — grouping node, can never hold stock"
      - name: internal
        description: "Internal location — holds on-hand stock"
        default: true
      - name: customer
        description: "Customer location (virtual; goods leave to here on delivery)"
      - name: inventory
        description: "Inventory loss — the scrap/adjustment sink"
      - name: production
        description: "Production (WIP)"
      - name: transit
        description: "Transit — inter-unit holding"