Understand the records connecting property work and company accounts.
131 tables · 836 relationships
Properties, RoomTypes, Rooms, PMSConnections, PMSMappings, GuestReferences, PMSReservations, PMSStaySegments, PMSRoomAssignments, PMSRequests, PMSAvailabilitySnapshots.
RoomRestrictions, RoomDiscrepancies, HousekeepingPlans, HousekeepingTasks, HousekeepingInspections.
Products, UnitsOfMeasure, ProductUnits, BOMs, BOMLines, ProductionRoutings, RoutingOperations, WorkOrders, WorkOrderMaterials, WorkOrderOperations, ProductionEntries, ProductionCompletions, WorkOrderCostEntries, BatchMaterialAllocations, BatchReconciliations, ShelfLifePolicies, LotDateEvents, KitchenCheckPlans, KitchenCheckCriteria, KitchenChecks, KitchenCheckResults, KitchenHolds, KitchenDispositions.
Suppliers, SupplierBankAccounts, Requisitions, RequisitionLines, PurchaseOrders, PurchaseOrderLines, GoodsReceipts, GoodsReceiptLines, ReceiptAcceptances, BillMatches.
Warehouses, Locations, Lots, LotPortions, Serials, InventoryPositions, StockLayers, StockEvents, StockMovements, InventoryReservations, StockTransfers, StockTransferLines, CountLocks, InventoryCounts, CountLines, Returns, ReturnLines, ReturnDispositions, PropertyDepartments, DepartmentUses, DepartmentUseLines.
Accounts, ContactPersons, PaymentTerms, PriceLists, PriceListEntries, Quotes, QuoteLines, SalesOrders, SalesOrderLines, SalesAllocations, CreditReviews, PickTasks, Shipments, ShipmentLines, DeliveryConfirmations, PMSFolios, PMSLedgerEntries.
Entities, Currencies, ExchangeRates, AccountingPeriods, ChartOfAccounts, TaxCodes, StandardCosts, PostingProfiles, Invoices, InvoiceLines, Bills, BillLines, CashReceipts, CashApplications, CreditApplications, Refunds, FinanceCorrections, BankAccounts, BankStatementLines, PaymentRuns, Payments, PaymentAllocations, RevaluationRuns, RevaluationLines, JournalEntries, JournalLines, CloseTasks, PMSFinancialBatches, PMSFinancialComponents, PMSBalanceSources, PMSBalanceAllocations, PMSTenderSettlements, PMSTenderAllocations, PMSReconciliations.
Users, HospitalityPolicies, MasterChanges, DocumentRevisions, ApprovalDecisions, AuthorityDelegations, IntegrationEvents, IntegrationDeliveries, MigrationBatches, MigrationItems.
A property room number, guest name or folio label is not a universal key. PMS references retain the connection, property and external object or event identity. Source versions and content hashes distinguish a repeated message from a changed fact. Conflicting or incomplete updates remain visible until the authoritative source is reconciled.
Reservations and stay segments describe PMS facts. Housekeeping records describe actual local work and inspection. Cleaning does not itself change occupancy, and an authoritative occupancy change cannot erase a local restriction or discrepancy. Each decision applies to its exact current source and actual person.
PMS ledger detail retains its external financial identity. The reviewed bridge owns its one local journal effect, with guest, deposit, corporate and tender-clearing sources kept distinct. Local goods invoices and cash applications own a separate route. A summary, component and local invoice cannot all post the same sale.
Stock and production references preserve original quantity and carrying through current positions, layers and exclusive claims. Department transfers retain stock; actual use consumes its own remaining source. Partial lots, returns and work in progress keep their original history rather than reviving a depleted balance.
Ends with: Create legal companies, properties, departments and source connections with approved authority. Map rooms, guest references and financial source codes. Review products, units, recipes, accounts and currency bases before importing dependent work.
Ends with: Bring forward current PMS reservations, stay segments, room assignments and ledger references with their original identities. Preserve room restrictions, completed and unfinished housekeeping, source event versions and prior consumed or posted scope. Missing predecessor history remains unresolved.
Ends with: Reconcile stock, lot/date evidence, issued production work and local open finance alongside external guest, deposit, corporate and tender-clearing balances. Finance approves one company opening ledger at the cutoff; imported detail explains that opening without creating another posting.
Ends with: Confirm the next booking request, room turnover, receipt, production completion and financial bridge event use only their eligible remaining source. Reconcile duplicate, late and uncertain outcomes before enabling the wider scope. Historical imports must not repeat work already performed.
| Field | Type | Required | Details |
|---|---|---|---|
UserKey | text | yes | Stable provider/subject and actual-person identity; two accounts of one person are not independent. |
DisplayName | text | yes | Internal display name. |
ActorType | select | yes | Human, Service |
Status | select | yes | Active, Suspended, Disabled |
Roles | longtext | yes | Subset of the twelve declared roles: Admin, Front Desk Coordinator, Property Manager, Housekeeping Attendant, Housekeeping Supervisor, Kitchen Operator, Kitchen Manager, Purchasing Manager, Warehouse Operator, Warehouse Manager, Accountant, Finance Manager. Current actual-person/entity/property/action authority applies; services never approve human gates. |
EntityScope | longtext | yes | Explicit Entities keys; current scope checked on every read/action/export. |
WarehouseScope | longtext | Explicit permitted Warehouses; absent does not mean global access. | |
ExpiresAt | datetime | Scope expiry. | |
ScopeChange | reference | → MasterChanges. Independent domain-reviewed grant of roles/entities/warehouse scope; Admin cannot self-grant business authority. Revocation may restrict immediately. | |
PropertyScope | longtext | yes | Explicit permitted Properties and purpose/task scope; absent is no access. Room/task workers see service instructions only, not full guest identity, folios or finance. |
| Field | Type | Required | Details |
|---|---|---|---|
EntityCode | text | yes | Unique legal entity code. |
Name | text | yes | Legal name. |
FunctionalCurrency | reference | yes | → Currencies. One functional currency; changing it requires separately scoped migration. |
Timezone | text | yes | IANA business timezone; timestamps retain offsets. |
Status | select | yes | Setup, Active, Closed |
Policy | reference | → HospitalityPolicies. Approved active entity policy. |
| Field | Type | Required | Details |
|---|---|---|---|
Code | text | yes | Unique currency code. |
DecimalPlaces | number | yes | Nonnegative permitted precision. |
Status | select | yes | Active, Inactive |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
FromCurrency | reference | yes | → Currencies. Source currency. |
ToCurrency | reference | yes | → Currencies. Target currency, including authority-limit conversion pairs. |
RateDate | date | yes | Business effective date. |
RateType | select | yes | Transaction, Settlement, Closing, Authority |
Multiplier | decimal | yes | Strictly positive; target amount = source × multiplier. Identity conversion is 1. |
Source | text | yes | Approved provider/manual evidence identifier. |
Status | select | yes | Draft, Approved, Superseded |
ApprovedBy | reference | → Users. Independent Finance Manager; never the preparer/editor. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
ApprovedAt | datetime | Actual confirmation time. Absent until the real action; mandatory before the corresponding active/approved/posted state. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
PeriodCode | text | yes | Unique within entity. |
StartDate | date | yes | Inclusive posting date. |
EndDate | date | yes | Inclusive posting date; nonoverlap. |
Status | select | yes | Open, SoftClosed, Closed |
ClosedAt | datetime | Actual hard-close time. | |
Decision | reference | → ApprovalDecisions. Independent Finance Manager close/reopen decision and cutoff evidence. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
AccountCode | text | yes | Unique within entity. |
Name | text | yes | Account label. |
Type | select | yes | Asset, Liability, Equity, Revenue, Expense |
ControlKind | select | yes | None, AR, AP, Inventory, WIP, GRNI, Bank, UnappliedCustomer, UnappliedSupplier, CustomerCredit, SupplierCredit, Tax, PMSGuest, PMSCorporate, PMSDeposit, PMSTender |
Status | select | yes | Draft, Active, Inactive |
Activation | reference | → MasterChanges. Independent Finance Manager activation; direct journals cannot bypass subledger controls. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Code | text | yes | Unique effective code/version. |
RatePercent | decimal | yes | Explicit nonnegative percentage, divided by 100 exactly once. |
Treatment | select | yes | AdditiveSales, RecoverablePurchase, NonrecoverablePurchase, Exempt |
EffectiveFrom | date | yes | Inclusive. |
EffectiveTo | date | Exclusive. | |
Evidence | longtext | yes | Jurisdiction, taxable basis/exemption evidence and configured calculation boundary. |
PostingAccount | reference | yes | → ChartOfAccounts. Correct tax control/expense treatment; nonrecoverable purchase follows approved cost policy. |
Status | select | yes | Draft, Active, Superseded |
Activation | reference | → MasterChanges. Independent Finance Manager decision. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
TermsCode | text | yes | Unique terms version. |
DueDays | number | yes | Nonnegative days from invoice date, using explicit business-date convention. |
Status | select | yes | Draft, Active, Inactive |
Activation | reference | → MasterChanges. Independent Finance Manager review. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
PolicyNumber | text | yes | Unique policy version. |
Status | select | yes | Draft, PendingApproval, Active, Superseded |
EffectiveFrom | datetime | yes | Inclusive activation boundary; no retroactive unreviewed change. |
EffectiveTo | datetime | Exclusive. | |
AuthorityCurrency | reference | yes | → Currencies. Currency of finite approval/credit/count limits. |
Rules | longtext | yes | Validated finite entity/warehouse/action/person limits, current source snapshots, recipe/input-unit scaling, held-owned valuation, quality/date/population rules, selected standard costs, accepted net prices and conservative unknown-state handling. Technical privilege never grants product/financial release. |
CountQuantityTolerance | decimal | yes | Nonnegative base-quantity absolute threshold by configured unit/product class; dimensionally incompatible quantities are never summed. |
CountPercentTolerance | decimal | yes | Nonnegative percentage; expected zero gives unavailable percentage and review. |
CountValueThreshold | decimal | yes | Nonnegative functional-value escalation threshold; unknown value is not zero. |
ShipmentTitleRule | select | yes | Handover. Actual verified customer handover/pickup or carrier dispatch owns stock/COGS once; invoice, label printing, quality release and payment do not. |
PreparedBy | reference | yes | → Users. Admin prepares configuration; respective Property Manager, Purchasing Manager, Warehouse Manager, Kitchen Manager and Finance Manager decisions exclude material preparers/editors. |
OperationalDecision | reference | → ApprovalDecisions. Independent Warehouse Manager decision for operational rules. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
FinanceDecision | reference | → ApprovalDecisions. Independent Finance Manager decision for finance/cost/authority rules. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
ProductionDecision | reference | → ApprovalDecisions. Independent Kitchen Manager recipe/routing/actual work, safe-use and terminal-output rules. | |
CommercialDecision | reference | → ApprovalDecisions. Independent Property Manager customer/price/minimum-life/contact-authority rules; Kitchen Manager separately approves product/date/quality implications. | |
QualityDecision | reference | → ApprovalDecisions. Independent Kitchen Manager required kitchen checks, portion/date/fitness rules, excluding policy/criteria preparers and material editors. | |
KitchenRules | longtext | yes | Required kitchen provenance/checks, actual identifiable partial populations, overlapping holds, immutable lot-date inheritance and safe-use/remaining-life rules. No factory withdrawal, artwork or full QMS module. |
PMSRules | longtext | yes | Exact PMS object/financial authority, routine/protected request classification, source ordering/coverage, protected guest access, financial routes and direct-bank evidence policy. Independent Property Manager and Finance Manager activation. |
HousekeepingRules | longtext | yes | Actual service obligation dedup, access preferences, cleaning-independent inspection, overlapping restrictions and stale readiness. Independent Housekeeping Supervisor plus Property Manager protected restriction policy approval. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
ChangeNumber | text | yes | Unique change request. |
TargetTable | text | yes | Existing allowed master table. |
TargetKey | text | yes | Exact immutable record/version key. |
Status | select | yes | Draft, Submitted, Approved, Applied, Rejected, Cancelled |
BeforeHash | text | yes | Expected prior content or explicit create marker. |
ProposedContent | longtext | yes | Exact after-content and affected transactions. |
ProposedHash | text | yes | Frozen proposed content. |
PreparedBy | reference | yes | → Users. Actual person. |
SubmittedAt | datetime | Actual submission time. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
Decision | reference | → ApprovalDecisions. Independent affected owners: Property Manager property/customer/PMS operational policy; Housekeeping Supervisor task/inspection policy; Kitchen Manager recipe/fitness/date rules; Purchasing Manager supplier commercial; Warehouse Manager stock/custody; Finance Manager money/tax/FX/PMS financial mapping. Required decisions share one proposed hash and exclude material preparers. | |
AppliedAt | datetime | Guarded application; changes do not rewrite accepted or posted source snapshots. | |
OperationalDecision | reference | → ApprovalDecisions. Independent Warehouse Manager for stock/location/fulfillment; production technical changes need their separate Kitchen Manager decision. | |
FinanceDecision | reference | → ApprovalDecisions. Required independent Finance Manager for costs/limits/beneficiary/tax/posting/price-floor changes. | |
CommercialDecision | reference | → ApprovalDecisions. Required independent Property Manager for customer/price commercial changes. | |
ProductionDecision | reference | → ApprovalDecisions. Independent Kitchen Manager for BOM/routing/execution changes. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
RevisionNumber | text | yes | Unique target/revision key. |
TargetTable | text | yes | Exact allowed existing table name, validated against source record. |
TargetKey | text | yes | Exact immutable primary identifier. |
Revision | number | yes | Monotonic revision. |
Status | select | yes | Submitted, Approved, Accepted, Posted, Superseded, Cancelled |
ContentHash | text | yes | Canonical body/lines/source/rates/cost/tax hash. |
Content | longtext | yes | Complete frozen content, material editor person IDs, related source versions and scoped allocations. |
PreparedBy | reference | yes | → Users. Actual preparer. |
FrozenAt | datetime | yes | Actual freeze time. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
DecisionNumber | text | yes | Unique decision identity. |
Action | select | yes | MasterActivation, PolicyActivation, QuoteException, OrderAcceptance, CreditException, PurchaseApproval, InvoiceApproval, BillException, PaymentRelease, Refund, FinanceCorrection, StockRelease, TransferApproval, CountAdjustment, ReturnAuthorization, ReturnDisposition, ShipmentRelease, ProductionRelease, ProductionTimeAcceptance, ProductionCompletion, ProductionVariance, ProductionClose, ProductionCloseFinance, QualityRelease, QualityDisposition, DateApproval, DateReassessment, JournalApproval, RevaluationApproval, PeriodClose, PeriodReopen, MigrationActivation, PropertyRequest, RoomReadiness, RoomRestrictionRelease, PMSBridge, PMSTenderSettlement, PMSReconciliation, DepartmentUse, KitchenFitness |
Status | select | yes | Pending, Approved, Rejected, Expired, Superseded |
Snapshot | reference | → DocumentRevisions. Required for revisioned transaction actions; master/policy request content hash otherwise retained in Scope. | |
Scope | longtext | yes | Exact source/action/revision, entity/property/room/warehouse/portion, quantity/value/currency, applicable dates and excluded actual contributors. Default excludes preparer/material editors and relevant producer/receiver/inspector. RoomReadiness specifically excludes actual cleaners and TASK preparers/editors, but permits the independent supervisor inspector to record and sign their own inspection; no exception for inspecting own cleaning. Technical authority never substitutes for finance or PMS outcome. |
RequestedBy | reference | yes | → Users. Actual preparer/requester. |
RequestedAt | datetime | yes | Actual time. |
DecidedBy | reference | → Users. Actual independent human with declared required role, current scope and limit. Service/Admin privilege is not domain approval. | |
DecidedAt | datetime | Actual decision time. | |
Delegation | reference | → AuthorityDelegations. Valid named delegate, preserving required role and actual-person independence. | |
AuthorityRate | reference | → ExchangeRates. Exact currency conversion for limit test; no missing-rate fallback. | |
AuthorityAmount | decimal | Amount in delegated/role authority currency; cumulative relevant commitment and gross increases included. | |
Reason | longtext | yes | Decision rationale, rejected conditions and reviewed evidence. |
AssignedTo | reference | yes | → Users. Named eligible human reviewer when Pending; independence and current role/limit rechecked at decision. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
DelegationNumber | text | yes | Unique authority grant. |
Principal | reference | yes | → Users. Original authorized human. |
Delegate | reference | yes | → Users. Different actual human already holding required declared role. |
RequiredRole | select | yes | Property Manager, Purchasing Manager, Warehouse Manager, Finance Manager |
ActionScope | longtext | yes | Exact actions/entities/warehouses and excluded documents. |
LimitCurrency | reference | yes | → Currencies. Authority currency. |
AmountLimit | decimal | yes | Finite nonnegative ceiling; cannot exceed principal authority. |
StartsAt | datetime | yes | Inclusive. |
EndsAt | datetime | yes | Exclusive. |
Status | select | yes | Draft, Active, Revoked, Expired |
GrantedBy | reference | yes | → Users. Independent same-domain authorized owner; no self-grant or approval escalation. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
EventNumber | text | yes | Unique source event key. |
Source | text | yes | Configured provider or reviewed manual source. |
ExternalKey | text | yes | Unique within source/entity; preserve provider attempts and economic identity. |
Kind | select | yes | Receipt, Shipment, Delivery, BankSettlement, BankRejection, BankReturn, DocumentAcknowledgment, Migration, Other |
Status | select | yes | Received, Verified, Applied, Ignored, ReviewRequired, Rejected |
PayloadHash | text | yes | Conflict on reused key blocks effects. |
Payload | longtext | yes | Protected evidence and expected source/version mapping. |
OccurredAt | datetime | yes | Actual source event time. |
ReceivedAt | datetime | yes | Received time. |
VerifiedBy | reference | → Users. Human reviewer or authenticated configured service; role-required decisions separate. | |
AppliedAt | datetime | Atomic local effect time. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
DeliveryNumber | text | yes | Unique intent/attempt. |
EconomicKey | text | yes | Stable economic operation and destination across retries. |
Destination | text | yes | Configured exact connector/recipient; no invented endpoint. |
Snapshot | reference | → DocumentRevisions. Frozen payload source. | |
PayloadHash | text | yes | Exact expected payload. |
Status | select | yes | Prepared, Submitted, Acknowledged, Rejected, Uncertain, Reconciled, Cancelled |
CreatedAt | datetime | yes | Intent time. |
SubmittedAt | datetime | Actual attempt time. | |
ProviderKey | text | Provider response identifier. | |
Event | reference | → IntegrationEvents. Authoritative response; acknowledgment is not cash/title/delivery completion. | |
RetryOf | reference | → IntegrationDeliveries. Only after proven nonexecution; uncertain operation remains reserved. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
BatchNumber | text | yes | Stable import identity. |
Status | select | yes | Draft, Validating, PendingApproval, Approved, Applied, Rejected |
CutoffAt | datetime | yes | Frozen source/system watermark. |
SourceHash | text | yes | Immutable extraction digest. |
OpeningJournal | reference | yes | → JournalEntries. Single full opening journal including subledger controls; detail never reposts it. |
Reconciliation | longtext | yes | One entity opening GL versus reconciled nonposting current stock/transit/WIP, external lots/internal portions, original date/label/genealogy, overlapping live holds/releases, historical customer deliveries, remaining source claims and open finance/carrying/prior FX. No historical receipt, production, title, invoice or cash replay. |
PreparedBy | reference | yes | → Users. Actual preparer. |
Decision | reference | → ApprovalDecisions. Independent Finance Manager activation plus Warehouse Manager stock and Kitchen Manager WIP/output evidence. Required before Active; import does not replay operational or monetary effects. | |
AppliedAt | datetime | One successful baseline activation. |
| Field | Type | Required | Details |
|---|---|---|---|
Batch | reference | yes | → MigrationBatches. Owning cutover. |
SourceKey | text | yes | Stable source/type/ID; unique across repeated batches for same baseline. |
TargetTable | text | yes | Existing permitted table name. |
TargetKey | text | yes | Resolved local immutable key. |
PayloadHash | text | yes | Conflicting replay requires review, never a second opening. |
Baseline | longtext | yes | Original accepted/priced/received/shipped/delivered/invoiced/settled/cancelled amounts and quantities; current carrying/revaluation, stock layers, WIP, approvals and source-event watermarks. |
Status | select | yes | Mapped, Validated, Applied, Conflict |
AppliedAt | datetime | Nonposting detail activation time; notifications/dispatch/payment creation suppressed. Absent until the real action; mandatory before the corresponding active/approved/posted state. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
TaskNumber | text | yes | Unique period/check/cutoff scope. |
Period | reference | yes | → AccountingPeriods. Same entity. |
Kind | select | yes | Bank, AR, AP, Inventory, Transit, WIP, GRNI, KitchenHolds, ShelfLife, Tax, Credits, UnappliedCash, Revaluation, Interfaces, PMSBridge, PMSControls, PMSTender |
Status | select | yes | Open, InProgress, Complete, ReviewRequired, Waived |
Owner | reference | yes | → Users. Assigned Accountant or relevant operational evidence owner. |
CutoffAt | datetime | yes | Precise evidence cutoff. |
SourceHash | text | yes | Population/version hash; changed source invalidates completion. |
Evidence | longtext | yes | Reconciliation totals, exceptions and prerequisites; required missing balances cannot be hidden by Complete. |
ReviewedBy | reference | → Users. Independent Finance Manager for unresolved exceptions/allowed waiver. | |
CompletedAt | datetime | Actual evidence completion. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
AccountCode | text | yes | Stable entity/customer identity; legal party and monetary entitlement cannot be inferred merely from matching display names. |
LegalName | text | yes | Bill-to legal customer identity. |
Status | select | yes | Prospect, Active, OnHold, Closed |
BillingAddress | longtext | Verified billing identity. | |
DefaultTerms | reference | → PaymentTerms. Accepted transaction freezes a version. | |
PriceList | reference | → PriceLists. Default customer price list; explicit precedence. | |
CreditCurrency | reference | → Currencies. Currency of credit limit. | |
CreditLimit | decimal | Finite nonnegative approved limit in CreditCurrency, required before credit trading; unknown is not unlimited. Separately attributed prepayments cannot reduce more than one exposure. | |
TaxEvidence | longtext | Exemption/resale documentation and review scope; not automatic compliance proof. | |
Activation | reference | → MasterChanges. Independent Property Manager commercial and Finance Manager credit/tax approval as applicable. | |
RelatedEntity | reference | → Entities. Explicit intercompany trading counterparty; still separate legal documents, no automatic elimination. | |
Owner | reference | yes | → Users. Front Desk Coordinator responsible for assigned customer relationships, not authority to transfer cash across counterparties. |
| Field | Type | Required | Details |
|---|---|---|---|
Account | reference | yes | → Accounts. Legal trading account. |
ContactCode | text | yes | Stable person/site reference. |
Name | text | yes | Contact name. |
Purpose | select | yes | Billing, Ordering, Delivery, General |
Email | text | Approved business contact. | |
Phone | text | Business contact. | |
DeliveryAddress | longtext | Actual ship-to; a changed address after acceptance requires review. | |
Status | select | yes | Active, Inactive |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
SupplierCode | text | yes | Unique trading account. |
LegalName | text | yes | Legal identity. |
Status | select | yes | Draft, Active, Suspended, Blocked |
Terms | reference | yes | → PaymentTerms. Effective payment terms. |
Activation | reference | → MasterChanges. Independent Purchasing Manager activation; finance reviews beneficiary/tax aspects separately. | |
RelatedEntity | reference | → Entities. Explicit intercompany supplier; ordinary paired trade documents and reconciliation, no same-entity stock-transfer shortcut. |
| Field | Type | Required | Details |
|---|---|---|---|
Supplier | reference | yes | → Suppliers. Owning supplier. |
BankKey | text | yes | Versioned beneficiary identifier. |
Currency | reference | yes | → Currencies. Payment currency supported. |
MaskedDetails | text | yes | Review display only. |
ProtectedDetails | longtext | yes | Protected connector secret/reference; Accountant and Finance Manager narrowly authorized, operators/sales excluded. |
BeneficiaryHash | text | yes | Frozen exact destination content used by approved instruction. |
Status | select | yes | Draft, Active, Superseded, Blocked |
Activation | reference | → MasterChanges. Independent Finance Manager confirmation; never preparer/editor. Absent until the real action; mandatory before the corresponding active/approved/posted state. |
| Field | Type | Required | Details |
|---|---|---|---|
Code | text | yes | Unique unit code. |
Dimension | text | yes | Mass, Volume, Count, Time |
DecimalPlaces | number | yes | Permitted nonnegative precision; indivisible unit has zero. |
Status | select | yes | Active, Inactive |
| Field | Type | Required | Details |
|---|---|---|---|
ProductCode | text | yes | Unique SKU. |
Name | text | yes | Product description. |
BaseUnit | reference | yes | → UnitsOfMeasure. Stock and production base quantity unit. |
LotControlled | boolean | yes | True for selected food recipe ingredient/packaging/intermediate/prepared output requiring actual provenance; exact original lot/leaf portion required before use. False permitted for genuine nonfood supplies under approved tracking policy, not as a bypass for traced food. Missing actual food provenance remains unresolved, never fabricated. |
Status | select | yes | Draft, Active, OnHold, Inactive |
ProductKind | select | yes | Stock, ManufacturedBatch, Repacked |
Activation | reference | → MasterChanges. Independent Warehouse Manager SKU/unit/tracking, Property Manager commercial and Kitchen Manager recipe/safe-use/shelf-life approval; Finance Manager for financial setup. ProductKind is route and Kind is usage, not duplicate SKU owners. | |
SerialControlled | boolean | yes | Each serialized position/effect identifies exactly one base unit; all accepted unit/pack conversions preserve it. |
Kind | select | yes | Ingredient, Packaging, Intermediate, Finished, NonfoodSupply |
ShelfLifePolicy | reference | → ShelfLifePolicies. Current approved default; received/released batches freeze actual applicable version, not retrospectively replaced. | |
AllergenDeclarations | longtext | yes | Reviewed applicable ingredient/safe-use declarations, known absence versus unknown and supplier/recipe evidence. Nonfood supplies explicitly not applicable where appropriate; no universal legal list or certification. |
| Field | Type | Required | Details |
|---|---|---|---|
Product | reference | yes | → Products. Exact SKU. |
Unit | reference | yes | → UnitsOfMeasure. Transaction unit. |
BaseUnitsPerUnit | decimal | yes | Strictly positive fixed factor; incompatible dimensions require explicit reviewed product conversion. |
Version | number | yes | Immutable active conversion version. |
Status | select | yes | Draft, Active, Superseded |
Activation | reference | → MasterChanges. Independent Warehouse Manager and required Finance Manager review for financial impact. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
ConversionEvidence | longtext | yes | Reviewed fixed same-dimension factor or fixed pack-to-product-base count; no density, potency or catch-weight assumptions. Both source and target dimensions/pack contents are retained. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
PriceListCode | text | yes | Unique version. |
Currency | reference | yes | → Currencies. One price currency. |
StartsAt | datetime | yes | Inclusive. |
EndsAt | datetime | Exclusive. | |
Priority | number | yes | Explicit precedence; equal eligible candidates block selection. |
Status | select | yes | Draft, Active, Superseded |
Activation | reference | → MasterChanges. Independent Property Manager; Finance Manager confirms configured floor/cost policy. Absent until the real action; mandatory before the corresponding active/approved/posted state. |
| Field | Type | Required | Details |
|---|---|---|---|
PriceList | reference | yes | → PriceLists. Effective immutable version. |
ProductUnit | reference | yes | → ProductUnits. Exact quantity/price basis. |
MinimumQuantity | decimal | yes | Nonnegative transaction-unit tier boundary; highest eligible boundary wins within selected list. |
UnitListPrice | decimal | yes | Nonnegative known document-currency price; zero requires explicit policy. |
MinimumNetPrice | decimal | Approved optional floor in the same unit/currency, not a cost estimate. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Product | reference | yes | → Products. SKU. |
Version | number | yes | Unique effective version. |
UnitStandardCost | decimal | yes | Known nonnegative entity-functional value per base unit; explicit approved zero is possible, missing is not zero. |
StartsAt | datetime | yes | Inclusive. |
EndsAt | datetime | Exclusive. | |
Status | select | yes | Draft, Active, Superseded |
CostBasis | longtext | yes | Reviewed input/labour/overhead basis; no double inclusion. |
Activation | reference | → MasterChanges. Independent Finance Manager activation with Kitchen Manager or Purchasing Manager reviewed technical/commercial cost basis; no rewrite of released WIP or earlier output. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
ProfileCode | text | yes | Unique version. |
Product | reference | yes | → Products. Exact product or configured explicitly named product class mapping. |
InventoryAccount | reference | yes | → ChartOfAccounts. Owned inventory control. |
WIPAccount | reference | yes | → ChartOfAccounts. Work-order WIP control. |
GRNIAccount | reference | yes | → ChartOfAccounts. Receipt accrual control. |
COGSAccount | reference | yes | → ChartOfAccounts. Sales cost at title event only. |
RevenueAccount | reference | yes | → ChartOfAccounts. Revenue at supported invoice recognition basis. |
PurchaseVarianceAccount | reference | yes | → ChartOfAccounts. Receipt/bill price variance; never hidden in decimal rounding. |
ProductionVarianceAccount | reference | yes | → ChartOfAccounts. Released production variance after complete WIP reconciliation. |
Status | select | yes | Draft, Active, Superseded |
Activation | reference | → MasterChanges. Independent Finance Manager review. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
SupplierReturnClearingAccount | reference | yes | → ChartOfAccounts. Clears current carrying of billed supplier returns against subsequent independently approved commercial credit; residual difference is classified, never hidden. |
ScrapAccount | reference | yes | → ChartOfAccounts. Reviewed stock/WIP scrap or loss expense, not a duplicate completion variance. |
| Field | Type | Required | Details |
|---|---|---|---|
WarehouseCode | text | yes | Unique physical site. |
Name | text | yes | Operational name. |
Timezone | text | yes | IANA site timezone. |
Status | select | yes | Active, Suspended, Closed |
PermittedEntities | longtext | yes | Explicit Entities allowed; not a transfer of ownership or access. |
Manager | reference | yes | → Users. Assigned Warehouse Manager with scope. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Department | reference | → PropertyDepartments. Actual custody department in the same property; transfer here alone does not record expense or service. |
| Field | Type | Required | Details |
|---|---|---|---|
Warehouse | reference | yes | → Warehouses. Physical/source operating site. |
LocationCode | text | yes | Unique within warehouse. |
Kind | select | yes | Storage, Receiving, Picking, Dispatch, Held, Transit, Production |
Status | select | yes | Active, Blocked, Closed |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Currency | reference | yes | → Currencies. Document currency; amounts use this currency unless stated otherwise. |
Rate | reference | yes | → ExchangeRates. Frozen positive document-to-entity-functional multiplier and dated purpose; identity rate explicit. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
QuoteNumber | text | yes | Unique entity quote. |
Account | reference | yes | → Accounts. Same entity. |
Status | select | yes | Draft, Submitted, Approved, Sent, Accepted, Expired, Rejected, Superseded |
QuoteDate | date | yes | Offer date. |
ValidUntil | datetime | yes | Expiry of exact offer revision. |
Owner | reference | yes | → Users. Front Desk Coordinator. |
PriceList | reference | → PriceLists. Selected list version or reviewed manual-price reason in snapshot. | |
NetTotal | decimal | yes | Sum frozen QuoteLines.NetAmount; no second subtraction of disclosed discounts. |
TaxTotal | decimal | yes | Sum exact tax allocations. |
SentAt | datetime | Actual successful send evidence, not intent. | |
AcceptanceEvidence | longtext | Actual customer acceptance bound to complete quote revision, quantity/net/tax/currency/terms/recipient; never an internal status substitute. | |
Decision | reference | → ApprovalDecisions. Required commercial price/margin exception decision by independent Property Manager; routine within-policy quote sending is Front Desk Coordinator preparation, not the mandatory order gate. | |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
| Field | Type | Required | Details |
|---|---|---|---|
Quote | reference | yes | → Quotes. Parent revision. |
LineNumber | number | yes | Stable line key. |
ProductUnit | reference | yes | → ProductUnits. Frozen conversion basis. |
Quantity | decimal | yes | Positive quoted transaction units. |
BaseQuantity | decimal | yes | Quantity × frozen conversion factor. |
UnitListPrice | decimal | yes | Known quoted currency/unit amount. |
LineDiscount | decimal | yes | Nonnegative amount in quote currency, bounded by list extension. |
HeaderDiscountAllocation | decimal | yes | Nonnegative allocated share with deterministic final remainder. |
NetAmount | decimal | yes | Quantity × UnitListPrice − LineDiscount − HeaderDiscountAllocation, rounded once; nonnegative. |
TaxCode | reference | → TaxCodes. Frozen effective treatment, rate and evidence; missing required tax blocks release. | |
TaxAmount | decimal | yes | Tax on eligible NetAmount once; explicit exempt zero requires evidence. |
StandardCost | reference | → StandardCosts. Entity cost basis; absent/unknown cost routes margin review, never zero. | |
MarginPercent | decimal | 100 × (NetAmount − converted extended cost) / NetAmount; null for zero net/unknown basis. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Currency | reference | yes | → Currencies. Document currency; amounts use this currency unless stated otherwise. |
Rate | reference | yes | → ExchangeRates. Frozen positive document-to-entity-functional multiplier and dated purpose; identity rate explicit. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
OrderNumber | text | yes | Unique entity order. |
Account | reference | yes | → Accounts. Same entity. |
Quote | reference | → Quotes. Accepted source revision; generated orders consume its remaining accepted scope once. | |
Status | select | yes | Draft, Submitted, OnHold, Approved, InProgress, PartiallyShipped, Shipped, Invoiced, Closed, Cancelled |
OrderDate | date | yes | Commercial date. |
Owner | reference | yes | → Users. Front Desk Coordinator preparing order. |
Terms | reference | yes | → PaymentTerms. Frozen accepted terms. |
ShipTo | longtext | yes | Frozen actual delivery/handover location, entitled recipient and contact evidence; carrier and customer handover requirements follow the selected mode. |
TitleRule | select | yes | Handover. Actual verified customer handover/pickup or carrier dispatch transfers stock/COGS once. Unsupported commercial title terms require reviewed implementation scope before activation. |
NetTotal | decimal | yes | Sum accepted SalesOrderLines.NetAmount. |
TaxTotal | decimal | yes | Sum line tax once. |
CreditReview | reference | yes | → CreditReviews. Current entity/customer exposure snapshot and valid exception if needed. |
AcceptedAt | datetime | Independent Property Manager approval time bound to exact customer acceptance, prices, address, title rule and quantities. | |
ShipmentMode | select | yes | Carrier, CustomerHandover |
ReplacementFor | reference | → Returns. Separately accepted replacement demand for a reviewed original return; never reopens already handed-over old order quantity automatically. | |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
SourceRoute | select | yes | LocalGoods. PMS guest/corporate charges, receipts, deposits and refunds cannot create this record or replay their GL bridge. |
| Field | Type | Required | Details |
|---|---|---|---|
SalesOrder | reference | yes | → SalesOrders. Exact order revision. |
LineNumber | number | yes | Stable identity across documented amendments. |
QuoteLine | reference | → QuoteLines. Accepted source allocation when converted from quote. | |
ProductUnit | reference | yes | → ProductUnits. Frozen unit and factor. |
Quantity | decimal | yes | Accepted quantity in transaction units. |
BaseQuantity | decimal | yes | Accepted base quantity. |
NetAmount | decimal | yes | Canonical accepted net including discounts once; final allocation gets remaining rounding cents. |
TaxAmount | decimal | yes | Frozen accepted estimated tax; actual invoice tax differences need evidence/approval. |
OriginalPromiseAt | datetime | yes | Original agreed full-delivery cutoff; never overwritten by rescheduling. |
RevisedPromiseAt | datetime | Separately accepted reschedule. | |
Warehouse | reference | → Warehouses. Planned source, not a second demand. | |
CancelledBaseQuantity | decimal | yes | Approved unfulfilled scope only; dispatch/billing corrections separately traced. |
Baseline | longtext | yes | Migration-only nonposting shipped/delivered/invoiced/cancelled quantities/net/tax; native values zero. |
Status | select | yes | Open, Held, PartiallyFulfilled, Fulfilled, Closed, Cancelled |
MinimumLifeRule | longtext | yes | Actual approved customer/product remaining-life requirement with calendar unit, date/expiry or best-before meaning, delivery-date basis and transport allowance. Missing required evidence blocks approval/allocation; no universal shelf-life rule. |
AgreedDeliveryAt | datetime | Current accepted actual delivery target used for remaining-life eligibility; revised target invalidates unexecuted affected claim/dispatch eligibility without overwriting OriginalPromiseAt. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
AllocationNumber | text | yes | Stable scope identity. |
OrderLine | reference | yes | → SalesOrderLines. Exact accepted line. |
ShipmentLine | reference | → ShipmentLines. Actual scoped fulfillment. | |
InvoiceLine | reference | → InvoiceLines. One billing claim or correction. | |
Kind | select | yes | Shipment, Billing, Cancellation, Correction |
Status | select | yes | Reserved, Posted, Released, Reversed |
BaseQuantity | decimal | yes | Positive allocated base quantity, never beyond eligible remaining source. |
NetAmount | decimal | yes | Order-currency accepted net allocated once, zero only for nonbilling quantity claim. |
TaxAmount | decimal | yes | Scoped tax allocation; differences retained with approved basis. |
CreatedAt | datetime | yes | Claim time. |
PostedAt | datetime | Actual effect time. | |
ReversalOf | reference | → SalesAllocations. Exact prior scope; cannot reopen shipped/billed demand without controlled correction. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
ReviewNumber | text | yes | Unique review snapshot. |
Account | reference | yes | → Accounts. Same entity. |
Order | reference | yes | → SalesOrders. Order being accepted/released. |
AsOf | datetime | yes | Snapshot time; stale material source changes require refreshed review. |
Currency | reference | yes | → Currencies. Account limit currency. |
Exposure | decimal | yes | Open AR net eligible credits plus approved uninvoiced commitments, with shipped/unbilled counted once; receipts count only when available and attributed under policy. |
ProposedIncrease | decimal | yes | Uncounted proposed gross exposure, never netted against an unrelated order decrease to hide risk. |
SourceHash | text | yes | Invoices/orders/credits/limits and exact conversion rates; missing rate blocks. |
Status | select | yes | WithinLimit, ExceptionRequired, ExceptionApproved, Expired, Superseded |
Decision | reference | → ApprovalDecisions. Independent Finance Manager finite amount/currency/expiry credit exception; Property Manager still approves order. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
RequisitionNumber | text | yes | Unique request. |
Status | select | yes | Draft, Submitted, Approved, Rejected, Converted, Cancelled |
RequestedAt | datetime | yes | Actual request. |
NeededBy | date | yes | Required supply date. |
RequestedBy | reference | yes | → Users. Warehouse Manager, Kitchen Operator or other authorized operational requester. |
Decision | reference | → ApprovalDecisions. Independent Purchasing Manager within configured authority, Finance Manager above limit; conversion consumes only approved remaining scope. |
| Field | Type | Required | Details |
|---|---|---|---|
Requisition | reference | yes | → Requisitions. Parent request. |
LineNumber | number | yes | Stable key. |
ProductUnit | reference | yes | → ProductUnits. Requested buy unit. |
Quantity | decimal | yes | Positive transaction units. |
Warehouse | reference | yes | → Warehouses. Intended receiving site. |
OrderLine | reference | → SalesOrderLines. Optional specific demand; proposal and generated PO are one supply. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Currency | reference | yes | → Currencies. Document currency; amounts use this currency unless stated otherwise. |
Rate | reference | yes | → ExchangeRates. Frozen positive document-to-entity-functional multiplier and dated purpose; identity rate explicit. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
PurchaseOrderNumber | text | yes | Unique supplier order. |
Supplier | reference | yes | → Suppliers. Active same-entity supplier. |
Status | select | yes | Draft, Submitted, Approved, Sent, PartiallyReceived, Received, Closed, Cancelled |
OrderDate | date | yes | Commercial date. |
Buyer | reference | yes | → Users. Purchasing Manager preparing the order. |
OriginalApprovedTotal | decimal | yes | Original approved commitment in order currency; retained through amendments. |
CumulativeGrossIncreases | decimal | yes | Sum positive line-level increases/new-line amounts over all approved amendments; decreases never conceal increases/category changes. |
CurrentTotal | decimal | yes | Current net plus approved applicable tax/freight, in document currency. |
ApprovalBasis | decimal | yes | At least max(CurrentTotal, OriginalApprovedTotal + CumulativeGrossIncreases), converted using retained authority rate; changed scope reviewed too. |
SentAt | datetime | Actual outbound evidence. | |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
| Field | Type | Required | Details |
|---|---|---|---|
PurchaseOrder | reference | yes | → PurchaseOrders. Parent accepted revision. |
LineNumber | number | yes | Stable key; fulfilled quantity/cost cannot be silently repriced. |
RequisitionLine | reference | → RequisitionLines. Converted demand allocation. | |
ProductUnit | reference | yes | → ProductUnits. Frozen conversion. |
Quantity | decimal | yes | Positive ordered buy units. |
BaseQuantity | decimal | yes | Quantity × frozen base factor. |
UnitNetPrice | decimal | yes | Known net document-currency price per buy unit, already discounted. |
NetAmount | decimal | yes | Quantity × UnitNetPrice rounded once. |
TaxCode | reference | → TaxCodes. Effective purchase treatment/evidence. | |
TaxAmount | decimal | yes | Tax on eligible net once. |
Warehouse | reference | yes | → Warehouses. Receiving site. |
OriginalPromiseAt | datetime | yes | Original supplier promised cutoff. |
RevisedPromiseAt | datetime | Separate reviewed current promise. | |
CancelledBaseQuantity | decimal | yes | Approved unreceived/unmatched remaining scope only. |
Baseline | longtext | yes | Nonposting accepted/returned/matched/cancelled quantities and commercial values at migration. |
Status | select | yes | Open, PartiallyReceived, Received, Closed, Cancelled |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
ReceiptNumber | text | yes | Unique supplier arrival. |
PurchaseOrder | reference | yes | → PurchaseOrders. Approved same-entity supplier order. |
Warehouse | reference | yes | → Warehouses. Actual site. |
Status | select | yes | Draft, Arrived, PendingReview, Accepted, PartiallyAccepted, Rejected, Corrected |
ArrivedAt | datetime | yes | Actual arrival, never scheduled date. |
ReceivedBy | reference | yes | → Users. Warehouse Operator independent of PO creator/buyer and commercial approver. |
ConfirmedAt | datetime | Physical evidence confirmed and accepted line effects committed. | |
Evidence | longtext | yes | Supplier document, delivery count and condition/inspection evidence. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
| Field | Type | Required | Details |
|---|---|---|---|
Receipt | reference | yes | → GoodsReceipts. Actual arrival. |
OrderLine | reference | yes | → PurchaseOrderLines. Exact approved supply. |
ArrivedBaseQuantity | decimal | yes | Nonnegative actual arrived total. |
AcceptedBaseQuantity | decimal | yes | Derived total live posted Accept tranches; receipt history is not reduced by later picking/consumption/shipping. Accepted supplier returns are separate fulfillment corrections. |
RejectedBaseQuantity | decimal | yes | Derived total live confirmed Reject tranches; never usable owned inventory or GRNI. |
PendingBaseQuantity | decimal | yes | ArrivedBaseQuantity minus accepted and rejected tranches; held pending stock is not posted as owned usable inventory. |
LotNumber | text | Required for lot-controlled product. | |
Location | reference | yes | → Locations. Receiving/held storage location as appropriate. |
StandardCost | reference | → StandardCosts. Proposed reviewed cost only; each actual ReceiptAcceptances tranche freezes its own effective cost. | |
CommercialFunctionalValue | decimal | Proposed value only; authoritative accepted values are the sum of posted ReceiptAcceptances, not a second payable or receipt. | |
ReceiptRate | reference | → ExchangeRates. Proposed receipt valuation; each accepted tranche freezes the actual required dated rate. | |
AcceptanceEvent | reference | → StockEvents. Optional first-acceptance convenience link; all authoritative tranches/effects are ReceiptAcceptances. No one-event-per-full-arrival assumption. | |
Lot | reference | → Lots. Required incoming controlled identity; supplier lot mapping verified before acceptance. | |
Serial | reference | → Serials. Required per serialized arrived unit; duplicate serial arrival cannot create owned stock. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
MatchNumber | text | yes | Unique matching allocation. |
BillLine | reference | yes | → BillLines. Exact proposed/posted supplier invoice line. |
ReceiptLine | reference | yes | → GoodsReceiptLines. Unused accepted supplier supply. |
Status | select | yes | Reserved, Matched, Released, Reversed |
BaseQuantity | decimal | yes | Positive scope bounded by net accepted unreturned/unmatched supply and bill quantity. |
ReceiptAccrualFunctional | decimal | yes | Original GRNI amount allocated with final remainder. |
BillNetFunctional | decimal | yes | Same-scope invoice net/capitalizable tax at bill rate. |
VarianceFunctional | decimal | yes | BillNetFunctional − ReceiptAccrualFunctional; price/rate components documented, not another full inventory debit. |
CreatedAt | datetime | yes | Claim time. |
PostedAt | datetime | Posted once with the bill. | |
Decision | reference | → ApprovalDecisions. Independent Finance Manager for mismatches/non-PO exceptions; a changed PO needs independent procurement approval too. | |
ReversalOf | reference | → BillMatches. Exact prior match and downstream credit evidence. | |
ReceiptAcceptance | reference | yes | → ReceiptAcceptances. Exact posted accepted tranche; ReceiptLine must be its parent. Reserved/posted matches bounded by this tranche's unreturned unmatched quantity. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Product | reference | yes | → Products. Stock SKU. |
Warehouse | reference | yes | → Warehouses. Operating site; source site retained for away transit. |
Location | reference | yes | → Locations. Storage, picking, transit or production custody. |
LotNumber | text | Required if controlled; identity cannot be edited to relabel stock. | |
CustodyState | select | yes | Available, Held, Picked, Transit, Production. Production is staged but not yet financially issued inventory; actually issued material leaves these inventory positions into separately traced work-order WIP custody. |
QuantityOnHand | decimal | yes | Nonnegative current base quantity; only posted signed stock movements update it. |
CarryingValue | decimal | yes | Nonnegative entity-functional inventory carrying, sum remaining StockLayers once. Issued material value is in WorkOrderCostEntries/WIP, not another production-position balance. |
ReservedQuantity | decimal | yes | Sum live Soft/Hard/Picked/InTransit claims on this exact position; physical picked/transit remains committed, no automatic timer release. |
AvailableQuantity | decimal | yes | Eligible available quantity less active claims; held/picked/transit/production unavailable to another order. |
Version | number | yes | Monotonic position version checked atomically. |
Status | select | yes | Active, Empty, Blocked |
Lot | reference | → Lots. Exact same entity/product lot; required when lot-controlled. Legacy display LotNumber must agree, never independent identity. | |
Serial | reference | → Serials. Exact individual identity; required for serial-controlled product. Movement/scope is exactly one serial/base unit per row. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Position | reference | yes | → InventoryPositions. Current exact owned identity. |
Product | reference | yes | → Products. Same SKU. |
OriginEvent | reference | yes | → StockEvents. Original acceptance/output/migration provenance. |
ParentLayer | reference | → StockLayers. Split/moved origin; parent stores only remaining balance, never duplicates descendant quantities. | |
OriginalQuantity | decimal | yes | Immutable layer created base quantity. |
RemainingQuantity | decimal | yes | Current nonnegative quantity. |
RemainingValue | decimal | yes | Current standard carrying value; zero quantity requires zero value with residual resolved explicitly. |
StandardCost | reference | → StandardCosts. Applied current standard version or traced customer-return carrying basis. | |
UnconsumedSource | longtext | yes | Origin commercial/reference quantities and descendant trace, including changes and returns. |
Version | number | yes | Atomic allocation/version. |
Status | select | yes | Open, Depleted, Held |
Lot | reference | → Lots. Exact same entity/product lot, required when lot-controlled; display values derive from this identity. | |
Serial | reference | → Serials. Exact individual identity; required for serial-controlled product. Movement/scope is exactly one serial/base unit per row. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
StockEventNumber | text | yes | Unique physical/economic action. |
Kind | select | yes | ReceiptAcceptance, PutAway, Pick, Unpick, TitleIssue, TransferDispatch, TransferReceipt, MaterialIssue, MaterialReturn, ProductionOutput, Scrap, CustomerReturn, SupplierReturn, StatusChange, CountAdjustment, CostRevaluation, MigrationOpening, Correction, PortionSplit, DepartmentUse |
Status | select | yes | Prepared, PendingApproval, Posted, Reversed, Rejected |
OccurredAt | datetime | yes | Actual evidenced event time. |
PostedAt | datetime | Atomic committed effect time. | |
SourceTable | text | yes | Existing exact typed source table. |
SourceKey | text | yes | Exact immutable source scope/revision. |
SourceHash | text | yes | Frozen content including quantity/cost/current versions. |
ConfirmedBy | reference | yes | → Users. Actor authorized for physical confirmation; financial authorization separate. |
Journal | reference | → JournalEntries. Balanced associated finance effect; same-control physical movement has none. | |
ReversalOf | reference | → StockEvents. Traced compensating event; no blind reversal after consumption/title transfer. | |
Portion | reference | → LotPortions. Affected source population for split/status/date-driven eligibility; actual movement rows retain exact source/destination leaves. |
| Field | Type | Required | Details |
|---|---|---|---|
StockEvent | reference | yes | → StockEvents. Parent atomic event. |
Position | reference | yes | → InventoryPositions. Exact identity. |
Layer | reference | yes | → StockLayers. Exact remaining layer. |
QuantityDelta | decimal | yes | Signed product base quantity; zero for explicit value-only event. Same-lot PortionSplit balances parent/child quantities and carrying without new output/GL; quality release changes eligibility without another quantity/value posting. |
ValueDelta | decimal | yes | Signed functional carrying value; no invented stock value. |
Reservation | reference | → InventoryReservations. Demand claim being transferred/consumed. | |
ShipmentLine | reference | → ShipmentLines. Exact dispatch/title portion if applicable. | |
ReturnLine | reference | → ReturnLines. Exact return source if applicable. | |
VersionBefore | number | yes | Expected position version; new identity checked in locked scope. |
Lot | reference | → Lots. Exact same entity/product lot, required when lot-controlled; display values derive from this identity. | |
Serial | reference | → Serials. Exact individual identity; required for serial-controlled product. Movement/scope is exactly one serial/base unit per row. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
ReservationNumber | text | yes | Stable demand/stock claim. |
Position | reference | yes | → InventoryPositions. Exact source/current position. |
Layer | reference | yes | → StockLayers. Exact source/current remaining layer. |
OrderLine | reference | → SalesOrderLines. Exactly one sales, production-material, transfer or department-use demand owner. Sales Hard/Picked/TitleIssue requires independent Property Manager-approved order; production requires independent Kitchen Manager work release; transfer and DepartmentUse require independent Warehouse Manager exact approval. All claims require current ownership/portion/date/fitness; no sales-order fiction for other demand. | |
WorkOrderMaterial | reference | → WorkOrderMaterials. Production component demand. | |
TransferLine | reference | → StockTransferLines. Internal transfer demand. | |
BaseQuantity | decimal | yes | Positive claimed quantity; active claims cannot exceed eligible stock or demand remainder. |
Status | select | yes | Soft, Hard, Picked, InTransit, Consumed, Released, Cancelled |
CreatedAt | datetime | yes | Atomic claim time. |
ExpiresAt | datetime | Soft unperformed claim expiry only after approved source/uncertainty review. Picked/transit scope never auto-releases; new hold/expiry blocks execution while reservations remain reconciled. | |
Replaces | reference | → InventoryReservations. Soft→Hard conversion replaces rather than adds a second claim. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. | |
EligibilitySnapshot | longtext | yes | Exact portion/revision/all applicable holds/date-policy/current effective expiry/opening/customer delivery-date basis and remaining-life test. Recheck at claim, conversion, issue, packing and actual handover; later hold/expiry blocks execution without erasing reservations/performed work. |
DepartmentUseLine | reference | → DepartmentUseLines. Exactly one demand family alongside OrderLine, WorkOrderMaterial or TransferLine. Requires independent Warehouse Manager DepartmentUse approval and current portion/fitness/date eligibility; never fictitious sales approval. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
TransferNumber | text | yes | Unique internal transfer. |
SourceWarehouse | reference | yes | → Warehouses. Source site. |
DestinationWarehouse | reference | yes | → Warehouses. Different allowed destination site. |
Status | select | yes | Draft, PendingApproval, Approved, PartiallyDispatched, InTransit, PartiallyReceived, Received, Closed, Cancelled |
RequestedAt | datetime | yes | Request time. |
DispatchedAt | datetime | First actual dispatch, not planned date. | |
CompletedAt | datetime | All dispatched quantity received or independently resolved with explicit loss/return evidence. |
| Field | Type | Required | Details |
|---|---|---|---|
Transfer | reference | yes | → StockTransfers. Same entity. |
Product | reference | yes | → Products. SKU. |
BaseQuantity | decimal | yes | Positive approved quantity. |
LotNumber | text | Required controlled identity. | |
SourceLocation | reference | yes | → Locations. Actual source. |
DestinationLocation | reference | yes | → Locations. Actual destination. |
DispatchedQuantity | decimal | yes | Posted net actual dispatch, not request. |
ReceivedQuantity | decimal | yes | Posted accepted destination quantity; bounded by unresolved dispatched quantity. |
ResolvedLossQuantity | decimal | yes | Separately approved loss/damage disposition, never marked received. |
TransitValue | decimal | yes | Unresolved dispatched carrying value; never disappears on close. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
LockNumber | text | yes | Unique lock request. |
Count | reference | yes | → InventoryCounts. Owning count. |
Warehouse | reference | yes | → Warehouses. Counted warehouse. |
Scope | longtext | yes | Exact physical locations/products/identities, including empty/new positions and null-bin population. Away transit excluded from floor population. |
SnapshotHash | text | yes | Whole locked-scope identity/version population; unrelated site changes do not invalidate it. |
StartsAt | datetime | yes | Actual successful lock. |
EndsAt | datetime | yes | Expiry; resumed movements require fresh snapshot/recount. |
Status | select | yes | Active, Released, Expired, Invalidated |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
CountNumber | text | yes | Unique count. |
Warehouse | reference | yes | → Warehouses. Physical scope. |
Status | select | yes | Planned, Locked, Counting, PendingReview, Approved, Posted, Closed, Invalidated |
PlannedStart | datetime | yes | Planned window. |
PlannedEnd | datetime | yes | Planned end. |
Owner | reference | yes | → Users. Warehouse Manager. |
Counter | reference | yes | → Users. Warehouse Operator independent of adjustment approval. |
Policy | reference | yes | → HospitalityPolicies. Frozen tolerance/value/lock rules. |
Lock | reference | → CountLocks. Required current scope lock at observation/posting. | |
PostedAt | datetime | Atomic adjustment time, with stock event and ledger effects. | |
FinanceDecision | reference | → ApprovalDecisions. Additional independent Finance Manager approval for found/identity-changing/held/reserved/above-value difference; unknown cost must be resolved first. |
| Field | Type | Required | Details |
|---|---|---|---|
Count | reference | yes | → InventoryCounts. Owning count. |
Position | reference | → InventoryPositions. Existing counted identity; null only newly found complete identity. | |
Identity | longtext | yes | Complete entity/product/warehouse/location/lot/serial/custody identity, including newly appearing identities within the locked physical scope. |
ExpectedQuantity | decimal | yes | Frozen physical quantity, never away owned-transit balance. |
CountedQuantity | decimal | yes | Nonnegative blind actual quantity in base unit. |
RecountQuantity | decimal | Independent required recount when outside quantity/percent tolerance. | |
VarianceQuantity | decimal | yes | Accepted observed quantity − expected. |
VariancePercent | decimal | 100 × absolute variance / expected when expected > 0; null otherwise, requiring review. | |
UnitCost | decimal | Known reviewed carrying/standard cost; missing blocks posting even after quantity approval. | |
VarianceValue | decimal | Signed functional variance after finite reviewed UnitCost is known; null while unknown, mandatory before approval/posting. A known calculated zero remains valid. | |
ObservedAt | datetime | yes | Actual observation time. |
RecountedBy | reference | → Users. Different actual Warehouse Operator or Warehouse Manager from initial counter; final approver cannot approve its own physical count. | |
StockEvent | reference | → StockEvents. One posted correction. | |
Lot | reference | → Lots. Exact same entity/product lot, required when lot-controlled; display values derive from this identity. | |
Serial | reference | → Serials. Exact individual identity; required for serial-controlled product. Movement/scope is exactly one serial/base unit per row. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
PickNumber | text | yes | Unique assigned task. |
OrderLine | reference | yes | → SalesOrderLines. Approved demand. |
Reservation | reference | yes | → InventoryReservations. Exact hard claim. |
Status | select | yes | Assigned, InProgress, Picked, PartiallyPicked, Exception, Cancelled |
AssignedTo | reference | yes | → Users. Warehouse Operator. |
PlannedStart | datetime | yes | Work window start. |
PlannedEnd | datetime | yes | Work window end. |
PickedQuantity | decimal | yes | Actual base quantity; unused reservation remains explicit. |
PickedAt | datetime | Actual confirmation. | |
StockEvent | reference | → StockEvents. Internal movement into picked custody only. | |
EligibilityEvidence | longtext | yes | Current exact portion quality, expiry/open-life, customer-delivery-date and remaining-life requirements; earliest-expiring eligible suggestion never substitutes for actual recheck at picking/packing/handover. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
ShipmentNumber | text | yes | Unique shipment. |
Order | reference | yes | → SalesOrders. One current independently approved same-entity customer order and its actual recipient/delivery terms; partial shipment lines consume exact remaining accepted order allocations. |
Warehouse | reference | yes | → Warehouses. Actual dispatch site. |
Mode | select | yes | Carrier, CustomerHandover |
Status | select | yes | Planned, Picking, Ready, HandedOver, PartiallyDelivered, Delivered, Exception, Closed, Cancelled |
TitleRule | select | yes | Handover. Actual customer handover/carrier dispatch issues exact eligible portions and current cost once; labels, approvals and payment requests do not. |
CarrierReference | text | Configured external handoff reference; no carrier booking claim. | |
HandedOverAt | datetime | Actual verified customer handover or carrier dispatch instant; a ready state, label or booking acknowledgment is insufficient. | |
HandoverEvidence | longtext | Actual carrier/customer/recipient/location/time and exact portion/lot/serial quantities, current quality/date/remaining-life evaluation and preserved labels. Unknown or expired eligibility cannot be overridden by a ready status. | |
ClosedAt | datetime | All line quantities delivered/returned/lost/resolved with remaining ownership reconciled. | |
Decision | reference | → ApprovalDecisions. Current exact independent action/scope/revision decision; required before corresponding approved effect. | |
ReleasedBy | reference | → Users. Independent Warehouse Manager readiness approval, excluding packet preparer/material editor. | |
ReleasedAt | datetime | Actual approval before execution; new material scope invalidates unexecuted release. |
| Field | Type | Required | Details |
|---|---|---|---|
Shipment | reference | yes | → Shipments. One order. |
OrderLine | reference | yes | → SalesOrderLines. Same order only. |
Reservation | reference | yes | → InventoryReservations. Exact picked claim and layer identity. |
BaseQuantity | decimal | yes | Actual assigned/shipped quantity, bounded by claim and accepted unfulfilled source. |
DispatchedQuantity | decimal | yes | Cumulative actual title-handover quantity across the supported mode; history stays intact through later returns. |
TitleTransferredQuantity | decimal | yes | Exact once-only TitleIssue quantity at actual handover/dispatch; bounded by approved remaining order and hard stock claim. |
DeliveredQuantity | decimal | yes | Cumulative accepted customer-delivery history, net only of approved factual evidence corrections. Physical returns never decrement this history or reopen old fulfillment eligibility. |
ReturnedQuantity | decimal | yes | Actual reconciled returned quantity, separate from original dispatch history. |
CarryingValueIssued | decimal | yes | Exact layer carrying value consumed by title transfer; no second cost at invoice/POD. |
OriginalDispatchEvent | reference | → StockEvents. TitleIssue at actual handover/dispatch; later carrier POD never issues stock/COGS again. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. |
| Field | Type | Required | Details |
|---|---|---|---|
ShipmentLine | reference | yes | → ShipmentLines. Exact title-handed-over source. Actual customer handover/pickup may create this same acceptance evidence atomically, never a second title issue. |
AcceptedQuantity | decimal | yes | Nonnegative actual accepted quantity. |
RefusedQuantity | decimal | yes | Nonnegative physically refused quantity. |
FailedQuantity | decimal | yes | Nonnegative undelivered quantity; not lost or returned automatically. |
DamagedQuantity | decimal | yes | Disjoint damaged scope retained pending disposition; not also included accepted/refused/failed. |
ScopeQuantity | decimal | yes | Disjoint accepted/refused/failed/damaged outcomes bounded by original actual handed-over units excluding the union of prior accepted, physically returned, approved lost or finally resolved units. Retry requires remaining goods confirmed undelivered and in evidenced custody after reconciliation; unknown/disputed scope stays held, never retry authority. Restock does not reopen original POD eligibility. |
ReturnLine | reference | → ReturnLines. Refused/damaged actual return custody if applicable. | |
CorrectionOf | reference | → DeliveryConfirmations. Exact prior result; approvals and downstream billing/title effects reconciled before correction. | |
Entity | reference | yes | → Entities. Owning legal entity; shipment, actual customer, stock ownership and financial sources must agree. |
OperationKey | text | yes | Stable economic action identity; identical canonical content returns same effect, changed content enters review. |
Event | reference | → IntegrationEvents. Authenticated import or reviewed manual source evidence. | |
ConfirmationNumber | text | yes | Stable actual confirmation/attempt economic identity. |
Status | select | yes | Prepared, Confirmed, Disputed, Corrected |
OccurredAt | datetime | yes | Actual customer result time, not scheduled pickup/arrival. |
ConfirmedBy | reference | yes | → Users. Warehouse Operator with actual source/recipient evidence; disputed identity/outcome requires Warehouse Manager review. |
RecipientEvidence | longtext | yes | Proof of actual intended customer or authorized recipient, location, event time and scoped quantities; never infer delivery from a bank document or approval. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
BOMCode | text | yes | Unique product/version. |
OutputProduct | reference | yes | → Products. One primary output SKU; co-products are separately scoped, not implied. |
OutputBaseQuantity | decimal | yes | Strictly positive recipe output basis. |
Version | number | yes | Immutable technical revision. |
StartsAt | datetime | yes | Inclusive. |
EndsAt | datetime | Exclusive. | |
Status | select | yes | Draft, Active, Superseded |
Activation | reference | → MasterChanges. Independent Kitchen Manager exact technical/ingredient/safe-use/check recipe version, excluding preparers/material editors; Finance Manager separately approves frozen standard/rates. | |
QualityPlan | reference | yes | → KitchenCheckPlans. Compatible active in-process/final specification; different required checks listed in QualityPrerequisites. |
AllergenSnapshot | longtext | yes | Exact effective ingredient/formula declarations and source evidence; unresolved or contradictory required declarations hold release. No automatic legal determination from ingredient names. |
ScalingRule | longtext | yes | Target primary output divided by frozen BOMs.OutputBaseQuantity, applied to every line in its own base unit, with deterministic rounding and reviewed deviations; no unlike-unit sum or double planning loss. |
QualityPrerequisites | longtext | yes | Exact applicable incoming/process/final checks, cleaning/changeover, safe-use/packing instructions and date/portion requirements. Bounded kitchen fitness, not industrial artwork or full factory QMS. |
| Field | Type | Required | Details |
|---|---|---|---|
BOM | reference | yes | → BOMs. Versioned recipe. |
LineNumber | number | yes | Stable component identity. |
Component | reference | yes | → Products. Input SKU; cycles forbidden across active recipes. |
BaseQuantity | decimal | yes | Positive input base quantity per BOM output basis. |
PlannedScrapPercent | decimal | yes | Known nonnegative planning allowance only when LossBasis AdditionalInputPercent; otherwise0. Applied once to this line input requirement, not again to output yield. Actual use/loss is separately measured. |
Instruction | longtext | yes | Material grade/lot substitution restrictions; substitutions require reviewed new scope. |
Kind | select | yes | Ingredient, Packaging |
RoundingRule | longtext | yes | Per-line unit precision, whole-pack restrictions and authorized deviation; no rounding ingredients into an incompatible packaging count. |
LossBasis | select | yes | None, AdditionalInputPercent, IncludedInReferenceInput |
DeclarationSnapshot | longtext | yes | Exact ingredient/specification/allergen and packaging/label constraints; substitutions require independently approved recipe/batch revision, never free-text silent ingredient replacement. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
RoutingCode | text | yes | Unique version. |
BOM | reference | yes | → BOMs. Compatible active recipe version. |
Version | number | yes | Immutable technical version. |
Status | select | yes | Draft, Active, Superseded |
Activation | reference | → MasterChanges. Independent Kitchen Manager technical instructions; separate Finance Manager cost-rate approval. |
| Field | Type | Required | Details |
|---|---|---|---|
Routing | reference | yes | → ProductionRoutings. Parent version. |
Sequence | number | yes | Positive unique execution order. |
Name | text | yes | Concrete batch preparation/processing/packing operation. |
Instructions | longtext | yes | Frozen actual process/changeover/cleaning/check/pack instructions with measurement units and evidence prerequisites; no implicit validated safety method or full QMS claim. |
TerminalOperation | boolean | yes | Exactly one final output operation; intermediate throughput never becomes extra finished units. |
LabourRatePerHour | decimal | yes | Known nonnegative entity-functional absorption rate, independently finance-approved. |
OverheadBasis | select | yes | None, LabourHour, OutputUnit |
OverheadRate | decimal | yes | Known nonnegative rate in declared basis; no embedded amount added again. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
WorkOrderNumber | text | yes | Unique production order. |
BOM | reference | yes | → BOMs. Frozen released recipe version. |
Routing | reference | yes | → ProductionRoutings. Frozen technical version. |
OutputProduct | reference | yes | → Products. One primary output. |
OutputStandard | reference | yes | → StandardCosts. Frozen entity-functional output standard at release. |
Warehouse | reference | yes | → Warehouses. Actual production site. |
OrderLine | reference | → SalesOrderLines. Optional make-for-order allocation, one demand not a second sales line. | |
PlannedQuantity | decimal | yes | Positive output base quantity. |
Status | select | yes | Draft, PendingApproval, Released, InProgress, PartiallyCompleted, Completed, PendingClose, Closed, Cancelled |
PlannedStart | datetime | yes | Feasible manually planned time. |
PlannedEnd | datetime | yes | Planned end; no optimizer promise. |
Manager | reference | yes | → Users. Kitchen Manager; independent of the relevant request preparer/material editors. |
ReleasedAt | datetime | Actual independent Kitchen Manager release after known material/cost/technical/condition and feasible manual schedule checks; no MRP or APS assumption. | |
ClosedAt | datetime | All input/output/scrap/WIP/cost obligations reconciled and necessary independent finance variance decision. | |
CompletedQuantity | decimal | yes | Net posted physically accepted terminal ProductionCompletions, including valued held output; quality-released availability separately derived from exact portions. No intermediate/rework sum. |
RemainingWIP | decimal | yes | Sum signed posted WorkOrderCostEntries, reconciled independently from unissued inventory. |
CloseDecision | reference | → ApprovalDecisions. Mandatory independent Kitchen Manager quantity/obligation close approval, excluding closure preparer/material editors. | |
CloseFinanceDecision | reference | → ApprovalDecisions. Additional independent Finance Manager approval for remaining WIP/variance/financial exception, not substitute for quantity close. | |
BatchNumber | text | yes | Unique actual internal production batch identity, linked to recipe/work order; not a duplicate inventory or cost owner. |
ShelfLifePolicy | reference | yes | → ShelfLifePolicies. Exact output policy version frozen at batch release. |
QualityPlan | reference | yes | → KitchenCheckPlans. Frozen applicable plan plus every additional prerequisite in released snapshot. |
KitchenSnapshot | longtext | yes | Frozen recipe/per-line dimensions, primary output, ingredient/packaging and relevant safe-use instructions, actual source/date constraints, compatible yield basis and required kitchen checks. Unknown required prerequisites block affected release. |
QualityDecision | reference | → ApprovalDecisions. Independent Kitchen Manager recipe/specification/label/date prerequisites; no requirement to pretend final product is released before physically accepted held output can be valued. | |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
| Field | Type | Required | Details |
|---|---|---|---|
WorkOrder | reference | yes | → WorkOrders. Released job. |
BOMLine | reference | yes | → BOMLines. Frozen technical source. |
Product | reference | yes | → Products. Input SKU. |
RequiredBaseQuantity | decimal | yes | Target output divided by frozen BOM reference output, times this line input base quantity and only applicable planning-loss factor once; per-line rounding retained, never mixed-dimension sum. |
IssuedQuantity | decimal | yes | Gross actual material issue into exclusive work-order WIP custody; source inventory quantity/value removed once. Later returns and consumption remain separate derived counters from exact issue-source WorkOrderCostEntries. |
ReturnedQuantity | decimal | yes | Unused physical WIP material actually returned from remaining issue-source quantity/cost into a new inventory layer; never debit a depleted original inventory position or return consumed material. |
ConsumedQuantity | decimal | yes | Actual component base quantity used/scrapped in process; sum exact issue-source MaterialConsumedQuantity, not a second stock issue. Issued minus returned minus consumed is physically unused WIP material. |
Reservation | reference | → InventoryReservations. Exact material claim; multiple split claims linked by this source. | |
RequirementBasis | longtext | yes | Frozen ingredient/packaging kind, original and converted unit/dimension, scale factor, reference quantity, planning allowance and rounding; actual deviation requires current review. |
| Field | Type | Required | Details |
|---|---|---|---|
WorkOrder | reference | yes | → WorkOrders. Released job. |
RoutingOperation | reference | yes | → RoutingOperations. Frozen sequence/rates/bases. |
AssignedTo | reference | yes | → Users. Assigned Kitchen Operator; Kitchen Manager independently confirms actual throughput/time. |
Status | select | yes | Ready, InProgress, Complete, Exception, Cancelled |
PlannedStart | datetime | yes | Assigned window. |
PlannedEnd | datetime | yes | End. |
ActualStart | datetime | Actual work start. | |
ActualEnd | datetime | Actual work end, positive interval when labour hours charged. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
EntryNumber | text | yes | Stable operation/time/output identity. |
Operation | reference | yes | → WorkOrderOperations. Released work operation. |
RecordedBy | reference | yes | → Users. Actual Kitchen Operator recorder; ProducedBy identifies actual producer, which may differ. |
Status | select | yes | Draft, Submitted, Accepted, Rejected, Corrected |
StartedAt | datetime | yes | Actual time. |
EndedAt | datetime | Actual time; no overlap/double use of same person's time interval. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
GoodQuantity | decimal | yes | Physically accepted completed throughput in the declared operation/output unit, including output still quality-held. Quality status is separate; no mixed-ingredient sum or intermediate quantity counted as finished stock. |
ScrapQuantity | decimal | yes | Nonnegative actual rejected output-equivalent evidence; input scrap quantities separately traced. |
LabourHours | decimal | Accepted actual person-hours with overlap checks across every live entry for the same person; no charge for unclosed/invalid time and no payroll effect. Null until actual interval/basis known; finite nonnegative value required before acceptance/cost posting, with explicit known zero allowed. | |
AcceptedBy | reference | → Users. Independent Kitchen Manager excluding producer, recorder and material editors; actual condition evidence required. | |
CorrectionOf | reference | → ProductionEntries. Prior entry and consumed costs/completions reconciled first. | |
ProducedBy | reference | yes | → Users. Actual Kitchen Operator producing the units; recorder can differ and neither may approve the same source. |
ScopeKey | text | yes | Stable batch/unit/operation-pass identity; rework has linked prior pass and exact unit lineage, never a second finished unit. |
MachineHours | decimal | Nonnegative actual accepted occupied machine hours; distinct from elapsed person-hours and setup overlap. Null until actual interval/basis known; finite nonnegative value required before acceptance/cost posting, with explicit known zero allowed. | |
AcceptedAt | datetime | Actual independent technical/time confirmation. | |
InputAllocations | longtext | yes | Exact prior operation/batch source scope and actual BatchMaterialAllocations. Output-equivalent flow only uses compatible output units. Ingredient mass, liquid volume and packaging count each reconcile separately; process loss/measurement basis is in BatchReconciliations. Never enforce a false kg+L+each equality; rework preserves original units/history. |
HeldQuantity | decimal | yes | Physically incomplete/unconfirmed operation scope in declared output-equivalent unit; excluded from physical terminal completion until independently confirmed. Distinct from physically completed valued output held only for pending quality. |
UnfinishedQuantity | decimal | yes | Nonnegative physically unfinished operation scope in its declared compatible output unit, disjoint from GoodQuantity, ScrapQuantity and HeldQuantity. Reconcile output scope and measured processing loss in BatchReconciliations; never impose mixed-input = output equality or count evaporation twice. |
MeasureUnit | reference | yes | → UnitsOfMeasure. Compatible declared operation/output unit for throughput; distinct ingredient units remain on material allocations. |
ProcessEvidence | longtext | yes | Actual recipe/operation, observed processing conditions, changeover/cleaning and measured loss/sampling facts; required KitchenChecks own their actual criterion results. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
CompletionNumber | text | yes | Unique terminal completion. |
WorkOrder | reference | yes | → WorkOrders. Released job. |
TerminalEntry | reference | yes | → ProductionEntries. Unused independently accepted PHYSICAL terminal output, possibly held pending quality; no intermediate or unconfirmed quantity. |
Status | select | yes | Prepared, PendingApproval, Approved, Posted, Reversed |
OutputQuantity | decimal | yes | Positive base output, bounded by remaining accepted terminal scope and authorized work order. |
LotNumber | text | Required output lot. | |
Location | reference | yes | → Locations. Actual received finished-stock location. |
AllocatedActualWIP | decimal | yes | Unused approved material/labour/overhead source carrying attributed to actual consumed material and accepted time; active cost/quantity claims reduce availability. Unknown cost blocks posting. |
StandardOutputValue | decimal | yes | OutputQuantity × frozen output standard, rounded once. |
Variance | decimal | yes | AllocatedActualWIP − StandardOutputValue; positive adverse expense, negative favorable variance, once. |
CompletedAt | datetime | Actual independently accepted terminal completion time, required before approved/posted scope; not draft creation. | |
ConfirmedBy | reference | → Users. Independent Kitchen Manager excluding actual producer, recorder, completion preparer/material editors; confirms exact physical terminal scope and condition evidence. Quality eligibility may remain Held pending separate Kitchen Manager review. | |
FinanceDecision | reference | → ApprovalDecisions. Independent Finance Manager approves nonzero variance/cost exception before posting; quantity acceptance alone does not authorize value. | |
StockEvent | reference | → StockEvents. Dr finished inventory standard / Cr WIP allocated actual / signed production variance. | |
Lot | reference | → Lots. Required exact output lot when controlled. | |
Serial | reference | → Serials. Required individual identity when serialized; quantity exactly one per row. | |
ConditionEvidence | longtext | yes | Independent physical completion/quantity/label evidence; actual product quality eligibility is separate. Held owned output can be valued into a held portion pending tests, but unknown physical identity or cost blocks posting. |
OutputPortion | reference | yes | → LotPortions. Exact new output population/lot with source genealogy/date/label evidence; stock and WIP effect creates this once, not quality release. |
OutputEligibility | select | yes | Held, Released |
QualityBasis | longtext | yes | Default Held pending required independent Kitchen Manager release. Released only if every required test/label/date/lineage/hold condition covers exact output; no header-wide release from one passing sample. |
Reconciliation | reference | → BatchReconciliations. Required terminal physical/material/packaging/yield/cost reconciliation before posting; may retain named unresolved quality decisions while owned output stays held. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
CostEntryNumber | text | yes | Unique cost source/effect. |
WorkOrder | reference | yes | → WorkOrders. One WIP owner. |
Kind | select | yes | MaterialIssue, MaterialReturn, Labour, Overhead, CompletionRelief, Scrap, Correction, Opening |
Material | reference | → WorkOrderMaterials. Exact input source when material. | |
ProductionEntry | reference | → ProductionEntries. Unused approved time/throughput basis for labour/overhead. | |
Completion | reference | → ProductionCompletions. Output WIP relief. | |
Amount | decimal | yes | Signed WIP delta in entity-functional currency; material and labour/overhead charged only once. |
AllocatedAmount | decimal | yes | Absolute positive source cost consumed by completion/scrap or unused-material-return relief. Active ReservedAmount reduces availability too; no source amount is relieved twice. |
Basis | longtext | yes | Frozen hours/units/rates, source layer quantities/value, calculation and allocation remainder. |
Status | select | yes | Prepared, Approved, Posted, Reversed |
OccurredAt | datetime | yes | Actual cost evidence time. |
Journal | reference | → JournalEntries. Balanced WIP posting; standard absorption counteraccount is not a second actual payroll expense. | |
ReversalOf | reference | → WorkOrderCostEntries. Exact signed reversal only after consumed completion/stock effects resolved. | |
ReservedAmount | decimal | yes | Active completion/scrap allocation claims in functional currency; subtract from unallocated source amount before any new claim. |
ConsumedSources | longtext | Exact positive source-entry quantities/current original issue basis/cost and linked BatchMaterialAllocations. Output allocation consumes already used/normal-loss sources once; abnormal scrap and unused return have distinct eligible claims. Sum matches actual WIP relief; no cost or quantity duplicated across partial output/loss. Normal process loss included in output is not another scrap expense. | |
SourceStockEvent | reference | → StockEvents. Actual material issue/return/scrap source event; paired stock/WIP effects commit once. | |
SourceLayer | reference | → StockLayers. Original issue layer for material source; retained historical identity even after depletion, never an instruction to reverse blindly there. | |
Lot | reference | → Lots. Material issue-source lot, matching product/entity. | |
Serial | reference | → Serials. Exact material serial when controlled; issue/return/consumption quantity is one. | |
MaterialBaseQuantity | decimal | For MaterialIssue: positive immutable actual gross issue quantity, valued at the exact source layer carrying basis; null for nonmaterial entries. | |
MaterialReturnedQuantity | decimal | Sum actual unused returns allocated to this MaterialIssue source, initially known zero and bounded by unconsumed/available quantity. | |
MaterialConsumedQuantity | decimal | Sum actual component use/scrap allocated to this issue source, initially known zero; no inventory quantity effect after original issue. | |
AllocatedMaterialQuantity | decimal | Consumed source material quantity whose cost has been relieved into output/scrap, excluding separately returned quantity; capped by physically MaterialConsumedQuantity. | |
MaterialSource | reference | → WorkOrderCostEntries. MaterialReturn or corrective source points to exact original MaterialIssue; all split sources explicitly enumerated in ConsumedSources when multiple. | |
ReservedMaterialQuantity | decimal | For a MaterialIssue source, active uncommitted use/return quantity claims; physically unused availability = MaterialBaseQuantity minus MaterialReturnedQuantity minus MaterialConsumedQuantity minus ReservedMaterialQuantity. Commit replaces the claim with one actual use/return, never both. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
ReturnNumber | text | yes | Unique authorization. |
Direction | select | yes | CustomerToUs, UsToSupplier |
Account | reference | → Accounts. Required only customer return. | |
Supplier | reference | → Suppliers. Required only supplier return. | |
Status | select | yes | Draft, PendingApproval, Authorized, PartiallyReceived, Received, PartiallyDispatched, Dispatched, PendingDisposition, Closed, Cancelled |
RequestedAt | datetime | yes | Actual request. |
ExpiresAt | datetime | yes | Authorization expiry; actual already received custody cannot disappear on expiry. |
Reason | longtext | yes | Reason and original source/quantity conditions. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
| Field | Type | Required | Details |
|---|---|---|---|
Return | reference | yes | → Returns. Authorized direction. |
ShipmentLine | reference | → ShipmentLines. Customer source; required unless controlled migration source preserved in baseline. | |
ReceiptLine | reference | → GoodsReceiptLines. Supplier source; exact original accepted quantity/descendants. | |
OriginalInvoiceLine | reference | → InvoiceLines. Customer original billing scope if invoiced. | |
OriginalBillLine | reference | → BillLines. Supplier billed scope; null only wholly unmatched receipt portion. Split mixed billed/unbilled return scope. | |
AuthorizedQuantity | decimal | yes | Positive base quantity bounded by original net unreturned scope. |
ActualQuantity | decimal | yes | Actual physical received/dispatched quantity, bounded by authorization. |
OriginalIssuedValue | decimal | Original title-issue carrying value for post-title customer return; null before title or for supplier scope, never fabricated zero. | |
CurrentRemovalValue | decimal | yes | Current descendant carrying for supplier return. Before actual customer handover, cancellation restores existing owned staging/custody without sale/COGS reversal; no delivery-title branch. |
OriginalCommercialValue | decimal | yes | Scoped original net/tax settlement basis kept separate from carrying removal. |
LotNumber | text | Trace original identity; changed identity requires explicit reviewed disposition. | |
PhysicalAt | datetime | Actual return receipt or supplier handover. | |
StockEvent | reference | → StockEvents. Actual custody/owned-stock effect once. | |
ReceiptAcceptance | reference | → ReceiptAcceptances. Required for supplier return of accepted owned goods; binds original posted tranche/descendants, rather than gross arrival. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
DispositionNumber | text | yes | Unique return-scope decision. |
ReturnLine | reference | yes | → ReturnLines. Actual received/authorized scope. |
Kind | select | yes | Restock, Scrap, ReturnToCustomer, ReturnToSupplier, Quarantine |
Status | select | yes | Prepared, PendingApproval, Approved, Posted, Reversed |
BaseQuantity | decimal | yes | Positive bounded actual quantity not already disposed. |
CarryingValue | decimal | yes | Original title-issue cost for actual customer restock; current descendant carrying for supplier return. Before actual customer handover, cancellation restores existing owned staging/custody without a COGS reversal; no delivery-title customer path. |
Destination | reference | → Locations. Actual held/restocked destination, same entity/warehouse scope; new assembly/rework requires separately released production scope. | |
PreparedBy | reference | yes | → Users. Warehouse Operator observations. |
DecidedAt | datetime | Independent WM disposition; FM additionally authorizes loss/value exception. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
StockEvent | reference | → StockEvents. No physical/economic effect from status alone. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Currency | reference | yes | → Currencies. Document currency; amounts use this currency unless stated otherwise. |
Rate | reference | yes | → ExchangeRates. Frozen positive document-to-entity-functional multiplier and dated purpose; identity rate explicit. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
InvoiceNumber | text | yes | Unique legal document. |
Account | reference | yes | → Accounts. Same entity. |
DocumentType | select | yes | Invoice, CreditNote |
OriginalInvoice | reference | → Invoices. Required credit/correction original. | |
Status | select | yes | Draft, PendingApproval, Approved, Posted, PartiallySettled, Settled, Disputed, Reversed, Cancelled |
InvoiceDate | date | yes | Original legal/business date. |
PostingDate | date | yes | Eligible date in entity Period; no closed-period rewrite. |
Period | reference | yes | → AccountingPeriods. Same-entity open posting period. |
DueDate | date | yes | Frozen terms. |
NetAmount | decimal | yes | Positive magnitude sum InvoiceLines.NetAmount; credit sign comes only from DocumentType. |
TaxAmount | decimal | yes | Positive applicable tax magnitude, credit reverses original scoped tax. |
TotalAmount | decimal | yes | NetAmount + TaxAmount once. |
Outstanding | decimal | yes | Debit original less posted cash/credit/approved corrections and cutover baseline; credits use CreditRemaining separately. |
CurrentCarrying | decimal | yes | Functional carrying value of current open debit/credit, including delta revaluation. |
UnrealizedFX | decimal | yes | Signed gain-positive prior FX on remaining scope; reclassified once when settled. |
CreditRemaining | decimal | yes | Credit-note value less posted uses/refunds; active reservations reduce allocatable balance further. |
PostedAt | datetime | Local journal posting time; send acknowledgment is separate. | |
Journal | reference | → JournalEntries. Debit: Dr AR / Cr Revenue and tax; CreditNote: Dr reversal revenue/tax / Cr CustomerCredit, then applications/refunds separately. | |
Baseline | longtext | yes | Nonposting original/settled/credit and current carrying/FX amounts at migration; native zero. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
SourceRoute | select | yes | LocalGoods. PMS guest/corporate charges, receipts, deposits and refunds cannot create this record or replay their GL bridge. |
| Field | Type | Required | Details |
|---|---|---|---|
Invoice | reference | yes | → Invoices. Parent revision. |
LineNumber | number | yes | Stable line. |
OrderLine | reference | → SalesOrderLines. Required accepted goods debit source; no project/work certificate. | |
ShipmentLine | reference | → ShipmentLines. Required actual eligible title transfer, not planned dispatch or unverified POD. | |
OriginalLine | reference | → InvoiceLines. Required credit source. | |
ReturnLine | reference | → ReturnLines. Physical return basis when applicable; commercial-only credit explicitly reviewed. | |
BaseQuantity | decimal | yes | Positive scoped base quantity; financial-only price correction can use zero with explicit original value basis. |
NetAmount | decimal | yes | Allocated accepted order net once, or bounded original credited net; no second discount deduction. |
TaxAmount | decimal | yes | Correct eligible tax basis/rate/exemption snapshot, not unreviewed default zero. |
TaxEvidence | longtext | yes | Frozen exact rule/rate/basis and original credit allocation. |
Allocation | reference | → SalesAllocations. Reserved then posted once with invoice. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Currency | reference | yes | → Currencies. Document currency; amounts use this currency unless stated otherwise. |
Rate | reference | yes | → ExchangeRates. Frozen positive document-to-entity-functional multiplier and dated purpose; identity rate explicit. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
BillNumber | text | yes | Unique entity/supplier/external invoice identity; duplicate invoice hash review. |
Supplier | reference | yes | → Suppliers. Same entity. |
DocumentType | select | yes | Bill, CreditNote |
OriginalBill | reference | → Bills. Credit original. | |
Status | select | yes | Draft, Matching, PendingApproval, Approved, Posted, PartiallySettled, Settled, Disputed, Reversed, Cancelled |
BillDate | date | yes | Supplier document date. |
PostingDate | date | yes | Open entity period date. |
Period | reference | yes | → AccountingPeriods. Same entity. |
DueDate | date | yes | Frozen terms. |
NetAmount | decimal | yes | Positive net magnitude. |
TaxAmount | decimal | yes | Positive tax magnitude. |
TotalAmount | decimal | yes | Net plus tax once. |
Outstanding | decimal | yes | Debit original less posted settlement/credits/corrections and baseline; not cash-only balance. |
CurrentCarrying | decimal | yes | Functional remaining open amount including delta FX. |
UnrealizedFX | decimal | yes | Signed gain-positive prior FX on remaining scope. |
CreditRemaining | decimal | yes | Supplier-credit magnitude less posted applications/refunds; subtract active reservations too for availability. |
PostedAt | datetime | Local posting. | |
Journal | reference | → JournalEntries. Matched bill clears scoped GRNI plus approved variance/tax to AP; no second full inventory debit. Credit creates SupplierCredit asset with original reversal basis. | |
Baseline | longtext | yes | Nonposting source/open/carrying/settlement/FX balances at migration. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
| Field | Type | Required | Details |
|---|---|---|---|
Bill | reference | yes | → Bills. Parent revision. |
LineNumber | number | yes | Stable key. |
OrderLine | reference | → PurchaseOrderLines. Approved commercial source for stock purchases. | |
OriginalLine | reference | → BillLines. Required credit source. | |
ReturnLine | reference | → ReturnLines. Exact returned source if credit. | |
Product | reference | yes | → Products. Exact SKU/charge. |
BaseQuantity | decimal | yes | Positive stock quantity; zero allowed only approved financial-only correction/charge. |
NetAmount | decimal | yes | Document-currency net price amount; positive credit magnitude. |
TaxCode | reference | → TaxCodes. Frozen treatment. | |
TaxAmount | decimal | yes | Tax once; recovery/nonrecoverable destination explicit. |
ExpenseAccount | reference | → ChartOfAccounts. Required approved nonstock/non-PO expense basis; never invents receipt. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
BankCode | text | yes | Unique bank/currency account. |
Currency | reference | yes | → Currencies. Actual bank currency. |
LedgerAccount | reference | yes | → ChartOfAccounts. Same-entity source-controlled bank/cash-on-hand/cash-in-transit/restricted-cash account according to Kind. |
Status | select | yes | Draft, Active, Blocked, Closed |
ProtectedDetails | longtext | yes | Accountant/Finance Manager only under current purpose; operator/sales exports excluded. |
BalanceQuantity | decimal | yes | Posted own-currency balance, reconciled to actual bank statement or reviewed physical cash/transfer evidence; opening/collection/deposit is not duplicated. |
CarryingValue | decimal | yes | Functional carrying balance including delta bank revaluation. |
UnrealizedFX | decimal | yes | Signed prior bank FX to reclassify on scoped disposal. |
ReservedQuantity | decimal | yes | Active released/unsettled instructions/refunds; prevent duplicate spend where finite availability policy applies. |
Version | number | yes | Atomic balance/reservation version. |
Activation | reference | → MasterChanges. Independent Finance Manager. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
Kind | select | yes | Bank, CashOnHand, CashInTransit |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
StatementLineNumber | text | yes | Unique bank transaction identity. |
BankAccount | reference | yes | → BankAccounts. Same entity/currency. |
Status | select | yes | Imported, Matched, Reconciled, Disputed |
OccurredAt | datetime | yes | Actual bank time. |
ValueDate | date | yes | Bank value date. |
SignedAmount | decimal | yes | Bank-currency receipt positive/payment negative; charges separately identifiable. |
ExternalReference | text | yes | Provider statement/transaction identity. |
MatchedSource | longtext | Exact local payment/receipt/refund/fee effect; same bank line cannot fund two effects. | |
ReconciledBy | reference | → Users. Accountant confirmation; own exception needs independent Finance Manager. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Currency | reference | yes | → Currencies. Document currency; amounts use this currency unless stated otherwise. |
Rate | reference | yes | → ExchangeRates. Frozen positive document-to-entity-functional multiplier and dated purpose; identity rate explicit. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
ReceiptNumber | text | yes | Unique cash receipt. |
Account | reference | → Accounts. May initially be unidentified; must be attributed with evidence before application. | |
BankAccount | reference | yes | → BankAccounts. Actual same-entity receipt account. Currency may differ from gross receipt only with exact CollectionComponents and reviewed conversion; actual bank receipt must be evidenced, never manufactured from gross proceeds. |
Status | select | yes | Prepared, Posted, PartiallyApplied, Applied, Returned, Reversed |
ReceivedAt | datetime | yes | Actual verified bank/cash receipt time; advice, payment request, internal approval or transport acknowledgment is not collected money. |
Period | reference | yes | → AccountingPeriods. Eligible posting period. |
Amount | decimal | yes | Positive actual gross customer collection in receipt currency. Ordinary receipt equals bank cash; explicitly approved evidenced net collection plus actual bank fee uses CollectionComponents and one FinanceCorrection fee owner, not a second receipt. |
UnappliedAmount | decimal | yes | Amount less net posted receipt-currency applications and directly receipt-funded refunds/actual returns. Credit-funded refunds preserve historical cash applications. Active reservations and disjoint held amounts reduce availability separately; never negative. |
UnappliedCarrying | decimal | yes | Functional remaining unapplied liability carrying, including its own revaluation. |
UnrealizedFX | decimal | yes | Gain-positive prior FX on unapplied liability, released/reclassified proportionally. |
ReservedAmount | decimal | yes | Active application/refund claims in receipt currency; never invoice currency. |
StatementLine | reference | → BankStatementLines. Actual settlement evidence or reviewed manual cash proof in Event. | |
Journal | reference | → JournalEntries. Actual Dr Bank/Cash and approved exact withheld fee if present / Cr UnappliedCustomer once. Later application clears that liability/AR without new bank or fee posting. | |
Baseline | longtext | yes | Opening receipt amount/applied/unapplied/carrying/FX and original source IDs, nonposting. |
SourceKind | select | yes | Bank, Cash |
AvailabilityState | select | yes | Clear, Unidentified, Held, ReviewRequired |
HeldAmount | decimal | yes | Nonnegative available receipt-currency portion held outside active reservations, bounded by UnappliedAmount minus ReservedAmount. Unresolved counterparty/funding/outcome can block execution while actual evidence remains. |
CollectionDecision | reference | → ApprovalDecisions. Independent Finance Manager review of any nonroutine net collection/fee/source classification; actual bank evidence remains recorded pending review. | |
ActualBankAmount | decimal | Actual received cash in BankAccount currency; required before posting. Ordinary receipt equals Amount in the same currency; reviewed outright collection may have a separately evidenced deducted fee. | |
ActualBankValue | decimal | Actual net bank functional value with rate evidence; never use gross customer receipt amount as cash when a fee was withheld. | |
CollectionComponents | longtext | yes | Ordinary receipts state no deduction. Reviewed net collection retains gross customer and actual net bank currency amounts, exact FinanceCorrections BankFee source key/value and rate/current-carrying basis in one balanced journal. Charge included once, no double bank/fee entry on later application. |
SourceRoute | select | yes | LocalGoods. PMS guest/corporate charges, receipts, deposits and refunds cannot create this record or replay their GL bridge. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
ApplicationNumber | text | yes | Unique application. |
Receipt | reference | yes | → CashReceipts. Actual confirmed same-entity/customer available receipt purpose; active applications/refunds and disjoint holds share one remaining balance. |
Invoice | reference | yes | → Invoices. Same customer/entity independently approved posted eligible debit and exact current carrying. |
Status | select | yes | Reserved, Approved, Posted, Reversed, Cancelled |
ReceiptAmount | decimal | yes | Positive cash consumed in receipt currency only. |
InvoiceCashAmount | decimal | yes | Positive cash-funded portion in invoice currency. |
DiscountAmount | decimal | yes | Nonnegative approved noncash settlement discount in invoice currency. |
WriteOffAmount | decimal | yes | Nonnegative approved invoice-currency write-off; independent FM decision required. |
ReceiptRate | reference | yes | → ExchangeRates. Receipt currency settlement reference. |
InvoiceRate | reference | yes | → ExchangeRates. Invoice currency settlement reference. |
FunctionalSettlement | decimal | yes | Reviewed equivalent cash/noncash functional value; receipt and invoice cash equivalents reconcile within explicit decimal policy. |
InvoiceCarryingReleased | decimal | yes | Current carrying of settled total invoice quantity, proportional with final remainder. |
ReceiptCarryingReleased | decimal | yes | Current unapplied liability carrying of consumed ReceiptAmount, not bank value. |
InvoiceFXReleased | decimal | yes | Prior signed unrealized invoice FX in released portion. |
ReceiptFXReleased | decimal | yes | Prior signed unapplied-liability FX in released portion. |
SettlementFXDelta | decimal | yes | Functional noncash + ReceiptCarryingReleased − InvoiceCarryingReleased, gain-positive net application delta; cash receipt does not debit bank again. |
AppliedAt | datetime | Actual committed application time. Absent until the real action; mandatory before the corresponding active/approved/posted state. | |
Journal | reference | → JournalEntries. Dr unapplied liability/noncash expense and Cr AR plus delta FX, with zero-net prior FX reclassification. | |
ReversalOf | reference | → CashApplications. Exact original allocation, carrying/FX and claimed scope restored once. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
RunNumber | text | yes | Unique payment proposal. |
Status | select | yes | Draft, PendingApproval, Released, Submitted, PartiallySettled, Settled, Exception, Closed, Cancelled |
PaymentDate | date | yes | Intended execution date. |
PreparedBy | reference | yes | → Users. Accountant. |
ReleasedAt | datetime | Independent Finance Manager release excluding preparer/material editors and underlying bill exception approver where required; use a different eligible FM person. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
PaymentNumber | text | yes | Stable disbursement. |
Run | reference | yes | → PaymentRuns. Approved exact run revision. |
Supplier | reference | yes | → Suppliers. Same-entity beneficiary. |
BankAccount | reference | yes | → BankAccounts. Actual independently authorized same-entity source cash account and payment currency. |
Beneficiary | reference | yes | → SupplierBankAccounts. Approved exact beneficiary version. |
BeneficiaryHash | text | yes | Must equal released destination; changes invalidate unsent authorization. |
Currency | reference | yes | → Currencies. Bank/payment currency. |
Amount | decimal | yes | Positive proposed payment-currency total allocated or explicitly supplier prepayment. |
Status | select | yes | Reserved, Released, Submitted, Accepted, Uncertain, Settled, Rejected, Returned, Cancelled |
Instruction | reference | → IntegrationDeliveries. Intent/attempt, not settlement proof. | |
SettlementEvent | reference | → IntegrationEvents. Actual authenticated/manual-confirmed bank outcome. | |
SettledAt | datetime | Actual verified company bank/cash settlement time; an instruction, transport acknowledgment or approval does not set it. | |
BankCarryingReleased | decimal | Current functional cash carrying actually disposed at settlement, with exact prior FX and no second AP payment. | |
Journal | reference | → JournalEntries. Actual confirmed cash settlement clears current AP or creates supplier prepayment once, with explicit currency/current-carrying/prior FX components. | |
PrepaymentRemaining | decimal | yes | Unapplied supplier-prepayment amount remaining in payment currency; zero for fully bill-allocated disbursement. |
PrepaymentCarrying | decimal | yes | Functional remaining supplier-prepayment asset with its own revaluation where monetary. |
PrepaymentFX | decimal | yes | Signed prior unrealized FX on remaining prepayment. |
PrepaymentReserved | decimal | yes | Active application/refund claims reduce availability; never send bank cash again to apply a settled prepayment. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
AllocationNumber | text | yes | Unique payment/bill allocation. |
Payment | reference | yes | → Payments. Parent economic disbursement. |
Bill | reference | → Bills. Posted same-supplier debit; null only explicit approved supplier prepayment. | |
Status | select | yes | Reserved, Settled, Released, Reversed |
PaymentAmount | decimal | yes | Positive payment-currency actual cash portion, reserved once before independently released settlement. |
BillCashAmount | decimal | yes | Exact bill-currency actual settlement portion; zero only for explicit approved supplier prepayment. |
DiscountAmount | decimal | yes | Approved bill-currency discount, not cash consumed. |
PaymentRate | reference | yes | → ExchangeRates. Exact settlement conversion. |
BillRate | reference | yes | → ExchangeRates. Exact bill settlement basis. |
FunctionalSettlement | decimal | yes | Actual company bank/cash settlement functional value with exact current-carrying, approved discount and FX components; source currency and bill currency retained separately, no external bank-funding branch. |
BillCarryingReleased | decimal | yes | Current AP carrying of settled portion. |
BillFXReleased | decimal | yes | Prior unrealized AP gain-positive amount, reclassified zero-net. |
SettlementFXDelta | decimal | yes | BillCarryingReleased − FunctionalSettlement, gain-positive AP delta; bank disposal FX is separate. |
SettledAt | datetime | Actual effect time. | |
ReversalOf | reference | → PaymentAllocations. Original settlement reversal linked to bank return; same scope cannot reopen twice. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
CreditApplicationNumber | text | yes | Unique economic use. |
Side | select | yes | Customer, Supplier |
CreditInvoice | reference | → Invoices. Customer CreditNote; mutually exclusive with CreditBill. | |
CreditBill | reference | → Bills. Supplier CreditNote. | |
DebitInvoice | reference | → Invoices. Same actual customer/entity debit; no cross-party credit transfer by matching a deal label. | |
DebitBill | reference | → Bills. Same supplier/entity debit target. | |
CreditAmount | decimal | yes | Positive credit-currency use; active Reserved amounts subtract availability. |
DebitAmount | decimal | yes | Positive debit-currency settlement equivalent. |
RateEvidence | longtext | yes | Frozen pair/date/type/multipliers and carrying/FX allocations; same-currency identity explicit. |
Status | select | yes | Reserved, Posted, Released, Reversed |
CreatedAt | datetime | yes | Atomic claim time. |
PostedAt | datetime | Actual zero-cash clearing. | |
Journal | reference | → JournalEntries. Clear credit-control and debit-control current carrying, remaining difference FX; reclassify prior unrealized zero-net. | |
ReversalOf | reference | → CreditApplications. Exact prior claim. | |
SupplierPrepayment | reference | → Payments. Alternative actually settled available same-supplier prepayment, XOR CreditBill; exact source claim and no new cash on application. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
RefundNumber | text | yes | Unique refund/claim. |
Direction | select | yes | ToCustomer, FromSupplier |
CreditInvoice | reference | → Invoices. One customer-credit funding source. | |
CashReceipt | reference | → CashReceipts. Alternative unapplied-customer-cash funding source; XOR CreditInvoice, never both. | |
CreditBill | reference | → Bills. Supplier-credit collection source for FromSupplier. | |
Currency | reference | yes | → Currencies. Actual bank/cash settlement currency; SourceAmount stays in original credit/receipt/prepayment currency. |
Amount | decimal | yes | Positive cash amount. |
SourceAmount | decimal | yes | Amount consumed in source document/receipt currency, separate from bank currency. |
SourceCarrying | decimal | yes | Current functional funding value released. |
RateEvidence | longtext | yes | Exact equivalent amount, bank carrying and prior FX reclassification basis. |
BankAccount | reference | yes | → BankAccounts. Required actual same-entity cash account with protected recipient/funding route. |
Status | select | yes | Draft, PendingApproval, Reserved, Released, Submitted, Uncertain, Settled, Rejected, Returned, Cancelled, Held |
Instruction | reference | → IntegrationDeliveries. Transport intent only. | |
SettlementEvent | reference | → IntegrationEvents. Authoritative actual cash outcome. | |
SettledAt | datetime | Actual posting time. | |
Journal | reference | → JournalEntries. Funding control against actual cash/current carrying once plus reviewed FX; credit-funded refund preserves original receipt and cash applications. | |
SupplierPrepayment | reference | → Payments. Alternative FromSupplier funding collection; XOR CreditBill. | |
Method | select | yes | Bank, Cash |
SourceRoute | select | yes | LocalGoods. PMS guest/corporate charges, receipts, deposits and refunds cannot create this record or replay their GL bridge. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
CorrectionNumber | text | yes | Unique economic correction. |
Kind | select | yes | CashReturn, PaymentReturn, RefundReturn, InvoiceReversal, BillReversal, WriteOff, BankFee, PostingCorrection, OpeningCorrection, PMSResolution |
Status | select | yes | Draft, PendingApproval, Approved, Posted, Rejected |
SourceTable | text | yes | Exact existing source type. |
SourceKey | text | yes | Original immutable source/effect identity. |
Scope | longtext | yes | Exact original amount/currencies/current carrying/prior FX/tax/cost and actor/source lineage; each original claim restored once only after dependent effects reconcile. A credit/correction never releases stock quality or erases actual batch/lot history. |
OccurredAt | datetime | yes | Actual evidence date/time. |
PostingDate | date | yes | Eligible current posting date, not rewritten original. |
Period | reference | yes | → AccountingPeriods. Same entity open period. |
Journal | reference | → JournalEntries. Compensates only traced effects; new fee/rate difference separately identified. | |
PMSTenderSettlement | reference | → PMSTenderSettlements. Required for PMSResolution: original actual unmatched bank/suspense source. Exact new PMSTenderAllocations Kind SuspenseResolution consume both its remaining suspense and shared PMSBalanceSources tender claims atomically; Journal clears suspense against tender/current FX/explicit once-only fee, never bank or guest revenue again. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
RunNumber | text | yes | Unique cutoff run. |
Period | reference | yes | → AccountingPeriods. Same entity. |
Status | select | yes | Draft, Calculated, PendingApproval, Approved, Posted, Reversed |
AsOf | datetime | yes | Frozen monetary population/cutoff. |
SourceHash | text | yes | Current reconciled open item/bank/unapplied/credit balances and rates; stale changes require recalculation. |
PostedAt | datetime | Actual delta posting. | |
Journal | reference | → JournalEntries. Balance changes versus unrealized FX, exactly once. |
| Field | Type | Required | Details |
|---|---|---|---|
Run | reference | yes | → RevaluationRuns. Reviewed cutoff. |
SourceTable | select | yes | Invoices, Bills, CashReceipts, BankAccounts, Payments, PMSBalanceSources, PMSTenderSettlements |
SourceKey | text | yes | Exact remaining source and asset/liability kind. PMSBalanceSources and PMSTenderSettlements monetary suspense reconcile source/period FXOwnership before local delta; PMS-supplied full FX and local full FX cannot both post. Fully settled amount requires zero carrying/prior FX; closed original bank movement is never revalued as another suspense source. |
Currency | reference | yes | → Currencies. Source currency. |
OpenAmount | decimal | yes | Remaining signed economic currency balance, positive magnitude plus source debit/liability direction. |
Rate | reference | yes | → ExchangeRates. Reviewed Closing rate to entity functional currency. |
BeforeCarrying | decimal | yes | Current functional carrying before this delta. |
AfterCarrying | decimal | yes | OpenAmount × rate using source normal balance. |
Delta | decimal | yes | After − before; gain sign determined by asset/liability, not an unconditional profit. |
PriorFX | decimal | yes | Retained signed prior unrealized FX. |
Status | select | yes | Calculated, Posted, Reversed |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
Revision | number | yes | Positive monotonic working revision; submitted content is immutable. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content and material source snapshots. | |
CreatedBy | reference | yes | → Users. Actual preparer person; material editors retained in snapshot. |
CreatedAt | datetime | yes | Offset-aware creation timestamp. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
Decision | reference | → ApprovalDecisions. Current valid independent decision for this revision, amount, entity and action. | |
JournalNumber | text | yes | Unique entity journal. |
Kind | select | yes | Trade, Stock, WIP, Cash, CashTransfer, Tax, FX, Reclassification, Manual, Opening, Correction, PMSBridge, PMSTenderSettlement, DepartmentUse |
Status | select | yes | Draft, PendingApproval, Approved, Posted, Reversed |
PostingDate | date | yes | Date in eligible Period. |
Period | reference | yes | → AccountingPeriods. Same entity. |
SourceTable | text | yes | Existing typed source or explicitly authorized Manual/Opening evidence. |
SourceKey | text | yes | Unique economic source/effect; a second transport event cannot repost it. |
PostedAt | datetime | Actual local posting. | |
ReversalOf | reference | → JournalEntries. Exact prior journal/line source; no destructive editing. | |
CashTransferFrom | reference | → BankAccounts. Required for CashTransfer; source Bank/CashOnHand/CashInTransit under actual custody evidence, same entity and different from destination. | |
CashTransferTo | reference | → BankAccounts. Actual same-entity cash-transfer destination with actual source/destination evidence; no second customer receipt/revenue or supplier payment. | |
CashTransferSourceAmount | decimal | Positive actual source-currency amount, exclusively reserved against source cash availability until confirmed movement. | |
CashTransferDestinationAmount | decimal | Positive actual destination-currency amount; same-currency identity explicit, foreign conversion separately evidenced. | |
CashTransferSourceCarrying | decimal | Exact positive current functional carrying removed from source with prior FX allocation. | |
CashTransferDestinationValue | decimal | Actual positive functional value received at destination; difference is reviewed FX/fee, never invented rounding or revenue. | |
CashTransferEvidence | longtext | Actual custody/bank confirmation, finite source claim and recipient/amount/FX/fee proof. Cash handed to transit is not bank receipt; second actual deposit consumes only remaining transit scope. | |
CashTransferStatement | reference | → BankStatementLines. Required actual bank evidence for bank leg; cash-only custody needs reviewed manual proof. | |
PriorCashTransfer | reference | → JournalEntries. Exact earlier CashTransfer transit leg; later deposit/reversal cannot consume more than remaining in-transit source. |
| Field | Type | Required | Details |
|---|---|---|---|
Journal | reference | yes | → JournalEntries. Same entity source. |
LineNumber | number | yes | Stable line. |
Account | reference | yes | → ChartOfAccounts. Same entity; source-specific control mappings required. |
Debit | decimal | yes | Nonnegative, not both debit and credit positive. |
Credit | decimal | yes | Nonnegative. |
OriginalCurrency | reference | → Currencies. Foreign source denomination where relevant. | |
OriginalAmount | decimal | Source amount with explicit sign/basis, not another posting. | |
SourceAllocation | longtext | yes | Exact stock/receipt/invoice/payment/WIP/PMS source-component/tender/department/FX source allocation and rule version. PMS control accounts require PMS source ownership; direct manual journals cannot bypass it. |
Property | reference | → Properties. Required property attribution for property/PMS/department effects; same entity. Corporate-only lines explicitly identified by approved accounting policy. | |
Department | reference | → PropertyDepartments. Actual cost/custody allocation for DepartmentUse or kitchen work, not another additive journal. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; every linked monetary/owned-stock source must agree. |
OperationKey | text | yes | Unique economic effect key; same key/hash returns same result, different content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
AcceptanceNumber | text | yes | Unique arrival/tranche identity; duplicate callbacks reuse it. |
ReceiptLine | reference | yes | → GoodsReceiptLines. One immutable actual arrival line. |
Disposition | select | yes | Accept, Reject |
Status | select | yes | Prepared, PendingReview, Confirmed, Posted, Reversed |
BaseQuantity | decimal | yes | Positive tranche quantity; active confirmed tranches cannot exceed arrived quantity less previous live tranches. |
StandardCost | reference | → StandardCosts. Required for accepted owned-stock effect; frozen version. | |
ReceiptRate | reference | → ExchangeRates. Required dated receipt valuation multiplier. | |
CommercialFunctionalValue | decimal | Accepted scoped PO net/approved capitalizable charges at receipt rate; zero only approved known-zero basis. | |
ConfirmedBy | reference | → Users. Actual independent Warehouse Operator, not PO buyer/commercial approver; null until confirmation and mandatory before Confirmed/Posted with required condition/cost evidence. | |
ConfirmedAt | datetime | Actual physical disposition confirmation. | |
Evidence | longtext | yes | Independent quantity/condition/ownership/cost evidence and required WM/FM exceptions; Accept may post OWNED HELD inventory/GRNI while quality tests remain pending. Reject without accepted ownership creates no owned posting. Bill receipt/match does not quality-release stock. |
StockEvent | reference | → StockEvents. Accepted tranche posts quantity/standard value/GRNI/variance once; rejection has no owned posting. | |
ReversalOf | reference | → ReceiptAcceptances. Exact prior tranche only after downstream stock/match/return effects reconcile. | |
Portion | reference | → LotPortions. Required for lot-controlled food scope before actual receipt/claim/issue/move/count/title/return/value effect; exact nonaggregate leaf, matching product/entity/Lot. Null only genuine non-lot scope or an unconfirmed draft. Historical references survive split/consumption; current effect cannot debit a depleted ancestor. | |
QualityState | select | yes | Held, Released, Rejected |
QualityEvidence | longtext | yes | Actual specification/portion/date/label/storage requirements and independent Kitchen Manager release where complete; default Held for unresolved required tests. Quantity acceptance is not a fitness conclusion. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; source parties, prices, stock ownership, postings and authority must agree. |
LotNumber | text | yes | Unique entity/product/lot identity; display identifier alone is insufficient across products/entities. |
Product | reference | yes | → Products. Controlled SKU. |
Supplier | reference | → Suppliers. Original supplier when incoming. | |
SourceReceipt | reference | → GoodsReceiptLines. Immutable arrival source; current stock remains separate. | |
SourceCompletion | reference | → ProductionCompletions. Manufactured output source. | |
ExpiresAt | datetime | Optional aggregate display of most restrictive applicable known portion boundary; actual eligibility uses exact LotPortions date history, never this header alone. | |
Status | select | yes | PendingReview, Released, Held, Exhausted |
Provenance | longtext | yes | Actual original source and all portion/split/production lineage. Header Status is aggregate display only: partial release can never authorize all lot positions; every use checks exact portion plus all ancestor/global holds and dates. |
ExternalLotCode | text | yes | Actual supplier/manufacturer lot identity and source retained through internal population splits; internal PortionNumber is not a newly asserted external/regulatory code. |
SourceIdentity | longtext | yes | Actual lot-code source party/location/receipt/manufacturing evidence and parent transformation genealogy; imported unknowns explicitly flagged, no invented traceability certification. |
SupplierDeclarations | longtext | yes | Actual received ingredient/packaging/specification/allergen source version and conflicts with approved recipe expectations; unknown or conflict holds affected quality review. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; source parties, prices, stock ownership, postings and authority must agree. |
SerialNumber | text | yes | Unique entity/product serial identity with immutable provenance. |
Product | reference | yes | → Products. Serial-controlled SKU. |
Lot | reference | → Lots. Matching lot when also lot-controlled. | |
Status | select | yes | PendingReview, InStock, InProduction, Shipped, Returned, Scrapped |
Provenance | longtext | yes | Original receipt/output, exact net current position and all movement/return links; status is derived from actual events. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; linked commercial, stock and financial source ownership must agree. |
OperationKey | text | yes | Stable economic action identity; identical content returns the same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated external or reviewed manual evidence with source identity/hash. | |
PortionNumber | text | yes | Unique internal population/container identity within Lot; physical marking or equivalent segregation evidence required before separate release. |
Lot | reference | yes | → Lots. Immutable entity/product external source-lot identity; internal split never asserts a new supplier/manufacturer lot. |
Parent | reference | → LotPortions. Same lot ancestor; acyclic. Parent stock is replaced by disjoint leaf children, not retained alongside them. | |
IsAggregate | boolean | yes | True for parent whose whole population was split; cannot be an active stock/reservation/issue/release leaf. |
OriginalQuantity | decimal | yes | Immutable quantity present at this population creation in its product base unit. Split child original quantities sum the remaining physically present stock plus WIP scope being split, not already consumed/delivered history; older parent OriginalQuantity remains historical and is never added to children. |
PopulationEvidence | longtext | yes | Actual container/segregation identities and source time, plus immutable split map of current stock, still-physical WIP and live claim slices. Splitting a parent spanning stock/WIP maps every remaining physical source to disjoint children atomically; original issued/consumed/cost history is unchanged. Historical allocations may retain ancestor IDs, while new effects prove exact descendant/source lineage. |
CurrentStockQuantity | decimal | yes | Derived net current position quantity for this leaf only; no independent stock owner or addition of ancestors. |
CurrentWIPQuantity | decimal | yes | Derived actual physically remaining identifiable in-process material in its own unit; issued unused stock is WIP custody, not inventory. Material lost/evaporated or incorporated into completed output is not counted as physically remaining merely because its cost stays in WIP. Financial WIP is separate. |
Status | select | yes | PendingReview, Held, Released, Exhausted, Disposed, Aggregate |
ParentSplitEvent | reference | → StockEvents. One scoped split identity balances current stock movements and maps still-physical WIP/claims into disjoint leaves without new WIP cost or GL. Immutable prior issue/cost/input references remain; new actions resolve the exact descendant mapping, never debit a depleted aggregate ancestor. | |
ManufacturedAt | datetime | Current evidenced manufacture time derived from immutable applicable LotDateEvents; inherited history survives splits. | |
FirstOpenedAt | datetime | Earliest actual applicable opening for this population/ancestor; partial opening requires a separate identifiable child first. | |
ExpiresAt | datetime | Current effective expiry after all applicable source/policy/history constraints; unknown required boundary blocks use. | |
BestBeforeAt | datetime | Evidence-backed quality-date boundary, distinct from expiry and reviewed policy consequences. | |
OpenLifeEndsAt | datetime | Current first-opening plus reviewed life or earlier applicable bound; does not reset on reseal/repack. | |
DateBasis | longtext | yes | Exact applicable policy/event versions, parent inheritance, timezone/date cutoffs and reviewed corrections; no copied dates without provenance. |
Version | number | yes | Atomic population/eligibility revision shared by splits, claims, date and hold changes. |
CreatedAt | datetime | yes | Actual internal population creation time, not manufacture date. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; linked commercial, stock and financial source ownership must agree. |
Revision | number | yes | Positive monotonic content revision; submitted/material editors and accepted scope are immutable. |
Snapshot | reference | → DocumentRevisions. Exact source terms/lines/amounts/party/actor/policy hash; required before review and effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity, not a role alias. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
PolicyNumber | text | yes | Unique product/version. |
Product | reference | yes | → Products. Exact controlled item/base-unit identity. |
Status | select | yes | Draft, PendingApproval, Active, Superseded |
EffectiveFrom | datetime | yes | Inclusive; active policy changes do not silently rewrite existing lots/batches. |
EffectiveTo | datetime | Exclusive. | |
DateTimezone | text | yes | Explicit location/contract timezone for date-only source cutoffs; normalized actual instants retained. |
ManufactureRequired | boolean | yes | True when manufacture anchor is mandatory; missing date holds affected population. |
ExpiryRequired | boolean | yes | True when actual supplier or derived expiry is mandatory. |
ShelfLifeDays | decimal | Known nonnegative calendar-day life from actual manufacture under explicit convention; null means no derived-life rule, not indefinite fitness. | |
BestBeforeDays | decimal | Optional reviewed manufacture-based quality boundary. | |
OpenLifeHours | decimal | Known nonnegative life from first actual opening, required where selected; no reseal reset. | |
BestBeforeAction | select | yes | Block, ReviewRequired, AllowWithReviewedPolicy |
MinimumLifeRule | longtext | yes | Product/customer constraints in compatible calendar units and actual agreed delivery-date basis. Missing required date/transport allowance is review, not unlimited shelf life. |
RepackRule | longtext | yes | Preserve original source manufacture/open-life/expiry and apply any newly justified tighter output constraints. Repack never extends life by default; transformed output needs approved actual process evidence and source constraints. |
EvidenceRule | longtext | yes | Supplier/manufacturing date evidence, unknown handling, storage conditions and permitted correction/extension review; no universal food-safety threshold or legal date claim. |
Activation | reference | → MasterChanges. Independent Kitchen Manager, excluding preparer/material criteria editors; Kitchen Manager technical implications separately reviewed. | |
DateCutoffRule | longtext | yes | Explicit interpretation of each date-only label: last permissible local date ends at the next local midnight exclusive when configured, or actual supplied instant. Calendar-day rules preserve local calendar/timezone; OpenLifeHours uses elapsed hours. Minimum life uses its stated calendar/date or elapsed basis, never mixes conventions or guesses a missing cutoff. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; linked commercial, stock and financial source ownership must agree. |
Revision | number | yes | Positive monotonic content revision; submitted/material editors and accepted scope are immutable. |
Snapshot | reference | → DocumentRevisions. Exact source terms/lines/amounts/party/actor/policy hash; required before review and effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity, not a role alias. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
OperationKey | text | yes | Stable economic action identity; identical content returns the same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated external or reviewed manual evidence with source identity/hash. | |
Decision | reference | → ApprovalDecisions. Exact current independent action/scope/revision authority, mandatory before the corresponding authorized effect. | |
DateEventNumber | text | yes | Unique source occurrence/decision identity. |
Portion | reference | yes | → LotPortions. Exact leaf or explicitly whole ancestor scope; opening a partial amount requires prior physical split. |
Kind | select | yes | Manufacture, Receipt, SupplierDateEvidence, FirstOpening, Reassessment, Correction |
Status | select | yes | Recorded, PendingReview, Approved, Applied, Rejected, Superseded |
OccurredAt | datetime | yes | Actual event or evidence occurrence; approval timestamp is separate. |
RecordedBy | reference | yes | → Users. Actual Warehouse Operator, Kitchen Operator, Kitchen Operator or authorized importer; factual observer is not date-extension approver. |
ManufacturedAt | datetime | Actual manufacture evidence, not receipt/repack date substituted automatically. | |
ExpiryAt | datetime | Evidenced supplier/approved effective boundary where provided. | |
BestBeforeAt | datetime | Separate evidence-backed boundary. | |
OpenedAt | datetime | Actual first opening of this exact physical population; absent for unopened stock. | |
Policy | reference | yes | → ShelfLifePolicies. Exact applicable approved version. |
SourceEvidence | longtext | yes | Original document/event/hash, timezone/date interpretation, actual process/storage basis, previous/new values and affected descendants/commitments. |
CorrectionOf | reference | → LotDateEvents. Exact incorrect prior fact or reassessment chain; history preserved and downstream uses/deliveries reviewed before application. | |
ApprovedBy | reference | → Users. Independent Kitchen Manager for protected original date approval, correction or extension, excluding preparer/material editors. | |
ApprovedAt | datetime | Actual protected decision. | |
AppliedAt | datetime | Atomic scoped projection update; all affected claims revalidated without erasing performed work. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; linked commercial, stock and financial source ownership must agree. |
OperationKey | text | yes | Stable economic action identity; identical content returns the same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated external or reviewed manual evidence with source identity/hash. | |
Decision | reference | → ApprovalDecisions. Exact current independent action/scope/revision authority, mandatory before the corresponding authorized effect. | |
AllocationNumber | text | yes | Stable batch/source/action/slice identity. |
WorkOrder | reference | yes | → WorkOrders. One released recipe batch. |
Material | reference | yes | → WorkOrderMaterials. Exact frozen ingredient/packaging requirement. |
SourceCost | reference | yes | → WorkOrderCostEntries. Original posted MaterialIssue, retaining source layer/lot/portion and original base-unit carrying. |
InputPortion | reference | yes | → LotPortions. Actual input population at the action: same original issue lot/product/entity and original portion or evidenced current descendant in its immutable split map. Past allocations retain original identity; new use/return must select a current leaf mapping to that issue source and cannot invent additional issued availability. |
Kind | select | yes | Use, NormalProcessLoss, PackagingLoss, AbnormalScrap, OutputAllocation, UnusedReturn, Correction |
Status | select | yes | Prepared, Reserved, Confirmed, Posted, Released, Reversed |
BaseQuantity | decimal | yes | Positive input-product base quantity. Use, NormalProcessLoss, PackagingLoss and AbnormalScrap are DISJOINT physical-consumption slices against SourceCost; their sum cannot exceed original issue less actual returns/other use/active claims. OutputAllocation only allocates already consumed SourceUse, never consumes input again. If process evaporation cannot be assigned in an input unit, retain it as non-consuming measured output loss in BatchReconciliations, not a second material claim. |
FunctionalAmount | decimal | yes | Exact corresponding source cost at original issue basis with final remainder; known zero valid. No mixed-currency or unrelated input-value sum. |
SourceUse | reference | → BatchMaterialAllocations. Required OutputAllocation parent: confirmed Use or NormalProcessLoss/PackagingLoss with LossTreatment IncludedInOutput. Claims consume remaining parent quantity/value once. SeparateScrap parents use their approved scrap relief only, never output allocation; no orphaned packaging-loss cost. | |
Completion | reference | → ProductionCompletions. Required OutputAllocation terminal output slice; same approved batch, one exact output lot/portion. No extra finished stock from this trace row. | |
OutputPortion | reference | → LotPortions. Actual completion output population; must match Completion; no invented lot for process loss. | |
ProductionEntry | reference | → ProductionEntries. Actual operation evidence for use/loss/packaging consumption. | |
CostRelief | reference | → WorkOrderCostEntries. Exact one completion/scrap/unused-return relief journal owner; these allocations explain its consumed sources, not another posting. | |
ExposureBasis | select | yes | CommingledBatch, PhysicallySegregatedScope, PackagingScope, Unknown |
ExposureEvidence | longtext | yes | Commingled ingredient can affect ALL batch output/descendants independent of allocated input cost fraction. Narrower exposure requires actual segregation evidence. Unknown input/output connection creates explicit conservative unresolved scope; allocation does not guarantee clean trace. |
RemainingUseQuantity | decimal | yes | On confirmed Use or IncludedInOutput normal/packaging loss only: source consumed quantity minus net posted output allocations; child and SeparateScrap rows0. Packaging-loss allocation therefore has an explicit completion path. Actual input consumption remains preserved, not restored when cost is allocated. |
RemainingUseValue | decimal | yes | Same included-output source remaining cost after posted allocation; normal process/packaging loss included here cannot also be expensed separately. Full final allocation takes exact residual, leaving zero quantity/value. |
ReservedQuantity | decimal | yes | On confirmed Use or NormalProcessLoss/PackagingLoss with LossTreatment IncludedInOutput only: active OutputAllocation quantity claims against current RemainingUseQuantity. Child/SeparateScrap rows hold0 here and own their BaseQuantity claim by status. Posted allocation already reduces remaining and is not subtracted twice. |
ReservedValue | decimal | yes | On original source only: active OutputAllocation source-cost claims; child0. Same exact quantity/cost source basis and statuses, no second reservation. |
OccurredAt | datetime | yes | Actual operation/allocation evidence time. |
PostedAt | datetime | Actual committed use/cost-claim effect. | |
ReversalOf | reference | → BatchMaterialAllocations. Exact source with output, quality, genealogy and cost consequences reconciled before restoration. | |
LossTreatment | select | yes | NotLoss, IncludedInOutput, SeparateScrap |
ConfirmedAt | datetime | Actual independently accepted physical use/loss time; confirmation updates original issued-material consumed quantity once. Posted is later same-row financial-allocation effect where needed, never second consumption. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; linked commercial, stock and financial source ownership must agree. |
Revision | number | yes | Positive monotonic content revision; submitted/material editors and accepted scope are immutable. |
Snapshot | reference | → DocumentRevisions. Exact source terms/lines/amounts/party/actor/policy hash; required before review and effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity, not a role alias. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
Decision | reference | → ApprovalDecisions. Exact current independent action/scope/revision authority, mandatory before the corresponding authorized effect. | |
ReconciliationNumber | text | yes | Unique work-order/cutoff/version. |
WorkOrder | reference | yes | → WorkOrders. One recipe batch; prior accepted reconciliation retained. |
Kind | select | yes | Interim, Terminal, Close |
Status | select | yes | Draft, PendingReview, Approved, Rejected, Superseded |
CutoffAt | datetime | yes | Actual retained source/evidence cutoff. |
Basis | select | yes | OutputYield, CompatibleMassBalance, CompatibleVolumeBalance, CountBalance |
MeasureUnit | reference | yes | → UnitsOfMeasure. Declared compatible balance/yield unit. OutputYield compares expected and actual primary output, not a false total ingredient mass. |
ExpectedOutput | decimal | yes | Positive approved reference/target primary output in this unit; recipe scale and changes frozen. |
PhysicalGoodOutput | decimal | yes | Net accepted terminal physical output including valued held output; quality eligibility reported separately, no intermediate throughput sum. |
HeldOutput | decimal | yes | Subset of PhysicalGoodOutput currently quality-held; not added to it again. |
YieldPercent | decimal | 100 times comparable physical output divided by expected output; null if basis incomplete/incompatible, never sum kg+L+each. | |
InputBalances | longtext | yes | Validated per-product/base-unit original issue, actual use, unused return, normal process loss, abnormal scrap and physically unused remainder with exact source allocations. Each source closes in its own dimension; packing each reconciles separately from ingredient mass/volume. No implicit density/potency/catch-weight conversion. |
OutputBalance | longtext | yes | Declared expected/actual primary output, measured compatible process loss, sample/scrap and unfinished scope, deviations and measurement uncertainty. Only claim physical mass/volume closure where ALL included streams share reviewed compatible units; otherwise use output yield and separate per-input balances. |
CostBalance | longtext | yes | Exact source WIP, normal loss included in output basis versus separately approved abnormal scrap, terminal output standard/variance and unrelieved residual. No loss cost relieved twice or completion variance repeated at close. |
QualityDecision | reference | → ApprovalDecisions. Independent Kitchen Manager required condition/label/genealogy exceptions; not substitute for technical quantities or finance value. | |
FinanceDecision | reference | → ApprovalDecisions. Independent Finance Manager nonzero variance/scrap/residual cost authority. | |
ReviewedBy | reference | → Users. Independent Kitchen Manager excluding producer/recorder/reconciliation preparer/editors; null until actual review. | |
ReviewedAt | datetime | Actual independent approval; null while draft/pending. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; source parties, prices, stock ownership, postings and authority must agree. |
PlanNumber | text | yes | Unique product/type/version. |
Product | reference | yes | → Products. Material/output or applicable recipe context. Nonmaterial checks bind actual WorkOrder/operation context and criteria, without invented goods quantity. |
Kind | select | yes | Incoming, InProcess, Final, Return, Storage, Changeover, LabelCheck |
RoutingOperation | reference | → RoutingOperations. Required for operation-specific scope; same compatible product/version. | |
Version | number | yes | Immutable positive revision. |
StartsAt | datetime | yes | Inclusive. |
EndsAt | datetime | Exclusive. | |
SamplingRule | select | yes | EveryUnit, FixedSample, DefinedPopulation, Nonmaterial |
SampleSize | number | Positive bounded minimum for material sampling; nullable and not applicable for Nonmaterial checks. No fictitious goods sample for actual cleaning/changeover context. | |
AcceptanceRule | longtext | yes | Validated required-characteristic completeness, actual sample selection, release population and known bounds. All applicable other tests/holds/date/label/lineage prerequisites remain mandatory. No universal safety threshold, statistical guarantee or legal certification. |
Status | select | yes | Draft, Active, Superseded |
Activation | reference | → MasterChanges. Independent Kitchen Manager specification/sampling/criteria approval excluding preparers/editors; Kitchen Manager additionally approves technical process implications. |
| Field | Type | Required | Details |
|---|---|---|---|
Plan | reference | yes | → KitchenCheckPlans. Frozen plan version. |
CharacteristicCode | text | yes | Unique within plan. |
Name | text | yes | Concrete test/dimension/visual requirement. |
Type | select | yes | Numeric, PassFail |
Unit | text | yes | Measurement unit for Numeric or explicit not-applicable for PassFail. |
LowerLimit | decimal | Known inclusive lower bound when required; no invented zero for unknown. | |
UpperLimit | decimal | Known inclusive upper bound when required, >= lower. | |
Required | boolean | yes | Missing required result blocks decision. |
Method | longtext | yes | Reviewed inspection method, equipment fitness/evidence requirements and allowed tolerances; no automatic certification claim. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; source parties, prices, stock ownership, postings and authority must agree. |
Revision | number | yes | Monotonic working revision; submitted content and material editors frozen. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content/source versions; required before approval, acceptance or posting. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
OperationKey | text | yes | Unique economic effect key; same canonical content returns the same effect, conflicting content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
InspectionNumber | text | yes | Unique actual inspection/source/pass identity. |
Plan | reference | yes | → KitchenCheckPlans. Effective frozen version. |
ReceiptLine | reference | → GoodsReceiptLines. Incoming source. Exactly one actual material source family: receipt, production entry/completion, return, or explicit Portion plus Location for a storage check. Nonmaterial cleaning/changeover binds WorkOrder/operation context instead. | |
ProductionEntry | reference | → ProductionEntries. First-article/in-process/final observed work; same product/operation. | |
Completion | reference | → ProductionCompletions. Exact terminal output source: inspect the evidenced output population before or after its valued Held stock posting. Quality release changes eligibility only and never posts stock/value again; full physical completion cannot require an already-released quality status. | |
ReturnLine | reference | → ReturnLines. Actual returned custody source. | |
Product | reference | yes | → Products. Matches source/plan. |
Lot | reference | → Lots. Required controlled population identity. | |
Serial | reference | → Serials. Individual identity when inspecting one serial; multi-serial scope explicitly enumerated in PopulationEvidence. | |
PopulationQuantity | decimal | Positive actual material population quantity where applicable; null for nonmaterial batch checks with explicit work-order scope. No invented goods count for cleaning. | |
SampleQuantity | decimal | Positive sampled quantity no more than material population for actual material tests; null for nonmaterial batch prerequisite check, whose required criteria/results must still be complete. | |
PopulationEvidence | longtext | yes | Actual population/source/unit/sample selection for material checks; nonmaterial checks identify exact released work-order/operation/changeover and required criteria without fabricated goods. All relevant tests/holds must clear independently. A passing sample cannot release unrelated populations. |
Status | select | yes | Planned, InProgress, PendingReview, Passed, Failed, Held, Corrected |
Inspector | reference | yes | → Users. Actual qualified scoped Kitchen Operator independent of physical producer/receiver whose work is inspected; records facts, does not release its own observation packet. |
StartedAt | datetime | Actual inspection start, absent while merely Planned; planned scheduling is not an observation timestamp. | |
CompletedAt | datetime | Actual completed observations and decision time. | |
Decision | reference | → ApprovalDecisions. Independent Kitchen Manager KitchenFitness check acceptance, excluding physical producer/receiver, actual inspector and criteria/packet material editors. Nonmaterial checks use this decision directly, without a material KitchenDispositions record or invented portion/quantity. | |
CorrectionOf | reference | → KitchenChecks. Prior inspection; released/consumed/shipped scope traced before corrective action. | |
PlannedStart | datetime | yes | Planned inspection window start, distinct from actual StartedAt. |
PlannedEnd | datetime | yes | Planned later end; production release cannot presume inspection completion. |
Portion | reference | → LotPortions. Required for actual material/label population; null for an explicitly nonmaterial batch changeover/cleaning check with WorkOrder/context evidence. Partial physical release requires identifiable segregated leaf portions. | |
WorkOrder | reference | → WorkOrders. Required batch context for nonmaterial changeover/cleaning/process prerequisite checks; no fabricated stock population. Material tests instead bind actual source population. | |
Location | reference | → Locations. Actual storage observation location when that source family is selected; same property/product/portion context. Observations are manual/imported evidence, not live sensors. |
| Field | Type | Required | Details |
|---|---|---|---|
Inspection | reference | yes | → KitchenChecks. Parent immutable observed scope. |
Characteristic | reference | yes | → KitchenCheckCriteria. Must belong to frozen plan. |
SampleKey | text | yes | Exact actual material sample/serial/point, or exact nonmaterial work-order/operation/check-context identity; unique criterion/observation per pass. Never invent a sampled unit for cleaning. |
NumericResult | decimal | Numeric result for Numeric criterion; missing remains null and prevents required completion. | |
PassResult | boolean | Explicit observation for PassFail criterion; missing is not pass. | |
Outcome | select | yes | Pass, Fail, Missing, Invalid |
ObservedAt | datetime | Actual recorded observation instant; null until result exists, required for non-Missing completed observation. | |
ObservedBy | reference | → Users. Actual Kitchen Operator observer; null until observed, required for a completed result. | |
Evidence | longtext | yes | Measurement unit/method, instrument fitness evidence where required, source/photo/document hash; no calibration system implied. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; source parties, prices, stock ownership, postings and authority must agree. |
OperationKey | text | yes | Unique economic effect key; same canonical content returns the same effect, conflicting content is ReviewRequired. |
Event | reference | → IntegrationEvents. Authenticated inbound event or reviewed manual evidence. | |
HoldNumber | text | yes | Stable containment scope identity. |
Product | reference | yes | → Products. Affected SKU. |
Lot | reference | → Lots. Affected controlled lot scope. | |
Serial | reference | → Serials. Exact serial where applicable. | |
Position | reference | → InventoryPositions. Current physical identity when present; descendant scope retained beyond relocation. | |
WorkOrder | reference | → WorkOrders. In-process scope when no finished position exists. | |
Inspection | reference | → KitchenChecks. Triggering inspection. | |
Scope | longtext | yes | Exact product/lot/portion/ancestor/batch quantities, occurrence, descendant exposure and reason. All overlapping holds apply; releasing one cannot clear another. Moved/reserved scope remains restricted; performed service/delivery remains historical and enters bounded incident/restriction review, never fictional stock rollback or an implied factory withdrawal campaign. |
Status | select | yes | Active, PartiallyReleased, Released, Closed |
PlacedBy | reference | yes | → Users. Any authorized actual operational/quality person may immediately restrict unsafe/unverified scope. Only independent Kitchen Manager decision can release its exact hold; no Admin override. |
PlacedAt | datetime | yes | Actual restriction time. |
ReleasedBy | reference | → Users. Independent Kitchen Manager excluding producer/receiver/inspector/criteria/disposition preparers as applicable; resolves only this hold, leaving every other applicable hold effective. | |
Portion | reference | → LotPortions. Actual affected leaf or ancestor scope; propagates to corresponding moved/split/transformed descendants under reviewed exposure rules. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. Owning legal entity; source parties, prices, stock ownership, postings and authority must agree. |
Revision | number | yes | Monotonic working revision; submitted content and material editors frozen. |
Snapshot | reference | → DocumentRevisions. Exact reviewed content/source versions; required before approval, acceptance or posting. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
Decision | reference | → ApprovalDecisions. Current valid independent action/scope/revision decision, required before corresponding action. | |
DispositionNumber | text | yes | Unique source population/action decision. |
Inspection | reference | → KitchenChecks. Observed actual scope. | |
Hold | reference | → KitchenHolds. Specific hold scope to release/rework/close. | |
Action | select | yes | Release, Rework, Scrap, ReturnToSupplier, RetainHold, Reject |
BaseQuantity | decimal | yes | Positive bounded actual identified population quantity. Release applies whole named leaf portions; partial requested quantity first requires evidenced physical segregation/split. Never unlock remainder via lot-header status. |
Status | select | yes | Prepared, PendingApproval, Approved, Applied, Rejected, Cancelled |
Evidence | longtext | yes | Exact material population, unit and criteria, current hold/date/fitness basis and separately approved rework/financial effect. Sampling cannot release unrelated scope. Nonmaterial check acceptance uses KitchenChecks.Decision directly; this material-only table always requires real quantity/portion. |
TechnicalDecision | reference | → ApprovalDecisions. Independent Kitchen Manager for rework/routing/deviation impact. | |
CommercialDecision | reference | → ApprovalDecisions. Independent Property Manager plus actual customer acceptance when customer requirements/commitments change. | |
FinanceDecision | reference | → ApprovalDecisions. Independent Finance Manager for scrap/loss/value or credit impact; quality authority alone cannot post financial loss. | |
DecidedBy | reference | → Users. Independent Kitchen Manager excluding physical producer/receiver, inspector, criteria editors and proposed disposition preparer/material editors; another eligible actual manager required for overlap. | |
DecidedAt | datetime | Actual decision time. Absent until the actual action; mandatory for the corresponding confirmed/approved state. | |
AppliedAt | datetime | Actual independent Kitchen Manager guarded eligibility application or linked approved physical action. Release posts no stock/output/value; Warehouse Operator executes actual authorized disposal/return with required WM/FM decisions. | |
Portion | reference | yes | → LotPortions. Exact source identified population; must agree with inspection/hold and all other applicable restrictions. |
TargetPortion | reference | → LotPortions. Existing segregated child for partial action, same original external lot. Required if disposition does not cover the whole original leaf; split itself does not release or add value. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
PropertyCode | text | yes | Unique property identity within entity. |
Name | text | yes | Operational property name. |
Timezone | text | yes | IANA timezone used for service dates and local calendar nights. |
BusinessDateRule | longtext | yes | Declared PMS business-date cutover and interpretation; actual timestamps/ERP posting dates remain separate. A DST night is a calendar night, not fixed24h. |
Status | select | yes | Draft, Active, Suspended, Closed |
PMSConnection | reference | → PMSConnections. Current independently activated source mapping; old source histories remain. | |
Policy | reference | → HospitalityPolicies. Exact entity/property operational and finance policy. | |
Activation | reference | → MasterChanges. Independent Property Manager and Finance Manager mapping/ownership approval, excluding preparers/editors. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
DepartmentCode | text | yes | Unique within property. |
Name | text | yes | Operational department label. |
Kind | select | yes | Kitchen, FoodOutlet, Housekeeping, Storeroom, OtherOperations |
Status | select | yes | Draft, Active, Inactive |
Warehouse | reference | → Warehouses. Owned stock custody location; department alone does not create stock. | |
ExpenseAccount | reference | yes | → ChartOfAccounts. Approved expense/food-cost destination for actual DepartmentUse, distinct from transfer/WIP. |
Owner | reference | yes | → Users. Scoped accountable operational person. |
Activation | reference | → MasterChanges. Property Manager operational and Finance Manager account policy approval. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
RoomTypeCode | text | yes | Stable internal mapped category. |
Connection | reference | yes | → PMSConnections. Source property mapping. |
ExternalKey | text | yes | Source room-type identifier. |
Name | text | yes | Source descriptive name. |
Status | select | yes | Active, Inactive, Unmapped |
SourceEvidence | longtext | yes | Actual versioned definition; capacity/availability comes from dated source snapshot, never sum of local rooms assumed sellable. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
RoomCode | text | yes | Unique property-local physical room id; not global. |
RoomType | reference | yes | → RoomTypes. Current verified mapped type. |
Connection | reference | yes | → PMSConnections. Authoritative assignment/occupancy source. |
ExternalKey | text | yes | Actual source room identity. |
Status | select | yes | Active, Inactive, Unmapped |
PMSOccupancy | select | yes | Vacant, Occupied, Unknown |
LocalReadiness | select | yes | Dirty, InProgress, Clean, Inspected, Restricted, Unknown |
SourceVersion | text | yes | Current confirmed source watermark; stale/unknown blocks dependent promise. |
Version | number | yes | Atomic local room/task/restriction revision. |
ServiceInstructions | longtext | yes | Current purpose-limited access/do-not-disturb/declined-service instructions; no passport/card/full folio data. |
CurrentAssignment | reference | → PMSRoomAssignments. Current verified source assignment, not a local booking. | |
ReadinessInspection | reference | → HousekeepingInspections. Exact still-valid local readiness decision; cannot determine PMS sellability. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
ConnectionNumber | text | yes | Stable source-tenant/property namespace. |
ProviderLabel | text | yes | Actual selected source description; no preinstalled vendor assumed. |
SourceTenant | text | yes | Exact external tenant/environment identity. |
Status | select | yes | Draft, PendingApproval, Active, Suspended, Retired |
Authority | longtext | yes | PMS exclusively owns availability, confirmed reservations/assignments/stay states and guest/corporate folios/financial events. ERP local goods route is separate. |
AuthenticationPolicy | longtext | yes | Configured authentication/verification and protected secret references; never credential payloads in records. |
OrderingPolicy | longtext | yes | Actual version/cursor/snapshot ordering, gap and conflict resync; older adverse evidence remains durable but cannot overwrite current state. |
CommandPolicy | longtext | yes | Permitted request kinds, expected source version, idempotency/nonexecution evidence and exact business owners; transport ack is not external effect. |
FinancialPolicy | longtext | yes | Mirrored PMS detail plus single reviewed local GL bridge; no local PMS-origin Invoices/CashReceipts/refunds. Tender-clearing and direct-bank modes are mutually exclusive per source. |
Activation | reference | → MasterChanges. Property Manager source/operational and Finance Manager financial mapping approval; Admin prepares only. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
MappingNumber | text | yes | Unique connection/source-code/version. |
Connection | reference | yes | → PMSConnections. Same property/entity authority. |
Kind | select | yes | Object, RoomStatus, Request, FinancialComponent, TenderRoute |
SourceCode | text | yes | Actual source object/status/transaction code. |
Status | select | yes | Draft, PendingApproval, Active, Superseded |
EffectiveFrom | datetime | yes | Inclusive source/service-period applicability. |
EffectiveTo | datetime | Exclusive. | |
Rules | longtext | yes | Exact source type, component/wrapper role, permitted local target/control account, currency/tax/fee basis, no generic balancing plug. Unknown codes hold financial effect. |
Account | reference | → ChartOfAccounts. Exact approved finance leg when Kind FinancialComponent/TenderRoute; never inferred from similar label. | |
PostingProfile | reference | → PostingProfiles. Reviewed source-to-balanced-legs policy. | |
Activation | reference | → MasterChanges. Property Manager operational or Finance Manager financial authority as applicable; changes preserve posted sources and require explicit correction, no route flip/replay. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
GuestReferenceNumber | text | yes | Unique internal source reference. |
Connection | reference | yes | → PMSConnections. Source tenant/property. |
ExternalKey | text | yes | Actual guest/group/corporate source identity; null-like unknowns require explicit unmatched reference, not invented person. |
Kind | select | yes | Guest, Group, Corporate, Unresolved |
DisplayName | text | Only actual permitted source name when needed; no mandatory fabricated identity. | |
ContactSummary | longtext | Purpose-limited source contact for authorized front desk use; no passport/payment-card data. | |
Account | reference | → Accounts. Existing actual separately authorized local goods counterparty when the same party is established; no automatic customer creation from every stay. | |
AccessPolicy | longtext | yes | Property/purpose/task scoped; attendants see needed room/service preferences, not unrestricted personal or financial data. |
Status | select | yes | Active, Restricted, Unresolved, Retired |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Connection | reference | yes | → PMSConnections. Exact source tenant/property namespace and authority policy. |
ExternalKey | text | yes | Immutable source object/economic identity within connection/property, never guest name or room label. |
SourceVersion | text | yes | Actual ordered source revision/cursor or equivalent reviewed snapshot watermark; not local arrival order. |
SourceHash | text | yes | Immutable original payload/content hash. Conflicting same version remains review-required. |
OccurredAt | datetime | yes | Actual source occurrence, distinct from local receipt/business date. |
ReceivedAt | datetime | yes | Actual import receipt time. |
Event | reference | → IntegrationEvents. Exact verified received source, with every older/conflicting/adverse payload retained. | |
ReservationNumber | text | yes | Local display identity for exact external reservation. |
Guest | reference | → GuestReferences. Actual protected source party reference; source-only/group stays need no invented personal name. | |
Status | select | yes | Pending, Confirmed, InHouse, Departed, Cancelled, NoShow, Unresolved |
ArrivalDate | date | yes | Source local arrival date; calendar nights use half-open departure. |
DepartureDate | date | yes | Source local departure date, strictly later for overnight stays; source day-use explicitly represented separately in Scope. |
Scope | longtext | yes | Source room-type quantities/stay segments, group/corporate terms, day-use if actually supplied, changes/cancelled/performed history. No alternate room-capacity engine. |
ProjectionState | select | yes | Current, Stale, Gap, Conflict, Unresolved |
Snapshot | reference | → DocumentRevisions. Current verified source projection; original events and earlier versions retained. |
| Field | Type | Required | Details |
|---|---|---|---|
Connection | reference | yes | → PMSConnections. Exact source tenant/property namespace and authority policy. |
ExternalKey | text | yes | Immutable source object/economic identity within connection/property, never guest name or room label. |
SourceVersion | text | yes | Actual ordered source revision/cursor or equivalent reviewed snapshot watermark; not local arrival order. |
SourceHash | text | yes | Immutable original payload/content hash. Conflicting same version remains review-required. |
OccurredAt | datetime | yes | Actual source occurrence, distinct from local receipt/business date. |
ReceivedAt | datetime | yes | Actual import receipt time. |
Event | reference | → IntegrationEvents. Exact verified received source, with every older/conflicting/adverse payload retained. | |
Reservation | reference | yes | → PMSReservations. Actual external parent; same connection/property. |
SegmentNumber | text | yes | Unique source stay-room/segment identity. |
RoomType | reference | yes | → RoomTypes. Confirmed demand type, separate from physical room. |
ArrivalDate | date | yes | Source local half-open stay start. |
DepartureDate | date | yes | Exclusive stay end. |
Status | select | yes | Expected, InHouse, Departed, Cancelled, NoShow, Unresolved |
ActualArrivalAt | datetime | Actual verified PMS check-in instant; no local request substitutes. | |
ActualDepartureAt | datetime | Actual verified PMS checkout instant. | |
Supersedes | reference | → PMSStaySegments. Exact revised segment; prior performed nights/occupancy remain, never double-count both active versions. | |
ServiceInstructions | longtext | yes | Source access/cleaning preferences and applicable dates; protected minimum needed by tasks. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Connection | reference | yes | → PMSConnections. Exact source tenant/property namespace and authority policy. |
ExternalKey | text | yes | Immutable source object/economic identity within connection/property, never guest name or room label. |
SourceVersion | text | yes | Actual ordered source revision/cursor or equivalent reviewed snapshot watermark; not local arrival order. |
SourceHash | text | yes | Immutable original payload/content hash. Conflicting same version remains review-required. |
OccurredAt | datetime | yes | Actual source occurrence, distinct from local receipt/business date. |
ReceivedAt | datetime | yes | Actual import receipt time. |
Event | reference | → IntegrationEvents. Exact verified received source, with every older/conflicting/adverse payload retained. | |
AssignmentNumber | text | yes | Unique external room/segment identity. |
StaySegment | reference | yes | → PMSStaySegments. Confirmed actual source stay unit. |
Room | reference | yes | → Rooms. Actual assigned physical room. |
StartsAt | datetime | yes | Inclusive source assignment/occupancy instant. |
EndsAt | datetime | Exclusive actual end; null while unresolved/open, never guessed checkout. | |
Status | select | yes | Assigned, Occupied, Ended, Cancelled, Conflicted, Unresolved |
Evidence | longtext | yes | Actual room-move/check-in/out source, predecessor, intervals and conflicts; room overlap or local block violation creates discrepancy without erasing received reality. |
Discrepancy | reference | → RoomDiscrepancies. Required conflicting occupancy/local readiness/restriction review. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Connection | reference | yes | → PMSConnections. Exact source tenant/property namespace and authority policy. |
ExternalKey | text | yes | Immutable source object/economic identity within connection/property, never guest name or room label. |
SourceVersion | text | yes | Actual ordered source revision/cursor or equivalent reviewed snapshot watermark; not local arrival order. |
SourceHash | text | yes | Immutable original payload/content hash. Conflicting same version remains review-required. |
OccurredAt | datetime | yes | Actual source occurrence, distinct from local receipt/business date. |
ReceivedAt | datetime | yes | Actual import receipt time. |
Event | reference | → IntegrationEvents. Exact verified received source, with every older/conflicting/adverse payload retained. | |
AvailabilityNumber | text | yes | Unique source query/cursor/date-range identity. |
RoomType | reference | yes | → RoomTypes. Exact source room type. |
FromDate | date | yes | Inclusive local stay-date range. |
ToDate | date | yes | Exclusive range end. |
Availability | longtext | yes | Actual per-date source availability/limits with snapshot completeness and age; pending local requests do not manufacture confirmed capacity. |
ExpiresAt | datetime | yes | Configured maximum usable evidence age; freshness never guarantees acceptance of a later request. |
Status | select | yes | Current, Stale, Gap, Conflict, Superseded |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
OperationKey | text | yes | Stable economic action identity; same content returns same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated source or reviewed manual evidence retaining occurrence/receipt time. | |
Decision | reference | → ApprovalDecisions. Exact current independently approved action/scope/revision; required before corresponding protected effect. | |
RequestNumber | text | yes | Unique logical request across all retry attempts. |
Connection | reference | yes | → PMSConnections. Actual configured destination/source authority. |
Kind | select | yes | CreateReservation, AmendReservation, CancelReservation, RoomMove, CheckIn, CheckOut, ReadinessUpdate, RoomBlockUpdate, ChargeAdjustment, GuestRefund |
Reservation | reference | → PMSReservations. Existing source booking when applicable; Create has no fabricated confirmed parent. | |
StaySegment | reference | → PMSStaySegments. Exact room/stay scope. | |
Room | reference | → Rooms. Physical room action where applicable. | |
Folio | reference | → PMSFolios. Actual protected charge/refund context; no local customer refund/invoice owner. | |
Inspection | reference | → HousekeepingInspections. Exact approved current readiness packet for ReadinessUpdate. | |
ExpectedSourceVersion | text | yes | Existing-object actions bind the current actual object version. CreateReservation instead binds the actual connection/property policy and dated room-type availability snapshot/precondition; no fabricated reservation or version. Retain exact source precondition semantics when the PMS supplies no object version. |
Payload | longtext | yes | Exact action/amount/room/date/recipient and source snapshot. Routine requests need active policy; protected exceptions require independent Property Manager and financial exceptions Finance Manager. |
Status | select | yes | Draft, PendingApproval, Approved, Submitted, Acknowledged, Confirmed, Rejected, Uncertain, Conflict, Cancelled |
FinanceDecision | reference | → ApprovalDecisions. Independent Finance Manager monetary exception/refund/charge authority; actual PMS/provider effect remains separate. | |
Delivery | reference | → IntegrationDeliveries. Transmission intent/attempt, never confirmation. | |
OutcomeEvent | reference | → IntegrationEvents. Verified authoritative result with current version, same economic request identity; required Confirmed. | |
ConfirmedAt | datetime | Actual verified external outcome time; never ack time. | |
Uncertainty | longtext | yes | Unresolved result retains key/claim; reconcile before a new logical request. Actual adverse source facts remain visible even if local preconditions failed. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
OperationKey | text | yes | Stable economic action identity; same content returns same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated source or reviewed manual evidence retaining occurrence/receipt time. | |
Decision | reference | → ApprovalDecisions. Exact current independently approved action/scope/revision; required before corresponding protected effect. | |
RestrictionNumber | text | yes | Unique room/reason/scope identity. |
Room | reference | yes | → Rooms. One actual property room. |
Kind | select | yes | Maintenance, Access, ServiceDeclined, OtherOperational |
Status | select | yes | Active, PendingRelease, Released, Superseded |
StartsAt | datetime | yes | Actual or approved effective restriction start. |
EndsAt | datetime | Exclusive evidenced end; no automatic release from a guessed time. | |
Reason | longtext | yes | Actual observation/source/privacy or maintenance facts and exact vendor mapping, no assumed OOS/OOO equivalence. |
PlacedBy | reference | yes | → Users. Authorized actual staff can immediately restrict observed scope. |
ReleaseDecision | reference | → ApprovalDecisions. Independent Property Manager for protected local block release with actual resolution evidence; another open restriction remains. | |
ReleasedAt | datetime | Actual approved local release, not PMS sellability. | |
Request | reference | → PMSRequests. Separately authorized source room-block update and actual result. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
OperationKey | text | yes | Stable economic action identity; same content returns same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated source or reviewed manual evidence retaining occurrence/receipt time. | |
DiscrepancyNumber | text | yes | Stable source conflict identity. |
Room | reference | yes | → Rooms. Actual affected room. |
Assignment | reference | → PMSRoomAssignments. Conflicting source fact retained. | |
Task | reference | → HousekeepingTasks. Actual local observation/work. | |
Kind | select | yes | Occupancy, Readiness, Restriction, SourceVersion, Identity |
Status | select | yes | Open, Investigating, PendingReview, Resolved |
ObservedAt | datetime | yes | Actual observer/source time. |
ObservedBy | reference | yes | → Users. Actual front desk/attendant/supervisor/source reviewer. |
Evidence | longtext | yes | Both source and local facts/versions; neither is silently overwritten, and new dependent promises/work are restricted. |
Decision | reference | → ApprovalDecisions. Property Manager protected resolution; authoritative PMS fact still requires verified PMS source. | |
ResolvedAt | datetime | Actual reconciled outcome; no fabricated occupied/vacant value. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
PlanNumber | text | yes | Unique plan/version. |
Name | text | yes | Turnover/stayover or other selected work instructions. |
Status | select | yes | Draft, PendingApproval, Active, Superseded |
Rules | longtext | yes | Task kinds, service-date recurrence, actual stay/departure trigger, access/DND handling and required inspection criteria; no task completion from nightly reset. |
Activation | reference | → MasterChanges. Independent Housekeeping Supervisor operating approval and Property Manager property/access implications. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
OperationKey | text | yes | Stable economic action identity; same content returns same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated source or reviewed manual evidence retaining occurrence/receipt time. | |
TaskNumber | text | yes | Stable logical property/room/service-date/work-kind/service-obligation key, independent of mere PMS revision changes. Revised source context updates the same unperformed obligation; completed work remains once. A genuine Reclean requires a new authorized physical-condition trigger, not just resynchronization. |
Room | reference | yes | → Rooms. Actual room. |
StaySegment | reference | → PMSStaySegments. Source stay context; turnover may point to ended segment. | |
Plan | reference | yes | → HousekeepingPlans. Frozen work/check instructions. |
Kind | select | yes | Turnover, Stayover, RequestedService, Reclean |
ServiceDate | date | yes | Property-local service date, distinct from import or posting date. |
AssignedTo | reference | yes | → Users. Actual Housekeeping Attendant. |
Status | select | yes | Planned, Assigned, InProgress, Clean, Missed, Declined, Blocked, Cancelled, Inspected |
PlannedStart | datetime | yes | Offset-aware intended work. |
PlannedEnd | datetime | yes | After planned start. |
StartedAt | datetime | Actual permitted room entry/work start; no invented work on import. | |
CompletedAt | datetime | Actual cleaning completion; null for Missed/Declined/Blocked. | |
WorkEvidence | longtext | yes | Actual room/access/source occupancy version, cleaning observations, changed conditions and service preferences; completion alone grants no vacant/sellable/readiness status. |
Supersedes | reference | → HousekeepingTasks. Revised unperformed scope retains the same logical obligation and cancels/replaces its active predecessor atomically. Reclean identifies distinct evidenced new work; source revision alone cannot duplicate completed or active service. | |
Inspection | reference | → HousekeepingInspections. Exact independent current readiness inspection, if complete. | |
ServiceObligationKey | text | yes | Stable actual turnover/stayover/request obligation, shared across source revisions and retries. Unique active/performed scope per room/date/obligation; a new Reclean needs independent supervisor-authorized trigger evidence. |
SourceContext | longtext | yes | Current source stay/assignment/version and actual work trigger; changes preserve completed history and invalidate affected readiness without inventing another task. |
| Field | Type | Required | Details |
|---|---|---|---|
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
OperationKey | text | yes | Stable economic action identity; same content returns same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated source or reviewed manual evidence retaining occurrence/receipt time. | |
Decision | reference | → ApprovalDecisions. RoomReadiness decision by the actual Housekeeping Supervisor inspector, independent of actual cleaning performers and task preparers/material editors. The inspector may prepare and sign their own inspection evidence; this action-specific exception does not allow inspecting own cleaning or own task preparation. A separate inspection-packet approver is not required. Exact current checks and room context are frozen. | |
InspectionNumber | text | yes | Unique task/room/revision inspection. |
Task | reference | yes | → HousekeepingTasks. Actual Clean task; full requirements and preceding departure/occupancy context must agree. |
Room | reference | yes | → Rooms. Same room as task. |
Status | select | yes | Draft, PendingReview, Passed, Failed, Invalidated |
CriteriaEvidence | longtext | yes | All required actual checks/results, inspector, cleaner/preparer exclusions, source occupancy/access version and remaining restrictions. Unknown result cannot pass. |
InspectedBy | reference | → Users. Actual Housekeeping Supervisor independent of every actual cleaner and task preparer/material editor. May record and sign this inspection, subject to the RoomReadiness-specific independence rule. | |
InspectedAt | datetime | Actual inspection time. | |
ApprovedAt | datetime | Current independent local readiness approval time; invalidated by changed occupancy/dirty/fault/task or any new restriction. | |
Request | reference | → PMSRequests. Exact authorized ReadinessUpdate prepared/transmitted by Front Desk Coordinator; PMS result alone determines external state. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
OperationKey | text | yes | Stable economic action identity; same content returns same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated source or reviewed manual evidence retaining occurrence/receipt time. | |
Decision | reference | → ApprovalDecisions. Independent Warehouse Manager exact DepartmentUse quantity/source/current-carrying authorization, excluding request preparer/material editors/actual performer. Required before guarded consumption; actual unauthorized/over-use observation remains durable Exception and needs reviewed correction, never ignored. | |
UseNumber | text | yes | Unique actual department/service use identity. |
Department | reference | yes | → PropertyDepartments. Exact expense/cost owner. |
Kind | select | yes | FoodService, HousekeepingSupply, OtherSupply |
Status | select | yes | Draft, PendingApproval, Approved, Performed, Posted, Reversed, Exception |
Task | reference | → HousekeepingTasks. Actual service context, not consumption proof by itself. | |
WorkOrder | reference | → WorkOrders. Prepared-food source context; actual source stock layers remain on lines. | |
PMSLedgerEntry | reference | → PMSLedgerEntries. Related actual service charge for reconciliation only; distinct economic source, creates no revenue from use. | |
PerformedBy | reference | yes | → Users. Actual person who physically consumed/served the goods, including Kitchen Operator food service or Housekeeping Attendant amenity use. Never substitute a warehouse recorder for the actual performer; this identity alone grants no posting authority. |
PerformedAt | datetime | Actual evidenced consumption time; request/transfer/task completion is not consumption. | |
Evidence | longtext | yes | Actual quantities/source custody/recipient/service evidence; unapproved or excess actual use remains durable exception with stock claims held until reviewed, never fabricated free stock. |
StockEvent | reference | → StockEvents. One DepartmentUse quantity/carrying relief against approved expense/food-cost, not title/revenue or second WIP. | |
FinanceDecision | reference | → ApprovalDecisions. Independent Finance Manager protected value/loss/exception, additional to Warehouse Manager exact use authorization and required Kitchen Manager fitness. | |
RecordedBy | reference | yes | → Users. Actual evidence recorder: Kitchen Operator for food service or Warehouse Operator for other property supplies, retaining actual PerformedBy and source evidence. Attendants may submit factual use observations for warehouse recording. |
ExecutedBy | reference | → Users. Actual guarded StockEvent posting executor: Kitchen Operator food service or Warehouse Operator other supplies after exact independent Warehouse Manager approval/current eligibility. Not necessarily the physical consumer. |
| Field | Type | Required | Details |
|---|---|---|---|
Use | reference | yes | → DepartmentUses. Owning authorized actual use. |
LineNumber | number | yes | Unique source slice. |
Product | reference | yes | → Products. Actual food or supply SKU/base unit. |
Reservation | reference | yes | → InventoryReservations. Exclusive DepartmentUse demand claim; no fabricated sales order or production work demand. |
Layer | reference | yes | → StockLayers. Exact current source carrying and custody. |
Portion | reference | → LotPortions. Required food-traced leaf with current safe-use/date constraints; nonfood tracking follows actual policy. | |
BaseQuantity | decimal | yes | Positive actual used quantity, bounded by authorized/reserved/available source; cannot be a room count or charge amount. |
CarryingRemoved | decimal | yes | Exact current remaining source-layer carrying removed proportionally with final remainder; nonnegative known zero allowed. One Dr reviewed department expense/food cost, Cr inventory effect. Never original obsolete cost, WIP plus inventory together, or another cost from PMS revenue. |
ExpenseAccount | reference | yes | → ChartOfAccounts. Approved same-entity property/department expense/food-cost basis. |
OriginalUseLine | reference | → DepartmentUseLines. Exact controlled correction; actual consumption is irreversible, so only evidenced unused/erroneous original scope can restore stock with required condition/source decisions. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Connection | reference | yes | → PMSConnections. Exact source tenant/property namespace and authority policy. |
ExternalKey | text | yes | Immutable source object/economic identity within connection/property, never guest name or room label. |
SourceVersion | text | yes | Actual ordered source revision/cursor or equivalent reviewed snapshot watermark; not local arrival order. |
SourceHash | text | yes | Immutable original payload/content hash. Conflicting same version remains review-required. |
OccurredAt | datetime | yes | Actual source occurrence, distinct from local receipt/business date. |
ReceivedAt | datetime | yes | Actual import receipt time. |
Event | reference | → IntegrationEvents. Exact verified received source, with every older/conflicting/adverse payload retained. | |
FolioNumber | text | yes | Display identity for exact external subaccount/ledger. |
LedgerKind | select | yes | Guest, Corporate, Deposit, OtherReviewed |
Reservation | reference | → PMSReservations. Actual source stay if applicable; corporate ledger may span permitted stays without invented reservation. | |
Guest | reference | → GuestReferences. Protected actual source party. | |
Currency | reference | yes | → Currencies. Source ledger currency. |
Status | select | yes | Open, Closed, Transferred, Unresolved |
BalanceSnapshot | longtext | yes | Source dated balance and composition/coverage; nonposting mirror, never itself a delta journal or sum with own detail. |
ProjectionState | select | yes | Current, Stale, Gap, Conflict, Unresolved |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Connection | reference | yes | → PMSConnections. Exact source tenant/property namespace and authority policy. |
ExternalKey | text | yes | Immutable source object/economic identity within connection/property, never guest name or room label. |
SourceVersion | text | yes | Actual ordered source revision/cursor or equivalent reviewed snapshot watermark; not local arrival order. |
SourceHash | text | yes | Immutable original payload/content hash. Conflicting same version remains review-required. |
OccurredAt | datetime | yes | Actual source occurrence, distinct from local receipt/business date. |
ReceivedAt | datetime | yes | Actual import receipt time. |
Event | reference | → IntegrationEvents. Exact verified received source, with every older/conflicting/adverse payload retained. | |
EntryNumber | text | yes | Unique source posting/transfer/reversal component display id. |
Folio | reference | yes | → PMSFolios. Actual ledger/subaccount owner. |
Kind | select | yes | Charge, Tax, Payment, DepositReceipt, DepositApplication, LedgerTransfer, Credit, Refund, Reversal, FX, Wrapper, Opening |
ComponentRole | select | yes | AdditiveEconomic, NonpostingWrapper, DuplicateRepresentation, OpeningDetail, Unresolved |
EconomicKey | text | yes | Stable identity of this additive source event/component across exports and retries. A genuine later correction has its own unique delta event/component key linked through ReversalOf to the original; original100 corrected to80 owns a new -20 delta, while retry of that correction retains its same key. Never clear original FinancialClaim or reuse original recognition identity for a correction. |
Currency | reference | yes | → Currencies. Actual source component currency. |
SignedAmount | decimal | yes | Actual signed source value and meaning under frozen mapping; zero only actual zero/functional-only FX, never missing. |
ServiceDate | date | yes | Actual property PMS service/business date; not ERP posting date or recomputed nightly rate. |
Mapping | reference | → PMSMappings. Nullable while Received/Held or unresolved evidence; exact independently active mapping required before Verified financial classification, claim or bridge. Never invent a placeholder approved mapping. | |
Status | select | yes | Received, Verified, Held, Claimed, Bridged, Excluded, Corrected |
ReversalOf | reference | → PMSLedgerEntries. Exact original economic source for a distinct authoritative correction/reversal delta, preserving original posted ownership and all applications. Full revised snapshots are compared to prior recognized scope to derive only the approved delta; a retry has the same correction event key. | |
ParentWrapper | reference | → PMSLedgerEntries. Nonposting folio/package summary; additive descendants excluded from counting wrapper again. | |
Evidence | longtext | yes | Actual gross/net/tax/fee/transfer/tender components, source-ledger/amount/currency/cutoff completeness and authority; payment authorization/tender intent has no actual clearing recognition. |
Route | select | yes | PMSBridge, ExcludedWrapper, OpeningOnly, Unresolved |
FinancialClaim | reference | → PMSFinancialBatches. Exclusive owner of this additive economic source atom across all packets. Every mapped leg shares one finite group; concurrent reservations cannot claim it twice. Posted ownership remains immutable; corrections use new traced source entries, never clear the claim for replay. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
OperationKey | text | yes | Stable economic action identity; same content returns same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated source or reviewed manual evidence retaining occurrence/receipt time. | |
Decision | reference | → ApprovalDecisions. Exact current independently approved action/scope/revision; required before corresponding protected effect. | |
BridgeNumber | text | yes | Unique source packet/version identity. |
Connection | reference | yes | → PMSConnections. Same exact source authority. |
FromCursor | text | yes | Prior reconciled source watermark; opening cutoff is explicit. |
ToCursor | text | yes | Inclusive reviewed source coverage through this watermark; gap/duplicate/conflict flags cannot be hidden. |
Status | select | yes | Draft, Validating, PendingApproval, Approved, Posted, Reversed, Held |
PostingDate | date | yes | Authorized ERP posting date, separate source service dates preserved. |
Period | reference | yes | → AccountingPeriods. Same entity open posting period. |
Coverage | longtext | yes | Exact received/verified event cursor, property business dates and all source economic atoms/legs, with wrappers excluded and source mappings/rates fixed. FinancialClaim is exclusive across packets. Source gaps/conflicts/missing balancing legs hold affected groups; finite unrelated complete groups may be separately approved without claiming missing coverage. |
Journal | reference | → JournalEntries. One balanced packet source journal with source-line ownership; every underlying economic component/leg is claimed once across packets. Finite approved packet may combine events without hiding line identity. | |
PostedAt | datetime | Actual atomic bridge posting; transport or external folio status is not this event. |
| Field | Type | Required | Details |
|---|---|---|---|
Batch | reference | yes | → PMSFinancialBatches. Owning immutable approved packet. |
ComponentNumber | text | yes | Stable source economic component plus mapped leg identity. |
Entry | reference | yes | → PMSLedgerEntries. Verified additive economic source only; wrapper/opening detail never posts again. |
Mapping | reference | → PMSMappings. Nullable only while Prepared/unclassified; exact active frozen classification, paired-leg and carrying rule required before Reserved or Posted. | |
Side | select | yes | Debit, Credit |
Account | reference | yes | → ChartOfAccounts. Exact PMS guest/deposit/corporate/tender/revenue/tax/FX control or reviewed noncontrol leg; no local guest AR invoice source. |
Currency | reference | yes | → Currencies. Original source/control currency. |
Amount | decimal | yes | Nonnegative source-currency magnitude; zero only actual zero or functional-only FX leg. Side supplies sign; unlike currencies never summed as source amounts. |
RateEvidence | longtext | yes | Exact source/document/control currency, dated conversion or released current carrying, allocated prior unrealized FX and functional-only adjustment basis. A source-currency transfer may require different source/destination amounts; preserve both with explicit rate and actual FX. Same source/period has one PMS-versus-local valuation owner; missing mapping/rate/tax remains held, never balancing plug. |
FunctionalAmount | decimal | yes | Nonnegative entity-functional magnitude for this Side; balanced per economic group/packet with explicit actual FX/reclassification. |
Status | select | yes | Prepared, Reserved, Posted, Released, Reversed |
Effect | select | yes | RecognizeBalance, ConsumeBalance, RevenueTax, Reclassification, Correction, DirectBank |
BalanceSource | reference | → PMSBalanceSources. Exact new control source when RecognizeBalance, or original source being consumed/remeasured; reciprocal original recognition identity required. | |
JournalLine | reference | → JournalLines. Exactly one committed GL leg; mirrored guest source never also creates local Invoice/CashReceipt/refund. | |
ReversalOf | reference | → PMSFinancialComponents. Original mapped leg and all consumed source descendants reconciled before reversal. | |
EconomicGroup | text | yes | Stable source event/atomic economic group and leg identity. Every required balancing/source-control leg posts together; each source atom/leg is globally unique across batches, independent of packet id. Partial draft groups cannot post. |
BankAccount | reference | → BankAccounts. Only documented DirectBank mapping: actual same-entity bank/cash account whose verified actual movement is claimed exclusively by this component group. No tender clearing source/settlement or local CashReceipt for the same money. | |
StatementLine | reference | → BankStatementLines. Exact actual bank evidence for DirectBank; shared import identity cannot be claimed by PMSTenderSettlements, local cash or cash transfer again. | |
BankEvidence | longtext | Required actual bank/cash custody confirmation for DirectBank, with amount/currency/carrying and source reconciliation. PMS paid status or authorization alone is insufficient; cash-only proof must be independently reviewed. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
BalanceNumber | text | yes | Unique source economic recognition/control leg identity. |
Folio | reference | yes | → PMSFolios. Actual source ledger/account, including corporate or deposit context. |
OriginEntry | reference | yes | → PMSLedgerEntries. Exact actual economic recognition or Opening detail identity; a later refund may create a new TenderPayable even after original TenderReceivable is fully settled. Positive source balances remain disjoint; no negative spendable asset. |
OriginComponent | reference | → PMSFinancialComponents. Reciprocal exact recognition leg; required native source. Opening detail instead identifies the approved MigrationItems baseline and one opening GL, never replaying historical recognition. | |
Kind | select | yes | GuestReceivable, GuestCredit, CorporateReceivable, CorporateCredit, DepositLiability, TenderReceivable, TenderPayable |
Side | select | yes | Asset, Liability |
Account | reference | yes | → ChartOfAccounts. Exact PMS control family; separate from local goods AR/customer credits. |
Currency | reference | yes | → Currencies. Source balance currency. |
OriginalAmount | decimal | yes | Nonnegative recognized/opening source magnitude; zero source has zero current carrying after resolved functional remeasurement. Asset/liability are separate positive sources, never negative spendable balance. |
OutstandingAmount | decimal | yes | Original plus explicit approved source increases less net posted consumption/corrections; active claims are not subtracted here. No cross-folio/entity netting. |
ReservedAmount | decimal | yes | Active PMSBalanceAllocations plus PMSTenderAllocations source-currency claims, disjoint from posted history; new claims <= OutstandingAmount minus other active claims and holds. |
HeldAmount | decimal | yes | Disjoint unresolved source-currency hold outside active reservations; <= outstanding minus reserved. External adverse history remains even if no allocatable balance. |
CurrentCarrying | decimal | yes | Nonnegative functional remaining control carrying with source-level historic/prior FX basis; final consumption takes exact remainder, zero outstanding must not strand value. |
UnrealizedFX | decimal | yes | Signed gain-positive prior local FX on this remaining monetary source; released/reclassified proportionally, never import/revalue the same source-period twice. |
Status | select | yes | Open, PartiallyConsumed, Held, Settled, Reversed |
Baseline | longtext | yes | Original/consumed/open source amounts and current carrying/prior FX at cutover; nonposting detail reconciled to one opening GL. |
OpeningItem | reference | → MigrationItems. Exact reconciled nonposting cutover source when no native OriginComponent; opening currency/current carrying/prior FX and consumed history verified. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
OperationKey | text | yes | Stable economic action identity; same content returns same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated source or reviewed manual evidence retaining occurrence/receipt time. | |
AllocationNumber | text | yes | Stable original source/consuming event/slice identity. |
Source | reference | yes | → PMSBalanceSources. One actual remaining positive source; entity/folio/source-currency ownership and allowed transfer mapping agree. |
Component | reference | yes | → PMSFinancialComponents. Exact consuming control leg; all constituent allocations sum to the leg in its currency/current carrying. Source deposit/application/ledger transfer and destination recognition legs share the same atomic economic group; no second revenue/cash effect. |
Entry | reference | yes | → PMSLedgerEntries. Actual authoritative PMS allocation/application/transfer/refund/reversal event. |
Kind | select | yes | PaymentApplication, DepositApplication, LedgerTransfer, CreditApplication, Refund, Correction |
SourceAmount | decimal | yes | Positive original-source currency slice. New active claims <= current OutstandingAmount less other active reservations and disjoint holds. Posted history has already reduced OutstandingAmount and is not subtracted twice. All balance and tender allocation families share this lock. |
CarryingReleased | decimal | yes | Exact current source carrying released proportionally with final remainder. |
PriorFXReleased | decimal | yes | Signed prior unrealized amount reclassified zero-net with actual incremental settlement delta. |
Destination | reference | → PMSBalanceSources. Exact newly recognized reciprocal destination for a transfer or tender/control shift, if any. One-to-many splits use separate disjoint allocations; each destination recognition sums its incoming allocation basis, with explicit currency conversion and no automatic netting. | |
Status | select | yes | Reserved, Approved, Posted, Released, Reversed, Held |
PostedAt | datetime | Atomic effect with batch/source/current controls. | |
ReversalOf | reference | → PMSBalanceAllocations. Original slice; downstream use and other shared claims reconciled before restoration. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
OperationKey | text | yes | Stable economic action identity; same content returns same result, conflict enters review. |
Event | reference | → IntegrationEvents. Authenticated source or reviewed manual evidence retaining occurrence/receipt time. | |
Decision | reference | → ApprovalDecisions. Exact current independently approved action/scope/revision; required before corresponding protected effect. | |
SettlementNumber | text | yes | Unique external bank/cash settlement economic identity, shared across import attempts. |
Connection | reference | yes | → PMSConnections. Actual PMS/source tender mapping context. |
Kind | select | yes | NetReceipt, NetDebit, ZeroOffset, FeeOnly, UnmatchedActual |
Status | select | yes | Observed, PendingApproval, Approved, Posted, Uncertain, Held, Reconciled, Reversed |
Currency | reference | yes | → Currencies. Actual bank/cash settlement currency; each allocated source keeps its own currency and reviewed equivalent. |
BankAccount | reference | → BankAccounts. Actual same-entity account, required nonzero bank/cash leg; absent ZeroOffset with no actual bank transaction. | |
SignedCashAmount | decimal | yes | Actual bank/cash currency amount: positive received, negative paid, known zero only no cash leg; source PMS paid status cannot fabricate it. |
SignedCashValue | decimal | yes | Actual signed functional bank value/current disposal carrying, with separate source-current/prior FX components. |
FeeAmount | decimal | yes | Nonnegative actual evidenced fee in settlement currency; zero when none. Deduct once, never again through AP/import. |
FeeCorrection | reference | → FinanceCorrections. Exact BankFee owner when nonzero, sharing this journal/economic fee key; no separately posted duplicate fee. | |
StatementLine | reference | → BankStatementLines. Actual settlement evidence or reviewed manual cash proof; statement line cannot be claimed again as a local CashReceipt. | |
SourceReconciliation | longtext | yes | Signed tender-source equivalents (asset positive/liability negative) equal signed actual cash plus actual fees, with independently reconciled current functional carrying/FX. Every active claim shares PMSBalanceSources reservations. Unmatched actual bank evidence remains durable Held; Finance Manager may approve an explicitly identified temporary suspense counterpart, not a fabricated tender source. Later mapping reclassifies that same suspense/current carrying without another bank effect. |
Journal | reference | → JournalEntries. One approved actual bank/cash versus tender clearing/fee/FX effect; UnmatchedActual may use explicit approved suspense. Never guest AR/revenue again. ZeroOffset/fee-only uses only actual functional clearing/FX/fee; no invented bank or mandatory zero-value journal. | |
SettledAt | datetime | Actual evidenced bank/cash movement time; zero-offset without bank retains actual source-offset confirmation time, not fictional cash movement. | |
PostedAt | datetime | Atomic local monetary posting time. | |
ReversalOf | reference | → PMSTenderSettlements. Actual bank return/correction consumes original allocation/current carrying once, with dependent source outcomes preserved. | |
SuspenseAccount | reference | → ChartOfAccounts. Required only for reviewed UnmatchedActual suspense posting; independent Finance Manager must approve actual bank evidence, exact unresolved source and finite follow-up. No manufactured guest/tender source or silent balancing adjustment. | |
Resolution | reference | → FinanceCorrections. Latest source-linked PMSResolution for navigation; all historical/partial resolutions are owned by FinanceCorrections.PMSTenderSettlement and PMSTenderAllocations.Resolution. Original packet remains immutable. Aggregate current suspense/claims derive from all disjoint posted/active correction slices, never a single pointer rollup. | |
SuspenseSide | select | yes | None, Asset, Liability |
SuspenseOriginalAmount | decimal | yes | Nonnegative original recognized unresolved suspense magnitude in settlement currency; zero unless approved UnmatchedActual journal. Actual incoming cash normally credits suspense Liability; actual debit normally debits suspense Asset. Original fee components separately explicit. |
SuspenseRemainingAmount | decimal | yes | Original recognized suspense less posted exact resolution/reversal slices, never less than zero. Recorded bank transaction stays historical; a new tender mapping does not erase it. |
SuspenseReservedAmount | decimal | yes | Disjoint active SuspenseResolution claims against current remaining amount, excluding already posted resolution history; unknown correction outcome retains claims. |
SuspenseCurrentCarrying | decimal | yes | Nonnegative current functional value of remaining suspense; proportional/final release, zero when amount is zero. Native posting/revaluation/resolution deltas have exact source ownership. |
SuspenseUnrealizedFX | decimal | yes | Signed prior unrealized FX for remaining monetary suspense; proportional/final release and zero-net realized reclassification, never imported twice. |
| Field | Type | Required | Details |
|---|---|---|---|
Settlement | reference | yes | → PMSTenderSettlements. Original actual settlement identity. Kind Settlement belongs to its immutable original bank packet; Kind SuspenseResolution is a new correction allocation against that original unmatched suspense, never appended to original posted bank totals. |
AllocationNumber | text | yes | Stable source/settlement slice. |
Source | reference | yes | → PMSBalanceSources. TenderReceivable or TenderPayable only; positive source remainder. No guest AR/deposit source directly settled here. |
SourceAmount | decimal | yes | Positive source-currency slice. New active claims <= current OutstandingAmount less other active reservations and disjoint holds, shared with PMSBalanceAllocations. Settled history is already removed and is not subtracted again. |
SettlementEquivalent | decimal | yes | Nonnegative equivalent in original bank/settlement currency; sign derives from tender source Side. Kind Settlement enters original tender=cash+fee equation; Kind SuspenseResolution enters only new correction tender=suspense-slice(+explicit actual fee if applicable) equation and is excluded from original bank totals. |
CarryingReleased | decimal | yes | Exact nonnegative current source functional carrying; final slice takes all remaining value. |
PriorFXReleased | decimal | yes | Signed prior local unrealized FX of settled slice for zero-net realized reclassification. |
Status | select | yes | Reserved, Posted, Released, Reversed, Held |
ReversalOf | reference | → PMSTenderAllocations. Exact original slice and later actual return/correction scope. | |
Kind | select | yes | Settlement, SuspenseResolution |
Resolution | reference | → FinanceCorrections. Required exactly when Kind SuspenseResolution; PMSResolution owns this new immutable allocation/journal under independent Finance Manager approval, while Settlement identifies original bank/suspense source. Never another bank movement. | |
SuspenseAmount | decimal | Positive slice in original suspense/settlement currency for SuspenseResolution. Active plus new claims <= original current SuspenseRemainingAmount less other active claims; original posted reductions already reflected. Exact signed tender equivalent matches this suspense slice; currency conversion explicit. | |
SuspenseCarryingReleased | decimal | Exact nonnegative current functional suspense carrying for that slice, final slice all remaining. Original bank carrying is not posted again; actual tender-current versus suspense-current difference has explicit reviewed FX/fee basis. | |
SuspensePriorFXReleased | decimal | Signed prior suspense unrealized FX allocated to this resolved slice; zero-net reclassification only once, alongside independently owned tender prior FX. |
| Field | Type | Required | Details |
|---|---|---|---|
Entity | reference | yes | → Entities. One legal owner; all property, commercial, stock and financial sources must belong to this entity. |
Property | reference | yes | → Properties. Exact property context, belonging to Entity; room numbers alone are not identity. |
Revision | number | yes | Positive immutable submitted revision; material editors recorded. |
Snapshot | reference | → DocumentRevisions. Exact current content/source/policy hash, required before protected decision/effect. | |
CreatedBy | reference | yes | → Users. Actual preparer identity. |
CreatedAt | datetime | yes | Actual offset-aware creation time. |
Decision | reference | → ApprovalDecisions. Exact current independently approved action/scope/revision; required before corresponding protected effect. | |
ReconciliationNumber | text | yes | Unique connection/cutoff/version. |
Connection | reference | yes | → PMSConnections. Actual source namespace. |
SourceCursor | text | yes | Exact source ledger/business-date completeness watermark. |
CutoffAt | datetime | yes | Comparable actual source/local cutoff. |
Status | select | yes | Draft, PendingReview, Approved, Unresolved, Superseded |
SourceBalances | longtext | yes | Actual guest/deposit/corporate/tender source-currency balances and source ids; detail and wrapper totals compared, never added together. |
LocalBalances | longtext | yes | PMSBalanceSources current amount/carrying/prior FX reconciled to posted GL bridge/settlements and source currencies; local goods AR is a separate population. |
Differences | longtext | yes | Missing/duplicate/conflicting component keys, version gaps, unapproved packets, amounts/rates, pending settlement and dated timing exceptions. Unknown is not zero. |
FXOwnership | longtext | yes | Per-source/period owner for PMS-supplied FX versus locally calculated revaluation; compare current carrying and apply approved delta/replacement, never post both whole gains. |
ReviewedBy | reference | → Users. Independent Finance Manager, excluding packet/reconciliation preparer/material editors. | |
ReviewedAt | datetime | Actual finite-cutoff approval; later events require new version. |
Create your ERP.AI account and get started with Proto.
We use essential cookies to run the site and optional cookies for features, analytics, and relevant content. See Cookie policy
We use cookies to enhance your experience, analyze site traffic, and serve relevant content. By clicking "Accept All," you agree to our use of cookies. You can customize your preferences at any time.
Learn more about how we use cookiesThese cookies are required for the website to function properly. They ensure security, enable basic features like page navigation, and store user session data. You cannot disable these cookies.
These cookies enable additional features that enhance your experience, such as live chat, video playback, personalized content recommendations, and remembering user preferences.
These cookies help us understand how visitors interact with our site by collecting anonymous usage data. This allows us to measure performance, detect issues, and continuously improve the user experience.
These cookies allow us and advertising partners, including X, to deliver ads tailored to your interests. They track browsing habits across sites to provide relevant advertising and measure ad effectiveness.