Explore the records behind each deal and plan a controlled commercial data migration.
54 tables · 218 relationships
This is the authored data model for CPQ & Quote-to-Cash. Use it to scope application configuration, migration and integrations. Table names describe the proposed structure; access and actions must be configured and verified for the deployed application.
Users, Accounts, Contacts and Opportunities carry ownership and source references. OpportunityItems keeps incoming product details available for mapping. ApprovalDelegations retains scoped authority and its valid period.
Products, OptionGroups, ProductOptions and BundleComponents describe the offer. ProductRules, RuleConditions and RuleActions define configuration behavior, with ConfigurationRuleHits preserving evaluations. PriceBooks, PriceBookEntries, BundleDiscounts and BundleRequiredProducts supply approved pricing.
DiscountApprovalMatrix, TaxRates, QuoteTemplates and ContractTemplates supply the review and document context. MasterChanges retains the submitted change, its decision and activation evidence.
Quotes, QuoteLines, QuoteLineOptions, QuoteDiscounts and BillingMilestones prepare the offer. QuoteVersions, QuoteVersionLines and QuoteDiscountAllocations freeze its commercial basis. DiscountApprovalSteps, EQuoteEnvelopes and EQuoteEvents retain decisions and signature evidence against that revision.
Contracts and ContractLines preserve effective commitments, with RenewalDecisions recording the next term's decision. SalesOrders, SalesOrderLines and OrderAllocations consume accepted quantities and value. FulfillmentEvents distinguishes delivery evidence from customer acceptance.
InvoiceSchedules and InvoiceScheduleLines describe obligations before Invoices and InvoiceLines record them. CreditMemos, CreditMemoLines, Payments, PaymentApplications, FinanceAdjustments and AccountCreditApplications preserve corrections and settlement history.
BusinessEvents retains the identity and outcome of a business effect. EventDeliveries follows each destination's delivery separately. MigrationBatches preserves source identifiers, reconciliation and activation evidence for transferred work.
Use immutable identifiers for records and stable source identifiers for imported or connected work. Human document numbers help people find a deal; they do not replace the identifiers connecting it. Resolve account, contact and user references in stages where they depend on each other.
A submitted quote revision preserves the parties, options, commercial values, operative terms and pricing policy reviewed. Accepted line values include their allocated discounts, with tax handled separately. Orders, schedules and invoices retain that source basis so staged delivery or billing cannot consume the same accepted value again.
Keep the original sent document and the executed copy, together with the envelope and revision that bind them. Operational timestamps preserve event order; service periods and billing dates retain their agreed calendar meaning. Financial corrections reference the original effect and remain bounded by the amount still eligible for reversal, credit or application.
| Field | Type | Required | Details |
|---|---|---|---|
UserName | text | yes | |
FullName | text | yes | |
Email | text | yes | |
Role | select | yes | Admin, Product Manager, Pricing Manager, Sales Rep, Sales Manager, Executive Approver, Deal Desk, Billing Specialist |
Title | text | ||
Manager | reference | → Users. The manager tier of the matrix resolves to this person for the quote owner | |
ApproverRole | select | SalesManager, VPSales, CFO, CEO. The matrix tier this person may approve | |
DelegateTo | reference | → Users. Display of currently effective approved ApprovalDelegations; this field alone grants no authority | |
DelegateFrom | date | Display date of effective delegation; exact validity is ApprovalDelegations.StartsAt | |
DelegateUntil | date | Display date of effective delegation; exact validity is ApprovalDelegations.EndsAt | |
CreditApprovalLimit | decimal | USD amount; null means no self-confirmation authority, not unlimited. Version and approved policy captured on each credit decision | |
Active | boolean | yes | |
CreditPolicyVersion | text | Version of independently approved credit authority |
| Field | Type | Required | Details |
|---|---|---|---|
AccountNumber | text | yes | |
Name | text | yes | |
Type | select | yes | Prospect, Customer, Partner |
BillingContact | reference | → Contacts. The person invoices are addressed to | |
BillingEmail | text | Where invoices are sent | |
BillingAddress | text | ||
ShippingAddress | text | ||
PaymentTerms | select | yes | Net 15, Net 30, Net 45, Net 60, Due on receipt |
DefaultPriceBook | reference | → PriceBooks. The partner or enterprise book a quote for this account opens on; empty means the company default | |
PORequired | boolean | If true, an order cannot be confirmed without a CustomerPONumber | |
CreditLimit | decimal | USD exposure ceiling; null disables the numeric ceiling only, not CreditHold or confirmation controls | |
OpenBalance | decimal | yes | Computed sum of positive non-void issued invoice Balance; excludes Draft invoices and unapplied cash |
CreditHold | boolean | Set by Billing Specialist; blocks order confirmation | |
CreditHoldReason | text | ||
TaxJurisdiction | reference | → TaxRates | |
TaxExempt | boolean | Requires reviewed evidence, scope and validity; boolean alone cannot waive tax | |
Owner | reference | yes | → Users |
CRMReference | text | Record id in the CRM this account is synced from | |
Active | boolean | yes | |
CommittedExposure | decimal | yes | Computed confirmed/released uninvoiced order allocation value plus tax reserve; excluded once the same amount transfers to an issued invoice |
ExposureVersion | number | yes | Atomic account exposure revision checked during confirmation, cancellation, invoicing and cash/credit application |
TaxExemptionEvidence | attachment | Required for an exemption | |
TaxExemptionValidUntil | date | Expiry of reviewed exemption; absence requires an explicitly documented open-ended scope | |
TaxExemptionScope | longtext | Products, jurisdiction and effective dates covered | |
TaxReviewedBy | reference | → Users. Billing Specialist who reviewed exemption evidence | |
TaxReviewedAt | datetime | Tax evidence review time | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
Account | reference | yes | → Accounts |
FullName | text | yes | |
Email | text | yes | |
Title | text | ||
Role | select | yes | Primary, Signatory, Billing, Technical |
CRMReference | text | ||
Active | boolean | yes | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
OpportunityNumber | text | yes | |
Name | text | yes | |
Account | reference | yes | → Accounts |
Owner | reference | yes | → Users |
Stage | select | yes | Qualified, Proposal, Negotiation, ClosedWon, ClosedLost |
ExpectedCloseDate | date | ||
Amount | decimal | Synced to the CRM from the GrandTotal of the quote with IsPrimary set | |
CRMReference | text | ||
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
SKU | text | yes | |
Name | text | yes | |
Description | longtext | ||
Family | text | Commercial family the pricing and leakage reports slice by, set by the product manager: Platform, Hardware, Services, Support | |
Type | select | yes | Standalone, Bundle, Subscription, Service, Addon. A Bundle has BundleComponents |
BasePrice | decimal | yes | USD per UnitOfMeasure per BillingCadence; one-time price otherwise. Same cadence as its cost and floor basis |
UnitCost | decimal | USD per UnitOfMeasure per BillingCadence; unknown is null, never silently zero | |
BillingCadence | select | yes | OneTime, Monthly, Quarterly, Annual |
UnitOfMeasure | select | Each, Seat, GB, Hour, Day, Month | |
RevenueCategory | select | Product, Subscription, Services, Support. Carried onto invoice lines for the accounting system | |
Configurable | boolean | yes | If true, the product has OptionGroups the rep chooses from at quote time |
Active | boolean | yes | |
VersionNumber | number | yes | Immutable activated revision; changes create a new reviewed version |
Change | reference | → MasterChanges. Approved activation provenance |
| Field | Type | Required | Details |
|---|---|---|---|
Product | reference | yes | → Products |
GroupCode | text | yes | |
Name | text | yes | Edition tier, Support level, Region, Storage, Term, Warranty, Deployment |
Required | boolean | yes | If true, a quote line cannot be saved without a value from this group |
SelectionType | select | yes | Single, Multiple |
SortOrder | number | ||
Active | boolean | yes |
| Field | Type | Required | Details |
|---|---|---|---|
Product | reference | yes | → Products |
OptionGroup | reference | yes | → OptionGroups |
OptionValue | text | yes | Premium, Large, 24-month |
PriceDelta | decimal | Added to the unit price when this option is selected | |
IsDefault | boolean | One default per OptionGroup | |
SortOrder | number | ||
Active | boolean | yes |
| Field | Type | Required | Details |
|---|---|---|---|
Bundle | reference | yes | → Products. The parent product, Type = Bundle |
Component | reference | yes | → Products |
Quantity | number | yes | Per one unit of the bundle |
Required | boolean | yes | Required components are added with the bundle line and cannot be removed |
ComponentGroup | text | Groups optional components the rep picks between: Storage, Support, Accessories | |
Pricing | select | yes | IncludedInBundle, PricedSeparately |
SortOrder | number |
| Field | Type | Required | Details |
|---|---|---|---|
RuleCode | text | yes | |
Name | text | yes | |
Type | select | yes | Validation, AutoAdd, Exclusion, Recommendation |
Severity | select | yes | Block, Warn, Info |
Description | text | Shown to the rep when the rule fires | |
Active | boolean | yes | |
VersionNumber | number | yes | Immutable activated revision; referenced children are included in its content hash |
Change | reference | → MasterChanges. Required approved change before activation |
| Field | Type | Required | Details |
|---|---|---|---|
Rule | reference | yes | → ProductRules |
Product | reference | yes | → Products |
Option | reference | → ProductOptions. Narrows the condition to a specific option | |
Operator | select | yes | Present, NotPresent, QuantityGTE, QuantityLTE, OptionEquals |
Value | text | Numeric for the quantity operators; option value for OptionEquals |
| Field | Type | Required | Details |
|---|---|---|---|
Rule | reference | yes | → ProductRules |
Action | select | yes | AutoAddProduct, RequireProduct, ExcludeProduct, RecommendProduct, ShowMessage |
TargetProduct | reference | → Products | |
TargetOption | reference | → ProductOptions | |
Quantity | number | For AutoAddProduct, default 1 | |
Message | text | For ShowMessage and RecommendProduct |
| Field | Type | Required | Details |
|---|---|---|---|
BookCode | text | yes | |
Name | text | yes | |
Segment | select | yes | Standard, Enterprise, Partner, Promotion |
EffectiveStart | date | yes | |
EffectiveEnd | date | ||
Currency | select | yes | USD |
IsDefault | boolean | yes | Exactly one default, used when the account has no DefaultPriceBook |
Active | boolean | yes | |
VersionNumber | number | yes | Immutable activated revision; referenced children are included in its content hash |
Change | reference | → MasterChanges. Required approved change before activation | |
Template | reference | → QuoteTemplates. Explicit reviewed template override; Promotion requires this or approved fallback to Standard |
| Field | Type | Required | Details |
|---|---|---|---|
PriceBook | reference | yes | → PriceBooks |
Product | reference | yes | → Products |
OverridePrice | decimal | yes | Replaces BasePrice when this book is selected |
FloorPrice | decimal | USD per quantity unit per product BillingCadence; compare after allocated line and header discounts on the same term/cadence basis | |
UnitCost | decimal | USD per quantity unit per BillingCadence; override if known, otherwise product cost; null on both means unknown and requires Floor review | |
MinQuantity | number | Volume break floor | |
MaxQuantity | number | Volume break ceiling | |
Notes | text |
| Field | Type | Required | Details |
|---|---|---|---|
BundleCode | text | yes | |
Name | text | yes | |
DiscountType | select | yes | PercentOff, FlatAmount, FixedBundlePrice |
DiscountValue | decimal | yes | |
EffectiveStart | date | yes | |
EffectiveEnd | date | ||
Active | boolean | yes | |
VersionNumber | number | yes | Immutable activated revision; referenced children are included in its content hash |
Change | reference | → MasterChanges. Required approved change before activation | |
Priority | number | yes | Unique evaluation order within an activated version; lower number first |
Stacking | select | yes | Exclusive, Sequential. Exclusive wins by priority for overlapping eligible value; Sequential applies to remaining eligible net value |
| Field | Type | Required | Details |
|---|---|---|---|
Bundle | reference | yes | → BundleDiscounts |
Product | reference | yes | → Products |
MinQuantity | number | Minimum quantity of this product to qualify, default 1 |
| Field | Type | Required | Details |
|---|---|---|---|
TierCode | text | yes | |
Name | text | yes | Auto band, Manager tier, VP tier, CFO tier |
MinPercent | decimal | yes | Inclusive lower bound on the unrounded routed percentage; within 0–100 |
MaxPercent | decimal | yes | Exclusive upper bound, except the final 100 boundary is inclusive. Active bands partition 0–100 exactly once without overlap or gaps |
ApproverRole | select | yes | None, SalesManager, VPSales, CFO, CEO. None is the auto-approve band |
ChainLowerTiers | boolean | If true, steps are also created for every lower tier and decided in StepOrder before this tier's step activates | |
RequiresAllApprovers | boolean | True requires every named eligible user in the tier snapshot; false requires one eligible named user. No eligible user blocks routing | |
EscalationHours | number | Hours a Pending step may wait before it is escalated to the next tier's approver; empty means never | |
Active | boolean | yes | |
VersionNumber | number | yes | Immutable activated revision; referenced children are included in its content hash |
Change | reference | → MasterChanges. Required approved change before activation | |
PolicyScope | text | yes | Company policy scope and revision, frozen on submission |
| Field | Type | Required | Details |
|---|---|---|---|
State | select | yes | CA, NY, TX, WA, FL, IL and every other two-letter US state code |
County | text | ||
City | text | ||
RatePercent | decimal | yes | Percentage in 0–100; convert once by dividing by 100, never treat 7.5 as a decimal multiplier |
EffectiveStart | date | yes | |
EffectiveEnd | date | ||
Active | boolean | yes | |
VersionNumber | number | yes | Immutable activated revision; referenced children are included in its content hash |
Change | reference | → MasterChanges. Required approved change before activation | |
JurisdictionCode | text | yes | Configured tax jurisdiction identifier; no automatic US-wide coverage |
TaxableCategories | longtext | yes | Configured RevenueCategory/product scope, inclusive/exclusive pricing and rounding method |
ReviewedBy | reference | → Users. Independent authorised reviewer under MasterChanges |
| Field | Type | Required | Details |
|---|---|---|---|
TemplateCode | text | yes | |
Name | text | yes | |
Segment | select | yes | Standard, Enterprise, Partner. Defaults the template from the quote's price book segment |
Document | attachment | The layout with merge fields for the parties, lines, totals and dates | |
CoverText | longtext | Opening text on the first page | |
TermsText | longtext | Terms and conditions printed with the quote and signed with it | |
ShowLineDiscounts | boolean | yes | If false, the PDF shows net prices only |
Active | boolean | yes | |
VersionNumber | number | yes | Immutable activated revision; referenced children are included in its content hash |
Change | reference | → MasterChanges. Required approved change before activation |
| Field | Type | Required | Details |
|---|---|---|---|
TemplateCode | text | yes | |
Name | text | yes | |
ContractType | select | yes | MasterAgreement, OrderForm, SubscriptionAgreement, ServicesAgreement |
Version | text | yes | |
DefaultTermMonths | number | yes | |
DefaultRenewalType | select | yes | None, AutoRenew, Manual |
RenewalNoticeDays | number | Days before EndDate the renewal notice goes out | |
RenewalUpliftPercent | decimal | Applied to the contract's prices when the renewal quote or order is generated | |
Document | attachment | The template with merge fields | |
Active | boolean | yes | |
VersionNumber | number | yes | Immutable activated revision; referenced children are included in its content hash |
Change | reference | → MasterChanges. Required approved change before activation | |
RenewalPriceBasis | select | yes | PriorAcceptedNet, CurrentPriceBook. Operative signed choice; no implicit switch at renewal |
RenewalTermMonths | number | Positive renewal term specified in the signed packet | |
RenewalProrationPolicy | select | yes | None, DailyByPeriod. Signed calendar-period rule for partial terms |
| Field | Type | Required | Details |
|---|---|---|---|
QuoteNumber | text | yes | |
QuoteType | select | yes | NewBusiness, Renewal, Amendment |
Account | reference | yes | → Accounts. The customer sold to |
EndCustomer | reference | → Accounts. On a channel deal, the customer the partner is buying for | |
Contact | reference | → Contacts. The person the quote is sent to and who signs it | |
Opportunity | reference | → Opportunities | |
IsPrimary | boolean | yes | One per Opportunity. Its GrandTotal syncs to the opportunity and its acceptance closes the deal won |
Contract | reference | → Contracts. The contract this quote renews or amends | |
CoTermEndDate | date | Amendments: the end date the new lines co-terminate on, defaulted from the contract's EndDate | |
Owner | reference | yes | → Users |
PriceBook | reference | yes | → PriceBooks |
Template | reference | yes | → QuoteTemplates. Defaulted from the price book segment |
Status | select | yes | Draft, Submitted, Approved, Sent, Accepted, Declined, Expired, Cancelled |
SendMode | select | yes | ForSignature, ForReview. ForSignature can make the fully completed exact packet the executed order form when all operative terms/signers are included; ForReview requires evidenced written acceptance and separate contract execution for term work |
QuoteDate | date | yes | |
ValidUntil | date | yes | Drives the expiry reminder and the flip to Expired |
ListTotal | decimal | yes | Sum of QuoteLines.ListTermAmount over the complete agreed term, including one-time items; bundle included components contribute zero revenue |
Subtotal | decimal | yes | Sum of QuoteLines.LineTotal over the complete term after line discounts and before header discounts |
DiscountTotal | decimal | yes | ListTotal minus Subtotal plus all QuoteDiscounts.AppliedAmount, including eligible system bundle discounts |
DiscountPercent | decimal | yes | 0–100 routed percentage = 100 × (ListTotal - Subtotal + manual header discount amounts) / ListTotal. Automatic proven bundle allocations excluded; compare unrounded, display to two decimals. Zero list requires zero discount amounts and routes at 0 |
MarginPercent | decimal | 100 × (TCV - known full-term cost) / TCV; null when TCV is zero or any cost unknown; unknown cost requires explicit Floor review | |
TaxJurisdiction | reference | → TaxRates | |
Tax | decimal | yes | Tax on eligible final TCV line allocations under TaxPolicySnapshot, rate divided by 100, reviewed exemption scope and deterministic cents. Missing rate/evidence sets ReviewRequired; accounting-owned estimate is disclosed, never an unconditional zero-tax promise |
GrandTotal | decimal | yes | TCV plus quote Tax estimate/final value; quote tax is identified by TaxMode and TaxStatus |
MRR | decimal | Sum of normalized net recurring monthly amounts active on RecurringAsOfDate; excludes one-time and future/inactive ramp segments, independent of invoice timing | |
ARR | decimal | MRR × 12; run-rate measure, not the amount of a partial-term contract | |
TCV | decimal | Subtotal less all header discounts; accepted pre-tax committed term value including one-time amounts | |
Currency | select | yes | USD |
PaymentTerms | select | yes | Net 15, Net 30, Net 45, Net 60, Due on receipt. Defaults from the account; a different value routes a Terms step to Deal Desk |
BillingMethod | select | yes | Upfront, Recurring, Milestone. Upfront bills the whole total at release; Recurring bills by each line's frequency and timing; Milestone bills from BillingMilestones |
CustomerPONumber | text | The buyer's purchase order, copied to the order and the invoices | |
BillToAddress | text | Defaulted from the account's BillingAddress | |
ShipToAddress | text | Defaulted from the account's ShippingAddress | |
NonStandardTerms | boolean | Set by the rep when SpecialTerms is filled; routes a Terms step to Deal Desk before send | |
SpecialTerms | longtext | Negotiated clauses that differ from the template, printed on the quote and merged into the contract | |
VersionNumber | number | yes | Current working revision; each submission freezes a complete QuoteVersions record before approval |
SubmittedAt | datetime | ||
ApprovedAt | datetime | ||
SentAt | datetime | ||
AcceptedAt | datetime | Exact time the current accepted version obtained valid acceptance; never inferred from a recipient-only signature callback | |
AcceptanceDocument | attachment | The buyer's PO or written acceptance when SendMode is ForReview | |
Notes | longtext | ||
CurrentVersion | reference | → QuoteVersions. Frozen submission/sent version; any material edit creates a fresh draft revision | |
AcceptedVersion | reference | → QuoteVersions. Single authorised accepted revision; immutable after acceptance | |
ContractTemplate | reference | → ContractTemplates. Selected before submission for term work; its exact terms form part of the signature packet | |
RenewalPriceBasis | select | PriorAcceptedNet, CurrentPriceBook. Frozen operative contract policy | |
TaxMode | select | yes | ConfiguredInline, AccountingFinalized |
TaxStatus | select | yes | Estimated, Final, ReviewRequired. AccountingFinalized quotes disclose estimate until accounting acknowledges actual invoice tax |
TaxPolicySnapshot | longtext | yes | Tax rates/versions, exemption scope, product categories, effective-date policy, rounding and finalization ownership |
CreatedAt | datetime | yes | Quote creation time for velocity metrics |
DraftEditors | longtext | yes | Named-user IDs of owner and every material editor of this revision; approval exclusion set |
AcceptanceBasis | select | CompletedEnvelope, WrittenAcceptance, SignedAutoRenewal. SignedAutoRenewal requires original executed automatic-renewal authority and RenewalDecisions evidence | |
AcceptanceEvent | reference | → BusinessEvents. Authenticated/authorised accepted-version event | |
RenewalDecision | reference | → RenewalDecisions. Unique term decision when QuoteType is Renewal | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry | |
RecurringAsOfDate | date | Required for recurring quotes; default earliest recurring service start, explicitly printed with MRR/ARR. Future ramp values remain in the period plan |
| Field | Type | Required | Details |
|---|---|---|---|
Quote | reference | yes | → Quotes |
LineNumber | number | yes | |
ParentLine | reference | → QuoteLines. Set on a component line of a bundle | |
Product | reference | yes | → Products |
Quantity | number | yes | |
ListUnitPrice | decimal | yes | USD quantity-unit price per BillingFrequency (or once for OneTime), including options; immutable snapshot on submission |
LineDiscountPercent | decimal | Default 0. Reduces NetUnitPrice and counts toward the routed DiscountPercent | |
NetUnitPrice | decimal | yes | ListUnitPrice × (1 - LineDiscountPercent / 100); cadence-unit price before header allocation |
LineTotal | decimal | yes | Complete term amount after line discount, before header allocation; recurring cadence amounts expanded by frozen period/proration plan |
UnitCost | decimal | Cost per quantity unit per BillingFrequency, converted from reviewed source cadence if necessary; null means unknown | |
MarginPercent | decimal | Margin after all header allocations and full-term costs; null for unknown cost/zero net, with explicit review | |
UnderFloor | boolean | yes | Computed after all header discounts using the same cadence/term floor basis; zero-revenue included components use parent-bundle combined cost/floor policy |
AutoAdded | boolean | System-owned; only a proven rule action or bundle component can set true | |
RuleNotes | text | Trace of the rules that touched this line | |
TermMonths | number | Positive finite term for recurring/service commitments; determines service end together with StartDate and signed proration policy | |
StartDate | date | Required for recurring and term-service lines; all service periods use inclusive start/exclusive end | |
BillingFrequency | select | OneTime, Monthly, Quarterly, Annual. Defaults from the product's BillingCadence | |
BillingTiming | select | InAdvance, InArrears. Recurring lines only | |
EndDate | date | Exclusive service end; mandatory for recurring and term-service lines | |
ListTermAmount | decimal | yes | List price × quantity × full cadence periods plus agreed partial-period factors, or once for OneTime |
HeaderDiscountAllocated | decimal | yes | Sum of all header allocations from QuoteDiscountAllocations |
NetTermAmount | decimal | yes | LineTotal - HeaderDiscountAllocated; nonnegative, final accepted amount |
PeriodAmountsJSON | longtext | yes | Canonical full-term calendar periods, proration fractions, allocated discounts and net amounts; conserved through billing |
SourceRule | reference | → ProductRules. Proven active rule for automatic line | |
SourceAction | reference | → RuleActions. Exact action plus revision used for automatic line | |
SourceComponent | reference | → BundleComponents. Exact bundle component source | |
SourceVersion | text | Rule/component version and stable expansion key; mutually consistent with AutoAdded | |
AmendmentAction | select | Add, Replace, Cancel. Required on Amendment quotes; accepted amendments apply only after execution and Deal Desk verification | |
ExistingContractLine | reference | → ContractLines. Required for Replace/Cancel, same contract and effective scope |
| Field | Type | Required | Details |
|---|---|---|---|
QuoteLine | reference | yes | → QuoteLines |
Option | reference | yes | → ProductOptions |
AppliedPriceDelta | decimal | yes | Snapshot of ProductOptions.PriceDelta when selected |
| Field | Type | Required | Details |
|---|---|---|---|
Quote | reference | yes | → Quotes |
Reason | select | yes | Volume, Strategic, Competitive, Promo, Loyalty, OneTime, Bundle. Bundle is workflow-owned and requires verified source; users cannot relabel discretionary discounts as Bundle |
DiscountType | select | yes | PercentOff, FlatAmount |
DiscountValue | decimal | yes | Percent for PercentOff, USD for FlatAmount |
AppliedAmount | decimal | yes | Computed nonnegative USD full-term discount under approved stacking order; capped by remaining eligible line net amount |
Status | select | yes | Draft, Submitted, Approved, Rejected, AutoApproved. Approval belongs to the immutable version, not a mutable row flag |
Justification | longtext | The rep's case for the discount, shown to approvers | |
SubmittedAt | datetime | ||
ResolvedAt | datetime | ||
SourceBundle | reference | → BundleDiscounts. Required only for system Bundle discounts; version frozen | |
SourceVersion | text | Immutable promotion revision and eligibility hash | |
SystemGenerated | boolean | yes | True only for validated bundle workflow; protected from user edits |
Priority | number | yes | Frozen deterministic order; bundle promotions first by configured priority, then manual rows by unique priority |
| Field | Type | Required | Details |
|---|---|---|---|
Quote | reference | yes | → Quotes |
Name | text | yes | Deposit on order, Balance on shipment, Go-live acceptance |
Percent | decimal | Share of accepted pre-tax NetTermAmount for the scoped real quote/order lines, never GrandTotal. Per scope percentages sum to 100 | |
Amount | decimal | Pre-tax accepted amount; amount-based milestones exactly sum to scoped NetTermAmount; never apply tax twice | |
Trigger | select | yes | OnOrder, OnShipment, OnAcceptance, OnDate |
TargetDate | date | Required when Trigger is OnDate; a forecast date otherwise | |
SalesOrderLine | reference | → SalesOrderLines. Optional specific staged-order scope; pre-acceptance scope uses QuoteLine and is frozen before signature | |
SortOrder | number | ||
QuoteLine | reference | → QuoteLines. Required for line-scoped milestone, otherwise entire accepted quote is allocated across real lines | |
ReleaseRule | select | yes | Full, Proportional. Full waits for full scoped shipment/acceptance; Proportional releases each evidenced fraction once |
TriggerQuantity | number | Positive quantity threshold in the scoped line unit; required for OnShipment/OnAcceptance | |
AcceptedVersion | reference | → QuoteVersions. Frozen milestone terms |
| Field | Type | Required | Details |
|---|---|---|---|
Quote | reference | yes | → Quotes |
ApprovalType | select | yes | Discount, Floor, Terms |
QuoteDiscount | reference | → QuoteDiscounts. The header discount row the justification is read from, when there is one | |
StepOrder | number | yes | Chained tiers are decided in this order |
Tier | reference | → DiscountApprovalMatrix. Empty for a Terms step | |
Approver | reference | yes | → Users. Named active eligible person in the immutable routing snapshot; owner/material editors of this version excluded |
DelegatedFrom | reference | → Users. Original named principal; does not change the final Approved/Rejected decision | |
EscalatedFrom | reference | → DiscountApprovalSteps. The step that waited past its tier's EscalationHours | |
RequestedPercent | decimal | yes | The quote's DiscountPercent at the time of routing |
RequestedAt | datetime | yes | |
Decision | select | yes | Waiting, Pending, Approved, Rejected, Delegated, Escalated, Skipped, Blocked, Superseded. New delegate decisions are Approved/Rejected; legacy Delegated is incomplete historical provenance and cannot satisfy approval |
DecisionAt | datetime | ||
Comment | text | ||
QuoteVersion | reference | yes | → QuoteVersions. Complete immutable reviewed submission |
Delegation | reference | → ApprovalDelegations. Exact approved grant valid at assignment and decision | |
DecisionBy | reference | → Users. Actual signer, equal to assigned eligible Approver | |
PolicySnapshot | longtext | yes | Matrix version, tier grouping/quorum, resolution candidates, exclusion set, escalation and auto-band result |
DecisionEvent | reference | → BusinessEvents. Unique decision event, version and signer bound |
| Field | Type | Required | Details |
|---|---|---|---|
Quote | reference | yes | → Quotes |
VersionNumber | number | yes | |
Status | select | yes | Submitted, Approved, Sent, Accepted, Declined, Superseded, Withdrawn, Expired, Cancelled. Lifecycle projection; commercial content never changes after snapshot |
SubtotalSnapshot | decimal | yes | |
DiscountTotalSnapshot | decimal | yes | |
TaxSnapshot | decimal | yes | |
GrandTotalSnapshot | decimal | yes | |
LinesJSON | longtext | Required canonical complete snapshot of lines, options, rule results, price/cost/floor sources, allocations and billing periods; mirrors typed QuoteVersionLines | |
ChangeSummary | text | What changed, written by the rep | |
SnapshotAt | datetime | yes | Creation time before approval or signature; never deferred until a later edit |
SnapshottedBy | reference | yes | → Users |
ContentHash | text | yes | Hash of complete commercial snapshot, including header/addresses/buyer/PO/dates/options/prices/tax/terms/templates/milestones/renewal/approval policy |
HeaderJSON | longtext | yes | Complete frozen header, selected templates and their content/version, operative contract/renewal terms and tax disclosures |
ApprovalPolicyJSON | longtext | yes | Complete routing and master versions, named eligible signers/quorum and editor exclusions, including automatic-band decisions |
MilestonesJSON | longtext | yes | Frozen accepted pre-tax shares, scopes, dates and evidence release rules |
ListTotalSnapshot | decimal | yes | Full-term list value |
NetTotalSnapshot | decimal | yes | Accepted/submitted pre-tax term value after all discounts |
MRRSnapshot | decimal | yes | Normalized recurring monthly value after discounts |
ARRSnapshot | decimal | yes | Normalized annual recurring value after discounts |
SentDocument | attachment | Immutable originally sent packet; separate from executed document | |
ExecutedDocument | attachment | Fully executed packet; does not replace SentDocument | |
ApprovedAt | datetime | All required version-bound decisions complete | |
AcceptedAt | datetime | Valid buyer/automatic acceptance of this exact version | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry | |
RecurringAsOfDate | date | Frozen report date for MRRSnapshot and ARRSnapshot; future ramps not summed as simultaneous service | |
SentAt | datetime | First dispatch time of this exact version; retries retain the original | |
DeclinedAt | datetime | Valid final decline time of this version | |
ExpiredAt | datetime | Actual expiry transition time for this version |
| Field | Type | Required | Details |
|---|---|---|---|
EnvelopeNumber | text | yes | |
DocumentType | select | yes | Quote, Contract |
Quote | reference | yes | → Quotes |
Contract | reference | → Contracts. Set when DocumentType is Contract | |
Provider | select | yes | DocuSign, PandaDoc, Dropbox Sign, Adobe Acrobat Sign |
ProviderEnvelopeID | text | yes | |
Recipient | reference | yes | → Contacts |
RecipientEmail | text | yes | Snapshot of the contact's email at send |
Status | select | yes | Created, Sent, Delivered, Viewed, Signed, Declined, Voided, Expired, ReviewRequired. Signed means full required envelope completion, not one recipient signature |
Document | attachment | Immutable originally sent packet; never overwritten by executed document | |
SentAt | datetime | ||
LastEventAt | datetime | ||
QuoteVersion | reference | yes | → QuoteVersions. Exact content sent for quote or contract |
ContentHash | text | yes | Exact sent commercial packet hash and required-signature manifest |
ExecutedDocument | attachment | Completed executed packet, retained separately | |
RequiredSignersJSON | longtext | yes | Named required signers, email/identity, roles and completion rules; freezes recipient changes |
CompletedAt | datetime | Authenticated full-envelope completion timestamp | |
CreateEvent | reference | → BusinessEvents. Idempotent send request |
| Field | Type | Required | Details |
|---|---|---|---|
Envelope | reference | yes | → EQuoteEnvelopes |
EventType | select | yes | Sent, Delivered, Viewed, Signed, Declined, Reassigned, Voided, Expired, Completed. Signed can mean a recipient event only; Completed is required for envelope acceptance |
OccurredAt | datetime | yes | Provider event timestamp; arrival order is not execution order |
ActorEmail | text | ||
ActorIP | text | ||
Payload | longtext | Raw provider payload for audit | |
ProviderEventID | text | yes | Unique within provider/account; duplicates no-op, same key with changed payload quarantined |
ReceivedAt | datetime | yes | Authenticated reception time |
AuthenticationStatus | select | yes | Verified, Rejected. Only Verified can affect lifecycle |
ProcessingStatus | select | yes | Pending, Applied, Duplicate, IgnoredStale, Quarantined |
ContentHash | text | yes | Payload hash and resolved envelope/version identity |
Event | reference | → BusinessEvents. Local validated event; unknown envelope or changed recipient requires review |
| Field | Type | Required | Details |
|---|---|---|---|
ContractNumber | text | yes | |
Account | reference | yes | → Accounts |
EndCustomer | reference | → Accounts. On a channel deal, the customer named on the agreement | |
Quote | reference | yes | → Quotes. The quote that created it |
Template | reference | yes | → ContractTemplates |
Owner | reference | yes | → Users |
Signatory | reference | → Contacts | |
Status | select | yes | Draft, InReview, SentForSignature, Signed, Active, Amended, Expired, Terminated, Renewed. Signed alone is not verified release authority |
StartDate | date | yes | Earliest effective term service start among current ContractLines; inclusive |
EndDate | date | yes | Latest effective recurring/service end among current ContractLines; exclusive, not earliest start plus longest term |
TermMonths | number | yes | Header summary only; actual line dates determine coverage |
RenewalType | select | yes | None, AutoRenew, Manual |
RenewalNoticeDays | number | ||
RenewalUpliftPercent | decimal | Signed uplift applied once to the signed RenewalPriceBasis; no unilateral price-book switch | |
RenewalOf | reference | → Contracts. The prior contract this one renews | |
TCV | decimal | yes | Sum of signed effective commitments, retaining original and amendment delta history; no blind sum of replacement plus replaced line |
ARR | decimal | Run rate of effective recurring ContractLines on the report as-of date, excludes one-time goods/setup | |
PaymentTerms | select | yes | Net 15, Net 30, Net 45, Net 60, Due on receipt. From the quote; the terms invoices are dated by |
SignedAt | datetime | ||
SignedDocument | attachment | The executed agreement; EQuoteEnvelopes.ExecutedDocument when the completed quote packet was the agreed signed instrument | |
Notes | longtext | ||
QuoteVersion | reference | yes | → QuoteVersions. Executed source version for contract/most recent amendment; original history retained on ContractLines |
TermsHash | text | yes | Exact operative signed terms and referenced versions |
VerificationStatus | select | yes | Pending, Verified, Rejected |
VerifiedBy | reference | → Users. Deal Desk who checks executed packet against approved version before effectiveness/order release | |
VerifiedAt | datetime | Required with Verified status and current TermsHash | |
VerifiedTermsHash | text | Must equal TermsHash; mismatch requires fresh verification | |
VerificationNotes | longtext | Executed document, identity and commercial discrepancy evidence | |
RenewalPriceBasis | select | yes | PriorAcceptedNet, CurrentPriceBook. Exact signed choice |
RenewalTermMonths | number | Positive agreed renewal term | |
RenewalProrationPolicy | select | yes | None, DailyByPeriod |
NoticeDeadline | datetime | Exact contractual notification deadline/timezone for the expiring term | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
SalesOrderNumber | text | yes | |
Quote | reference | yes | → Quotes |
Contract | reference | → Contracts | |
Account | reference | yes | → Accounts |
EndCustomer | reference | → Accounts | |
Owner | reference | yes | → Users |
Status | select | yes | Draft, Confirmed, Released, Fulfilled, Closed, Cancelled. Release is local authorization; downstream acknowledgment is EventDeliveries, not status alone |
OrderDate | date | yes | |
RequestedDate | date | Delivery or provisioning date the buyer asked for | |
CustomerPONumber | text | Copied from the quote; required at confirm when the account has PORequired | |
BillToAddress | text | From the quote | |
ShipToAddress | text | From the quote; on a channel deal, the end customer's address | |
OrderTotal | decimal | yes | Sum of immutable allocated SalesOrderLines.LineTotal; full-term pre-tax value after all discounts |
BillingMethod | select | yes | Upfront, Recurring, Milestone |
PaymentTerms | select | yes | Net 15, Net 30, Net 45, Net 60, Due on receipt. From the contract, else the quote |
ERPReference | text | Order number in the fulfilment or provisioning system after release | |
ReleasedAt | datetime | Local Deal Desk release time; ERP receipt is separately acknowledged | |
Notes | longtext | ||
QuoteVersion | reference | yes | → QuoteVersions. Accepted authority for quantities/value allocated to this order |
ConfirmedBy | reference | → Users. Deal Desk; required on confirmation | |
ConfirmedAt | datetime | Confirmation time against account exposure and verified contract | |
ReleasedBy | reference | → Users. Deal Desk; required for release | |
CreditExposureAmount | decimal | yes | Uninvoiced net allocation plus documented tax reserve; transfers atomically to invoice balance at issue |
TaxReserve | decimal | yes | Final/estimated tax exposure reserve; unresolved estimate explicitly reviewed, never silent zero |
ConfirmationEvidence | longtext | PO, accepted version, contract verification, address/contact, availability and credit revision checked | |
ReleaseEvent | reference | → BusinessEvents. Unique order release/outbound intent | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
SalesOrder | reference | yes | → SalesOrders |
LineNumber | number | yes | |
ParentLine | reference | → SalesOrderLines. Set on a bundle's component line | |
QuoteLine | reference | yes | → QuoteLines |
Product | reference | yes | → Products |
Quantity | number | yes | |
QuantityFulfilled | number | yes | Computed net posted Shipment FulfillmentEvents; never hand-edited; reversals cannot exceed unreversed quantity |
UnitPrice | decimal | yes | Frozen net cadence-unit amount after allocated header discounts; rounding display only, not authority to recompute full term |
LineTotal | decimal | yes | Authoritative full-term accepted net allocation from OrderAllocations, including header discounts. May differ from rounded Quantity × UnitPrice for recurring/prorated terms |
BillingFrequency | select | yes | OneTime, Monthly, Quarterly, Annual |
BillingTiming | select | InAdvance, InArrears | |
TermMonths | number | ||
ServiceStart | date | ||
ServiceEnd | date | ||
Status | select | yes | Open, PartiallyFulfilled, Fulfilled, Cancelled |
AcceptedLine | reference | yes | → QuoteVersionLines. Exact immutable accepted line |
QuantityAccepted | number | yes | Computed net customer Acceptance FulfillmentEvents, separate from shipment |
OptionsJSON | longtext | yes | Immutable configured options and applied deltas for ERP/provisioning |
PeriodAmountsJSON | longtext | yes | Allocated accepted period amounts; sum equals LineTotal |
RevenueCategory | select | yes | Product, Subscription, Services, Support. Frozen accepted classification |
| Field | Type | Required | Details |
|---|---|---|---|
ScheduleNumber | text | yes | |
SalesOrder | reference | yes | → SalesOrders |
Contract | reference | → Contracts | |
Account | reference | yes | → Accounts |
Owner | reference | yes | → Users |
Status | select | yes | Draft, Active, Suspended, Completed, Cancelled |
BillingMethod | select | yes | Upfront, Recurring, Milestone |
Frequency | select | OneTime, Monthly, Quarterly, Annual, OnMilestone. Mixed recurring frequencies use separate compatible schedules | |
BillingTiming | select | InAdvance, InArrears. From the order lines; a schedule with mixed timing splits into one per timing | |
ProrationMethod | select | yes | None, DailyByPeriod. Must match accepted frozen period plan, not a billing-time repricing choice |
StartDate | date | yes | |
EndDate | date | ||
TotalToBill | decimal | yes | Sum of Amount on effective leaf plan lines excluding Skipped/Cancelled ancestors; accepted pre-tax plan conserved with issued amounts |
BilledToDate | decimal | yes | Sum of Amount on Invoiced schedule lines; credit memos do not silently re-open claims |
NextBillDate | date | Earliest Scheduled unclaimed line only when parent Active; Pending milestones remain without a bill date | |
QuoteVersion | reference | yes | → QuoteVersions. Accepted immutable billing authority |
PlanVersion | number | yes | Frozen active billing plan; date-only changes require review and explicit supersession of unclaimed lines |
ActivatedBy | reference | → Users. Billing Specialist who reconciles line totals/periods and accepted terms | |
ActivatedAt | datetime | Required before billing eligibility | |
ActivationHash | text | Hash of accepted source, line allocations, dates and milestone rules | |
GenerationEvent | reference | → BusinessEvents. Unique order allocation/plan generation event | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
Schedule | reference | yes | → InvoiceSchedules |
LineNumber | number | yes | |
SalesOrderLine | reference | yes | → SalesOrderLines |
Milestone | reference | → BillingMilestones. Set on milestone-billed lines | |
Description | text | yes | |
ScheduledDate | date | The date the billing run will pick this line up; empty while a milestone line is Pending | |
ServicePeriodStart | date | ||
ServicePeriodEnd | date | ||
Amount | decimal | yes | Pre-tax accepted net allocation for this real order line, period/milestone and evidence release, rounded once with final residual conserved |
Status | select | yes | Pending, Scheduled, Claimed, Invoiced, Skipped, Cancelled. Claimed locks one invoice intent; Skipped/Cancelled never erase accepted billable value without approved replacement/cancellation authority |
Invoice | reference | → Invoices | |
Allocation | reference | yes | → OrderAllocations. Accepted quantity/value source |
FulfillmentEvent | reference | → FulfillmentEvents. Shipment/acceptance evidence for this released milestone tranche | |
ClaimEvent | reference | → BusinessEvents. Unique billing claim; claim, invoice creation and source consumption atomic | |
AmountVersion | number | yes | Immutable plan amount revision; invoice snapshots it |
ReleaseKey | text | yes | Unique allocation/period/milestone/tranche identity; prevents recurring or proportional milestone rebilling |
Supersedes | reference | → InvoiceScheduleLines. Retired unclaimed date-plan predecessor or split parent; descendant amounts exactly conserve its amount, never a second charge | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
InvoiceNumber | text | yes | |
Account | reference | yes | → Accounts |
BillToContact | reference | → Contacts. From the account's BillingContact | |
SalesOrder | reference | yes | → SalesOrders |
Contract | reference | → Contracts | |
CustomerPONumber | text | From the order; printed on the invoice | |
Status | select | yes | Draft, Issued, Sent, PartiallyPaid, Paid, Void. Only unissued Draft may void directly; issued immutable invoices require controlled compensating correction and external acknowledgment where delivered |
InvoiceDate | date | yes | |
DueDate | date | yes | InvoiceDate plus PaymentTerms |
PaymentTerms | select | yes | Net 15, Net 30, Net 45, Net 60, Due on receipt. From the Contract, else the SalesOrder, else the Account |
IsOverdue | boolean | yes | Set by the daily job when DueDate has passed and Balance is above zero |
Subtotal | decimal | yes | Computed: sum of InvoiceLines.LineTotal |
Tax | decimal | yes | |
Total | decimal | yes | Final Subtotal plus Tax; only final immutable issued total is eligible for cash application |
AmountPaid | decimal | yes | Net posted PaymentApplications after linked reversal amounts; historical cash applications remain intact when a paid invoice receives a credit |
CreditTotal | decimal | yes | Sum of InvoiceAppliedAmount on Applied CreditMemos plus Posted AccountCreditApplications targeted here, excluding reversed applications; unused or reserved account credit does not settle this invoice |
Balance | decimal | yes | Total - AmountPaid - CreditTotal; atomic applications never permit a negative result |
ERPReference | text | Invoice id in the accounting system | |
PostedAt | datetime | Local immutable issue/posting timestamp. Accounting acknowledgment is EventDeliveries.AcknowledgedAt; never infer remote posting from this field | |
InvoiceDocument | attachment | ||
SentAt | datetime | ||
IssueEvent | reference | → BusinessEvents. Unique immutable invoice issue and schedule claim event | |
ContentHash | text | Immutable issued header/lines/tax version | |
TaxMode | select | yes | ConfiguredInline, AccountingFinalized |
TaxStatus | select | yes | Pending, Final, ReviewRequired. Final required for issue, buyer send and payment application |
TaxEvidence | longtext | Rate/source/version, taxable base, exemption, decimal rounding and accounting finalization acknowledgment | |
AccountingStatus | select | yes | NotRequested, Pending, Acknowledged, Uncertain, Rejected, Reconciled. Delivery projection |
AccountCreditCreated | decimal | yes | Informational sum of applied memo excess allocated to account credit; does not reduce this invoice Balance twice |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry | |
SaleType | select | yes | CreditSale, CashSale. Frozen classification for credit-sales/DSO reporting; no classification invented from current paid status |
| Field | Type | Required | Details |
|---|---|---|---|
Invoice | reference | yes | → Invoices |
LineNumber | number | yes | |
Product | reference | yes | → Products |
ScheduleLine | reference | → InvoiceScheduleLines | |
Description | text | yes | |
Quantity | number | yes | |
UnitPrice | decimal | yes | |
LineTotal | decimal | yes | Authoritative accepted schedule Amount excluding tax; Quantity × UnitPrice is explanatory at finite precision, never a second term multiplication |
ServicePeriodStart | date | ||
ServicePeriodEnd | date | ||
ParentLine | reference | → InvoiceLines. Bundle hierarchy only when parent occurs on same invoice; otherwise source parent retained in SourceSnapshot | |
SalesOrderLine | reference | yes | → SalesOrderLines. Real billed configured product; no placeholder for whole order |
RevenueCategory | select | yes | Product, Subscription, Services, Support. Immutable accepted classification |
TaxAmount | decimal | yes | Final line tax on net taxable base, separately rounded under recorded policy |
SourceSnapshot | longtext | yes | Accepted line/version, options, term, allocation, source parent and net/tax details |
| Field | Type | Required | Details |
|---|---|---|---|
CreditMemoNumber | text | yes | |
Invoice | reference | yes | → Invoices |
Account | reference | yes | → Accounts |
Status | select | yes | Draft, Submitted, Approved, Rejected, Issued, Applied, Void. Rejection explicit; after issue immutable, corrections use approved compensating evidence |
Reason | select | yes | Pricing error, Service credit, Dispute, Write-off, Cancellation |
Amount | decimal | yes | Positive gross credit = sum CreditMemoLines.NetAmount + TaxAmount. Bounded by original invoice eligible uncredited value, including a paid invoice; not by current Balance |
CreditDate | date | yes | |
RequestedBy | reference | yes | → Users |
ApprovedBy | reference | → Users. Requester only under explicit within-limit policy snapshot; above limit an independent Executive Approver | |
IssuedAt | datetime | Local issue time; accounting acknowledgment recorded separately | |
ERPReference | text | Credit note id in the accounting system | |
Notes | longtext | ||
InvoiceAppliedAmount | decimal | yes | Portion applied atomically to source invoice remaining Balance at issue |
AccountCreditAmount | decimal | yes | Amount - InvoiceAppliedAmount; surplus credit for later same-account application/refund |
AccountCreditRemaining | decimal | yes | AccountCreditAmount minus active Reserved/Posted AccountCreditApplications; cancelled/reversed uses free credit only through evidenced compensation |
ApprovalPolicySnapshot | longtext | Credit limit/version, requester, independent approver when required, reason and source invoice content hash | |
ApprovedAt | datetime | Decision time bound to submitted content | |
SubmittedHash | text | Frozen reason, line/tax amounts and source invoice version | |
IssueEvent | reference | → BusinessEvents. Unique local issue/accounting delivery event | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
PaymentNumber | text | yes | |
Account | reference | yes | → Accounts |
Status | select | yes | Unapplied, PartiallyApplied, Applied, Refunded, Returned. Projection of retained amount/application/reversal effects; setting status alone has no financial effect |
PaymentDate | date | yes | |
Amount | decimal | yes | |
AmountApplied | decimal | yes | Net posted PaymentApplications after linked reversals, bounded by currently retained payment amount |
UnappliedAmount | decimal | yes | Amount minus net application amounts minus confirmed returned/refunded amounts; cannot be negative |
Method | select | yes | ACH, Wire, Card, Check |
Reference | text | Bank or processor reference | |
RecordedBy | reference | yes | → Users |
ReturnedAmount | decimal | yes | Net confirmed Return FinanceAdjustments; full Returned status only when entire receipt is returned |
RefundedAmount | decimal | yes | Net confirmed Refund FinanceAdjustments on this payment |
ReceiptEvent | reference | → BusinessEvents. Unique source receipt identifier and payload hash | |
Currency | text | yes | USD; same account/currency for every application |
RecordedAt | datetime | yes | Receipt recording time; PaymentDate remains business date |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
Payment | reference | yes | → Payments |
Invoice | reference | yes | → Invoices |
AmountApplied | decimal | yes | Positive immutable amount; at posting cannot exceed retained unapplied payment cash or finalized same-account invoice Balance |
AppliedAt | datetime | yes | |
AppliedBy | reference | yes | → Users. Billing Specialist or configured limited matching service identity, with recorded initiator and policy |
Status | select | yes | Draft, Posted, Reversed, PartiallyReversed. Projection from posted adjustment evidence |
ReversedAmount | decimal | yes | Sum of confirmed ApplicationReversal FinanceAdjustments, never above original AmountApplied |
InvoiceHash | text | yes | Issued immutable invoice version being settled |
Event | reference | yes | → BusinessEvents. Unique application key and atomic source/destination version check |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
Version | reference | yes | → QuoteVersions |
QuoteLine | reference | yes | → QuoteLines. Source identity retained; later mutable drafts cannot change this snapshot |
LineNumber | number | yes | Unique within Version |
ParentLine | reference | → QuoteVersionLines. Same version; bundle structure | |
Product | reference | yes | → Products |
Quantity | number | yes | Positive accepted quantity; cancellation amendments use AmendmentAction and affected quantity, not negative sale quantities |
BillingFrequency | select | yes | OneTime, Monthly, Quarterly, Annual |
BillingTiming | select | yes | InAdvance, InArrears |
ServiceStart | date | Inclusive; mandatory for term work | |
ServiceEnd | date | Exclusive; mandatory for term work | |
ListTermAmount | decimal | yes | Full-term list value |
LineNetAmount | decimal | yes | Full-term value after line discounts, before header allocation |
HeaderDiscountAmount | decimal | yes | Sum immutable QuoteDiscountAllocations on this line |
NetAmount | decimal | yes | LineNetAmount - HeaderDiscountAmount; authoritative pre-tax commitment |
NormalizedMRR | decimal | yes | Net cadence-unit price × quantity divided by cadence months only when active on Version.RecurringAsOfDate; otherwise zero. OneTime always zero |
CostAmount | decimal | Full-term cost on same calendar/cadence basis, including included-component cost at bundle group | |
FloorAmount | decimal | Full-term applicable floor on same basis | |
OptionsJSON | longtext | yes | Configured option IDs/version/value/deltas and pricing/rule provenance |
PeriodsJSON | longtext | yes | Canonical calendar periods, net amounts, proration fractions and final residual; sum equals NetAmount |
RevenueCategory | select | yes | Product, Subscription, Services, Support |
AmendmentAction | select | Add, Replace, Cancel | |
ExistingContractLine | reference | → ContractLines. Same named contract, scoped effective interval/quantity | |
AmendmentEffectiveDate | date | No retroactive silent alteration of issued invoices or fulfilled orders | |
CadenceNetUnitPrice | decimal | yes | Recurring net quantity-unit price after proportional header discount allocation; OneTime uses once-only net price. PeriodsJSON retains rounding/proration precision |
| Field | Type | Required | Details |
|---|---|---|---|
Version | reference | yes | → QuoteVersions |
VersionLine | reference | yes | → QuoteVersionLines |
QuoteDiscount | reference | yes | → QuoteDiscounts |
SourceBundle | reference | → BundleDiscounts. Required for exclusion from routed manual discount | |
SourceVersion | text | yes | Discount rule or discretionary row immutable revision |
Kind | select | yes | Manual, Bundle |
EligibleBase | decimal | yes | Remaining eligible net amount before this ordered allocation |
Amount | decimal | yes | Nonnegative USD allocation; aggregate equals frozen AppliedAmount, never exceeds base |
AllocationKey | text | yes | Unique version/discount/line identity |
| Field | Type | Required | Details |
|---|---|---|---|
AcceptedLine | reference | yes | → QuoteVersionLines |
SalesOrderLine | reference | yes | → SalesOrderLines |
Quantity | number | yes | Positive reserved accepted quantity; total effective allocations cannot exceed source quantity |
NetAmount | decimal | yes | Accepted pre-tax portion, including all discount shares; sum cannot exceed source NetAmount |
PeriodsJSON | longtext | yes | Reserved service intervals and amounts, including last-allocation rounding residual |
Status | select | yes | Reserved, Confirmed, Released, Consumed, Cancelled |
ReservedAt | datetime | yes | Atomic claim time; drafts reserve explicitly and expire only by controlled cancellation |
CancelledQuantity | number | yes | Unfulfilled/unbilled portion released by authorised cancellation; never already consumed quantity |
CancelledAmount | decimal | yes | Unbilled accepted amount released, with commitment evidence; billed reductions need credit/amendment |
InvoicedAmount | decimal | yes | Sum consumed net schedule amount; credits do not automatically reopen billable allocation |
Event | reference | yes | → BusinessEvents. Stable source version/allocation key and payload |
| Field | Type | Required | Details |
|---|---|---|---|
Contract | reference | yes | → Contracts |
AcceptedLine | reference | yes | → QuoteVersionLines |
Product | reference | yes | → Products |
Action | select | yes | Add, Replace, Cancel |
Supersedes | reference | → ContractLines. Required for Replace/Cancel; same contract and matching affected scope | |
Quantity | number | yes | Affected quantity; replacement state quantity is explicit, not added to original in effective totals |
EffectiveStart | date | yes | Inclusive start of this signed effect |
EffectiveEnd | date | Exclusive end; required for recurring services | |
BillingFrequency | select | yes | OneTime, Monthly, Quarterly, Annual |
RecurringNetUnitPrice | decimal | Accepted quantity-unit net price per cadence after all discounts; absent for OneTime | |
NetCommitment | decimal | yes | Signed new full-scope value; Cancel is zero new commitment |
ChangeAmount | decimal | yes | Signed delta: new remaining commitment minus superseded remaining unbilled commitment; original/add uses positive net amount |
NormalizedMRR | decimal | yes | Current recurring run rate for replacement/new state, zero for Cancel/OneTime |
Renewable | boolean | yes | Only signed eligible recurring lines; one-time hardware/setup never copied into recurring renewal |
Status | select | yes | PendingExecution, PendingVerification, Effective, Superseded, Ended |
TermsHash | text | yes | Executed exact version/operative contract terms |
VerifiedBy | reference | → Users. Deal Desk | |
VerifiedAt | datetime | Required before effect | |
CorrectionEvidence | longtext | Required links to approved credits, affected order/schedule allocations and fulfillment corrections when amendment touches already billed or fulfilled scope |
| Field | Type | Required | Details |
|---|---|---|---|
SalesOrderLine | reference | yes | → SalesOrderLines |
Type | select | yes | Shipment, Acceptance, Reversal |
Quantity | number | yes | Positive quantity in line units; a reversal references its original event |
OccurredAt | datetime | yes | Actual event timestamp, not webhook receipt time |
RecordedAt | datetime | yes | Reception time |
Actor | reference | → Users. Internal authorized recorder when applicable | |
ExternalActor | text | Provider or customer identity and authentication provenance | |
Evidence | attachment | Shipment/provisioning proof or buyer acceptance | |
Reverses | reference | → FulfillmentEvents. Exact original event; no reverse above unreversed quantity | |
Event | reference | yes | → BusinessEvents. Unique source operation |
Status | select | yes | Pending, Posted, Rejected, ReviewRequired |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
Principal | reference | yes | → Users |
Delegate | reference | yes | → Users. Active eligible approver with required role; principal cannot equal delegate |
Scope | select | yes | Discount, Floor, Terms |
Tier | reference | → DiscountApprovalMatrix. Exact allowed tier, not unrestricted promotion | |
StartsAt | datetime | yes | Inclusive validity start |
EndsAt | datetime | yes | Exclusive validity end |
Status | select | yes | Draft, Submitted, Approved, Rejected, Revoked, Expired |
RequestedBy | reference | yes | → Users. Principal or Admin on evidenced request |
ApprovedBy | reference | → Users. Independent Admin or Executive Approver, excluding principal/delegate | |
ApprovedAt | datetime | Required for authority | |
Reason | longtext | yes | Absence/coverage justification and limits |
| Field | Type | Required | Details |
|---|---|---|---|
ChangeNumber | text | yes | Unique change identifier |
Scope | select | yes | Catalog, Rules, Pricing, Tax, QuoteTemplate, ContractTemplate, ApprovalMatrix, CreditPolicy, IntegrationPolicy |
RecordKeys | longtext | yes | Exact masters and child identities/versions, no live query as approval scope |
ProposedContent | longtext | yes | Canonical complete proposed version snapshot |
ContentHash | text | yes | Hash approved for activation |
Status | select | yes | Draft, Submitted, Approved, Rejected, Activated, Retired |
RequestedBy | reference | yes | → Users. Authorized master owner |
Editors | longtext | yes | Named material editors excluded from approval |
ApprovedBy | reference | → Users. Independent active Admin or Executive Approver | |
ApprovedAt | datetime | Decision bound to ContentHash | |
EffectiveAt | datetime | Activation time after tests and approval | |
ValidationEvidence | longtext | Rule convergence, matrix coverage/named users, price/floor/cost coverage or tax/template review as applicable |
| Field | Type | Required | Details |
|---|---|---|---|
Quote | reference | yes | → Quotes |
Rule | reference | → ProductRules | |
Action | reference | → RuleActions | |
BundleComponent | reference | → BundleComponents | |
VersionNumber | number | yes | Working quote revision evaluated |
SourceVersion | text | yes | Immutable rule/component revision |
Outcome | select | yes | AutoAdded, Removed, Blocked, Excluded, Recommended, Warned, Passed |
Quantity | number | Affected quantity when applicable | |
OccurredAt | datetime | yes | Evaluation time |
AttemptKey | text | yes | Stable submitted mutation/evaluation key; same attempt replay does not add hits |
InputHash | text | yes | Canonical evaluated proposed configuration |
Detail | longtext | yes | Message, source and result evidence; saved separately when quote mutation is rejected |
| Field | Type | Required | Details |
|---|---|---|---|
Opportunity | reference | yes | → Opportunities |
SourceLineID | text | yes | Unique CRM opportunity-item identity |
SKU | text | yes | Inbound product identifier |
Quantity | number | yes | Positive quantity |
OptionsJSON | longtext | Inbound option identifiers and requested values | |
Product | reference | → Products. Required before Status Mapped/Seeded | |
Status | select | yes | Unmapped, Mapped, Seeded, Rejected |
QuoteLine | reference | → QuoteLines. One seeded line per opportunity-item/source revision | |
SourceRevision | text | yes | CRM revision and payload hash |
| Field | Type | Required | Details |
|---|---|---|---|
Contract | reference | yes | → Contracts |
TermKey | text | yes | Unique contract plus expiring start/end and signed terms version |
NoticeDeadline | datetime | yes | Exact deadline and recorded timezone |
Status | select | yes | Pending, NoticeReceived, Renewing, NonRenewing, Completed, ReviewRequired |
Decision | select | Renew, DoNotRenew | |
DecisionAt | datetime | Actual notice/decision time | |
RecordedBy | reference | → Users. Deal Desk for recorded decision | |
Evidence | attachment | Customer notice or approved manual decision evidence | |
AuthorityHash | text | yes | Original executed automatic-renewal terms or newly accepted renewal version |
PriceBasis | select | yes | PriorAcceptedNet, CurrentPriceBook |
UpliftPercent | decimal | yes | Signed uplift applied exactly once |
Quote | reference | → Quotes. Single renewal quote, whether auto or manual | |
RenewalContract | reference | → Contracts | |
GenerationEvent | reference | → BusinessEvents. Unique contract-term generation key | |
MigrationBatch | reference | → MigrationBatches. Historical import/cutover provenance | |
SourceKey | text | Unique source-system record/revision key; mandatory for imports, never regenerated on retry |
| Field | Type | Required | Details |
|---|---|---|---|
EventKey | text | yes | Unique source namespace plus business operation/revision key |
Source | text | yes | Authenticated connector, scheduled workflow or authorized user identity |
Kind | text | yes | Validated event kind, including acceptance/order/invoice/payment/credit/renewal operations |
SourceRecord | text | yes | Typed table and immutable record/version identity |
PayloadHash | text | yes | Canonical payload; changed payload under the same key is a conflict |
Payload | longtext | yes | Immutable complete input and accepted source references |
Status | select | yes | Received, Claimed, Applied, Duplicate, Rejected, Quarantined, Uncertain |
OccurredAt | datetime | yes | Business occurrence time |
ReceivedAt | datetime | yes | Reception time |
AppliedAt | datetime | Set in same atomic transaction as local effects | |
Effects | longtext | Exact created/updated record IDs, before/after revisions and conserved quantities/amounts | |
MigrationBatch | reference | → MigrationBatches. Imported events cannot replay suppressed live effects |
| Field | Type | Required | Details |
|---|---|---|---|
Event | reference | yes | → BusinessEvents |
Destination | text | yes | Configured CRM, signature, ERP, accounting, tax or email connection |
IdempotencyKey | text | yes | Unique event/destination/version key reused on safe retry |
Status | select | yes | Pending, Sending, Acknowledged, Uncertain, Rejected, Reconciled, Cancelled |
RequestHash | text | yes | Immutable payload hash, including configured options/terms/allocations |
Attempts | number | yes | Attempt count; unknown outcome does not authorize a fresh business event |
LastAttemptAt | datetime | Last delivery attempt | |
ExternalReference | text | Provider object ID matched to request | |
AcknowledgedAt | datetime | Actual external receipt/posting confirmation | |
ResponseEvidence | longtext | Authenticated response or reconciliation evidence; no fabricated API contract | |
ReconciledBy | reference | → Users. Authorized owner checks remote status before retry/compensation |
| Field | Type | Required | Details |
|---|---|---|---|
AdjustmentNumber | text | yes | Unique adjustment identifier |
Account | reference | yes | → Accounts |
Type | select | yes | ApplicationReversal, Return, Refund |
Payment | reference | → Payments. Required for Payment funding; must be empty for AccountCredit funding | |
Application | reference | → PaymentApplications. Required for ApplicationReversal | |
CreditMemo | reference | → CreditMemos. Required for AccountCredit-funded refund; must be empty for Payment funding | |
Amount | decimal | yes | Positive USD effect; bounded by unreversed application, retained payment or reserved credit |
Status | select | yes | Draft, Submitted, Approved, PendingConfirmation, Confirmed, Rejected, Uncertain |
RequestedBy | reference | yes | → Users. Billing Specialist |
ApprovedBy | reference | → Users. Independent Executive Approver for refunds/returns or disputed corrections; policy may allow evidenced routine application reversal by Billing Specialist | |
ApprovedAt | datetime | Bound to exact payload | |
Reason | longtext | yes | Bank return, remittance correction or approved refund with evidence |
Evidence | attachment | Required bank/processor confirmation for Confirmed cash effect | |
RelatedAdjustment | reference | → FinanceAdjustments. ApplicationReversal rows point to their grouped Return/Refund; group event identifies all included adjustments | |
Event | reference | yes | → BusinessEvents. Unique atomic adjustment key |
ConfirmedAt | datetime | Actual money/reversal effect time | |
FundingSource | select | yes | Payment, AccountCredit. Exactly one source; AccountCredit permits Refund only and never reduces original payment retained cash or applications |
| Field | Type | Required | Details |
|---|---|---|---|
CreditMemo | reference | yes | → CreditMemos |
InvoiceLine | reference | yes | → InvoiceLines. Must belong to the memo source invoice |
NetAmount | decimal | yes | Positive credit no greater than original net minus prior issued credits on line |
TaxAmount | decimal | yes | Tax credit supported by original final tax and correction policy; nonnegative and within remaining original tax |
Reason | longtext | yes | Corrected scope and accepted price/discount allocation basis |
| Field | Type | Required | Details |
|---|---|---|---|
CreditMemo | reference | yes | → CreditMemos. Source surplus AccountCreditAmount |
Invoice | reference | → Invoices. Exactly one destination: same-account finalized issued invoice or Refund | |
Refund | reference | → FinanceAdjustments. Exactly one destination; Type Refund and same credit/account | |
Amount | decimal | yes | Positive amount, atomically reserved against remaining source credit |
Status | select | yes | Reserved, Posted, Cancelled, Reversed. Refund reservation posts only with confirmed cash effect; reversal is a guarded evidenced action, not editable status |
AppliedAt | datetime | Time invoice application or confirmed refund posts | |
AppliedBy | reference | yes | → Users. Billing Specialist |
Event | reference | yes | → BusinessEvents. Unique application operation |
ReversalEvent | reference | → BusinessEvents. Required to reverse an invoice-directed posted use; reopens that invoice and restores source surplus atomically | |
ReversalEvidence | longtext | Reason and original use; a confirmed refund cannot simply be reversed to fabricate returned funds |
| Field | Type | Required | Details |
|---|---|---|---|
BatchNumber | text | yes | Unique source/cutover batch |
SourceSystem | text | yes | Legacy authority and namespace |
CutoffAt | datetime | yes | Exact cutover timestamp/timezone and source watermark |
Mode | select | yes | HistoryOnly, OpeningOperations, QuotingOnly |
Status | select | yes | Staged, Reconciled, Approved, Activated, Rejected |
MappingJSON | longtext | yes | Stable source-to-target identities, two-pass references and original event IDs |
Evidence | attachment | Opening balances, accepted/signature/approval records, external IDs and live-system responsibility | |
SuppressedEffects | longtext | yes | Explicit sends, acceptance generation, orders, invoices, cash posting and renewals disabled for historical events |
ReconciliationJSON | longtext | yes | Original invoice totals, prior credits, net applications, retained/unapplied cash, accepted/order/unbilled allocations and signed contract terms |
ApprovedBy | reference | → Users. Independent Executive Approver or Admin, with Deal Desk commercial and Billing Specialist finance signoffs in evidence | |
ApprovedAt | datetime | Required before activation | |
QuotingEnabled | boolean | yes | Separate from billing/contract-generation handover |
DownstreamEnabled | boolean | yes | False in QuotingOnly until separately reviewed source ownership and opening schedules reconcile |
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.