Subscription — entity reference

A customer's subscription to one item: who it is for (account, partner company, branch, asset), what it covers (item, item component, quantity, unit price) and its billing schedule (billing frequency, charge type, start, end, next and last billing dates). xMatix creates one when an invoice is posted to inventory (the invoice's Post Inventory action) and a line's item has the Item Type Subscription. That value is not in the shipped Item Type picklist, so out of the box no subscription is created. Subscription is in no shipped app, no seeded record page lists it, and no scheduled job bills it: recurring and usage invoicing routines exist, but nothing runs them. Treat a subscription as a register of what was sold and raise renewal invoices yourself. Records have no automatic numbering.

Fields

Field	Label	Type	Required	What it does
`AccountId`	Account	Lookup → Account		The customer the subscription is for. Required on the shipped New form. Invoice posting copies it from the invoice's account.
`Amount`	Amount	Currency		A total for reference. Nothing calculates it from Quantity and Unit Price, so it stays as typed.
`AssetId`	Asset	Lookup → Asset		The asset the subscription is tied to. Invoice posting takes it from the invoice line, or from the package line above it when the subscription item is a package component.
`BillingFrequency`	Billing Frequency	PickList		How often the subscription is billed: Monthly, Quarterly, Semiannual or Annual. Only Semiannual is seeded in the picklist; add the others as values with exactly these names. Invoice posting copies it from the item's Billing Frequency and uses it to set Next Billing Date. Values: Semiannual.
`BillingType`	Billing Type	PickList		Whether the subscription is billed in Advance or in Arrears. Invoice posting copies it from the item. Nothing reads it. Values: Advance, Arrears.
`BranchId`	Branch	Lookup → Branch		The selling branch. Invoice posting copies it from the invoice.
`ChargeType`	Charge Type	PickList		Recurring (a fixed charge each period) or Usage (charged on metered usage). Invoice posting copies it from the item. Only the unscheduled billing routines read it. Values: Recurring, Usage.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`EndDate`	End Date	Date		The last day of the subscription. Invoice posting sets it to the invoice's Document Date plus the item's Subscription Duration(Months), minus one day, and leaves it empty when the item has no duration.
`GoodwillDays`	Goodwill Days	Number		Extra days granted to the customer. Defaults to 0. For reference only; nothing reads it.
`Id`	Id	Guid	Yes
`InvoiceGroup`	Invoice Group	PickList		Reserved for grouping subscriptions on one invoice. Not used.
`IsPriceBundled`	Is Price Bundled	Boolean		Marks a price included in a package price. For reference only on subscriptions.
`ItemComponentId`	Item Component	Lookup → ItemComponent		The package component the subscription covers, when it was sold as part of a package. Not filled by invoice posting.
`ItemId`	Item	Lookup → Item		The subscribed item. Invoice posting copies it from the invoice line.
`LastBillingDate`	Last Billing Date	Date		The date the subscription was last billed. Empty on subscriptions created by invoice posting.
`LastModifiedById`	LastModifiedBy	Guid
`MarkupAmount`	Markup Amount	Currency		A markup amount for reference. Nothing fills or reads it.
`MarkupRate`	MarkupRate	Decimal		A markup percentage. Defaults to 0. Invoice posting copies the item's Markup Rate (%). Nothing reads it.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Subscription Name	Text	Yes	The subscription's name. Required. Subscription has no numbering setting, so a subscription created by invoice posting has no name and the posting is refused with "Name is required" until an administrator adds a document numbering setting for Subscription.
`NextBillingDate`	Next Billing Date	Date		The next date the subscription falls due. Invoice posting sets it to the invoice's Document Date plus one billing period, and leaves it empty when the billing frequency is not Monthly, Quarterly, Semiannual or Annual. Nothing raises an invoice when the date arrives, so use the field to find subscriptions due for renewal.
`OrderId`	Order	Lookup → Order		The sales order the subscription came from. Invoice posting copies the invoice's order.
`OrderLineId`	Order Line	Lookup → OrderLine		The order line the subscription came from. Invoice posting copies the invoice line's order line.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account		The company in your organization that sells the subscription. Invoice posting copies it from the invoice.
`PriceListId`	Price List	Lookup → PriceList		A price list for reference. Nothing fills or reads it.
`PriceListRuleId`	Price List Rule	Lookup → PriceListRule		A price list rule for reference. Nothing fills or reads it.
`PricingMethod`	Pricing Method	PickList		How the price is set. The seeded value is List Price. Invoice posting copies the item's Pricing Method. Nothing reads it. Values: List Price.
`Quantity`	Quantity	Number		How many units are subscribed. Defaults to 0. Invoice posting copies the line quantity.
`RecordTypeId`	Record Type	Guid, hidden
`SchemeLineId`	SchemeLine	Lookup → SchemeLine		A trade scheme line for reference. Nothing fills or reads it.
`StartDate`	Start Date	Date		The day the subscription starts. Invoice posting sets it to the invoice's Document Date.
`TaxGroupId`	Tax Group	Lookup → TaxGroup		A tax group for reference. Nothing fills or reads it.
`TerminatedDate`	Terminated Date	Date		The date the customer cancelled. Typed by you. It doesn't change any other field.
`UIProps`	UI Props	Text
`UnitCost`	Unit Cost	Currency		A cost per unit, for reference. Nothing fills or reads it.
`UnitPrice`	Unit Price	Currency		The price per unit. Invoice posting copies the invoice line's unit price.
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`Edit`	Edit	EditInline	Edit Subscription
`Edit`	Edit	Edit	Edit
`Editinlist`	Edit	Edit	Editlistrom
`New`	New	New	New
`New`	New	New	New Subscription

ItemComponent — looks up via ItemComponentId
Asset — looks up via AssetId
UserAccount — looks up via CreatedById
UserAccount — looks up via OwnerId
Order — looks up via OrderId
Item — looks up via ItemId
UserAccount — looks up via ModifiedById
Branch — looks up via BranchId
PriceList — looks up via PriceListId
TaxGroup — looks up via TaxGroupId
OrderLine — looks up via OrderLineId
Account — looks up via PartnerAccountId
PriceListRule — looks up via PriceListRuleId
Account — looks up via AccountId
Invoice — referenced by via SubscriptionId
SubscriptionUsageSummary — referenced by via SubscriptionId
SubscriptionUsage — referenced by via SubscriptionId
InvoiceLine — referenced by via SubscriptionId

Subscription — entity reference

Fields

Actions

Related entities

Related topics