Field dictionary

Here's a reminder of the original use case that explains why Cloud Kicks uses Frisbii: after their recent success with Green Kicks, Jose decided to take customer loyalty to an even more advanced level. He wants to send Cloud Kicks' true fans a new sneaker model at the beginning of each new quarter.

The first person interested is Mrs. Jackson, the director of the school danse Jackson Mini Jazz Dance, who is very happy with the sneakers she was able to test with her teams. She wants her best teams to wear new Cloud Kicks at every show. So she called Candace to find out more about subscriptions.

Since this is the first subscription she will sell, Candace asks Linda to explain how the subscription works in Frisbii. Axel is also part of the training, as he will be setting up the subscriptions from the quotations created by Candace.

Definition

Object	Description
Subscription	It is a contract by which one acquires the benefit of a regular service in return for a fixed price for a determined period of time, invoiced on a recurring basis.

Relationships with other objects

Here is the extract from the Conceptual Data Model showing the Subscription object and its relationships with other objects. It shows you the links between the objects mentioned and others that we will discover as we read the articles.

If you use Opportunities

If you use Quotations

Subscription fields

Here is a list of fields by tab (since version Summer'21) and section.

Details - Details

Record Name	Auto Number	Format : AB-{00000000}
Account	Lookup (Account)	Associated with the Salesforce object Account. Displayed on the subscription PDF.
Contact	Lookup (Contact)	Associated with the Salesforce object Contact.
Corporate Name	Lookup (Corporate Name)	Associated with the Frisbii object Corporate Name Displayed on the subscriptions PDF.
Date Of Subscription	Date	Date at which the customer subscribed.
Status	Picklist	Subscription status : draft, activated, suspended or completed. It should be activated in order to issue invoices. Here is an article about this subject: Subscriptions - Pre-validation of invoices
Locked	Checkbox	A lock subscription is not modifiable (used in particular during asynchronous process).

Details - Recurrence Options

Start Date	Date	Subscription validity start date. Set the start day for each invoice generated from the subscription
Start Date on the invoicing period	Date	Start date of the invoicing period. Useful when the subscription start before you actually provide the product.
Initial End Date	Date	End date set at the subscription creation.
End of invoicing period	Formula (date)	Displays the end of invoicing period following this formula: If the End date of eligible change orders is not filled or If the Initial End Date is greater than the End date of eligible change orders then the Initial End Date value is displayed in this field. Otherwise, it displays the End date of eligible change orders.
Frequency	Picklist	Monthly: every month Bimonthly: every 2 months Quarterly: every 3 months Quadrimester: every 4 months (available since version Spring'20) Half-yearly: every 6 months Annual: every year Determine the size of the period an invoice generated from the subscription cover.
Number of occurrences	Number (18,0)	Calculated from the length of the subscription divided by the frequency. You can adjust it manually.

Invoicing - Invoicing

Amount excl. VAT	Roll-Up Summary (SUM Subscription Line Item)	Sum of the amounts excluding VAT of the subscription line items 2 decimals.
VAT Amount	Roll-Up Summary (SUM Subscription Line Item)	Sum of the VAT amounts of the subscription line items. 2 decimals.
Amount incl. VAT	Roll-Up Summary (SUM Subscription Line Item)	Sum of the amounts including VAT of the subscription line item. 2 decimals.
MRR	Roll-Up Summary (SUM Subscription Line Item)	Sum of the amounts of MRR from the subscription line items. Monthly Recurring Revenue.
Billing terms	Picklist	Allows you to define whether the invoice dates are defined in relation to : the start date of the invoice (in advance). the end date of the invoice (in arrears). the invoice due date before the start date of the invoice (Payment in advance) the invoice due date after the end date of the invoice (Payment in arrears)
Day for Fates Calculation	Number (3,0)	Depending on the option chosen, the number indicated here allows you to add a deviation from this date or to indicate a fixed day. This is a field to be filled in by hand. It is possible to enter negative numbers.
Option of Date Calculation	Picklist	Fixed day before Term : indicate the desired fixed day before the start date (in advance) or the end date (in arrears). Fixed day after Term : indicate the desired fixed day after the start date (in advance) or the end date (in arrears) Difference from Term: "Day for Dates Calculation" is a positive number: difference of days after the start date (in advance) / end date (in arrears) "Day for Dates Calculation" is a negative number: difference of days before the start date (in advance) / end date (in arrears)
Date last generation of billing schedule	Date	Affiche la date de la dernière génération de l'échéancier de facturation.

Invoicing - Payments

Term of payment	Picklist	The agreed-upon time period for payment of amounts due. Refers to a set of picklist value sets. Net X: X days from the invoice date. Net EOM X: X days from the invoice date, at the end of the month.
Payment method	Picklist	The agreed payment method. To be customized in the picklist value set.
Payment plan	Lookup (Schedules)	Useful when the invoices will be paid in installments. You can generate that type of schedule from the invoice. Here is an article on this subject : Payment schedules - generating a payment schedule.
Client Bank Details	Lookup (Bank Details)	Allows you to fill in the bank details of the client. In order to do this, you must create the bank details by following this article: Corporate names - Bank details configuration.

Life Cycle - Renewal

Duration subscription renewal commitment	Number (3, 0)	To be filled in to automate the renewal of the subscription, by creating a renewal change order. Allows you to calculate the End date of the renewal change order, according to the chosen unit. Ex: if Renewal commitment duration = "1" and Renewal commitment unit = "Year" then the subscription will be renewed for 1 year.
Renewal Commitment Unit	Picklist	To be filled in to automate the renewal of the subscription, by creating a renewal change order. Month or Year. Allows you to calculate the End date of the renewal change order, according to the chosen unit. Ex: if Renewal commitment duration = "1" and Renewal commitment unit = "Year" then the subscription will be renewed for 1 year.
Renewal Date	Date	Allows you to indicate the date on which the renewal change order should be created.
Number of Renewals	Roll-up Summary (COUNT Change Order)	Displays the number of renewal change order related to the subscription.

Life Cycle - Interrupt

Desired termination date	Date	To be used in interruption automation.
Actual date of interruption	Date	You can enter the date on which the interruption should be effective here then use the suspend button. If you don't fill it, it will suspend the subscription with the current day.

Indexes

Index	Lookup (Index)	Allows you to enter an index (created before), when the subscription is in draft status. The index is used to recalculate the total amount of invoices including tax from a certain date. Example of index: Syntec index, which is used in France to measure the evolution of the cost of labor, essentially of an intellectual nature, for services provided.
Reference Index Value	Lookup (Index values)	Associated with the index value used as reference. Automatically defined by the combination of the Reference Index Date and the Index used.
Reference Index Date	Date	Date used to defined the Reference Indexe Value. By default = subscription start date.
Reference index coefficient	Number (5, 5)	Reference coefficient for the calculation of the revised price. Automatically retrieved via the Reference Index Value relationship.

Related Objects

Quotation	Lookup (Quotation)	Displays the quotation associated with the subscription.
Opportunity	Lookup (Opportunity)	Displays the opportunity associated with the subscription.
Accounting Data	Lookup (Accounting Data)	Displays the Accounting Data associated with the subscription. Displayed on the subscription PDF.
Amount excl. VAT of the quotation	Formula (Currency)	If the quotation is linked to a quotation, display the amount excl. VAT of the quotation.
Opportunity Amount	Formula (Currency)	If the subscription is linked to an opportunity, displays the amount of the opportunity.

Fields to be added on the page layout if needed

If you want to add fields in this page, please follow the steps here: User interface - The new dynamic page layouts and how to change them from Summer '21.

Comments	String (255)	Conditional field on the PDF template: if the field is empty, it will not be displayed on the PDF.
Currency	Picklist	Please follow this Salesforce article if you want to set up a multi-currency management. Beware: the currency can be filled in at several levels.
Date last generation of billing schedule	Date	Displays the date of the last generation of the billing schedule.
Discount (%)	Formula (Percent)	Displays the Discount Rate with only two decimals.
Discount Rate	Percent (10,6)	Rate (%) of the footer discount, applied to all invoice lines, on all invoices in the schedule.
Do not renew	Checkbox	Mark the subscription as an exception for renewal. To be used in the subscription auto renewal process.
End date of active change orders	Roll-up Summary (change order)	Returns the max End Date of the last active Change Order. Filters: Active? is checked on the Change Order And the Renewal? box is checked on the Change Order
End date of eligible change orders	Roll-up Summary (change order)	Returns the max End Date of the last Change Order eligible for billing. Filters: Eligible for Billing? is checked on the Change Order And the Renewal? box is checked on the Change Order
Expiry Date of the Contract	Formula (date)	Displays the end date of the subscription agreed upon with your client, following this formula: If the End date of active change orders is not filled or If the Initial End Date is greater than the End date of active change orders then the Initial End Date value is displayed in this field. Otherwise, it displays the End date of active change orders.
External ID	String (255) (external id)	If the subscription is associated with a record in a third-party system, you can enter the ID in this field.
Is Activated	Formula (Checkbox)	Checked if Status = Activated.
Is Draft	Formula (Checkbox)	Checked if Status = Draft.
Is Interrupted	Formula (Checkbox)	Checked if Status = Interrupted.
Language	Picklist	With this language tag="{!sofactoapp__Abonnement__c.sofactoapp__Langue__c}" in your subscription PDF template, the language chosen on the subscription will be applied to the subscription PDF. Beware: Like VAT, the language can be configured at several levels (inheritance). You can also configure it at the account, accounting data, invoice or quotation level.
Negative billing not allowed	Checkbox	Allows you to prevent an invoice from this subscription from being negative (by creating a Validation Rule linked to this box). To avoid negative amounts, the user will have to distribute the negative invoice lines to the next invoice(s).
Number for division	Number (10, 6)	When creating the subscription from the opportunity, you can fill in this field to define a division of the amount or quantity by this predefined number. À la création de l'abonnement depuis l'opportunité, vous pouvez renseigner ce champ afin de définir une division du montant ou de la quantité par ce nombre prédéfini. If the field is filled on the opportunity, it will be used to calculate the amount of the Subscription Line Items even if it is not filled in when the subscription is created.
Other Template	Lookup (Template)	Allows you to set up another PDF template for the subscription, instead of using the default template from the Corporate Name. This template will only apply to this subscription. Here is an article about it: PDF templates - How to set up packaged templates.
Price book	Lookup (Pricebook2)	Displays the price book linked to this subscription. Allows you to associate a price book manually.
Product configuration	Lookup (Product configuration)	Enable you to add a product configuration.
Reason for Discount	Textarea (255)	Here you can enter the reason for the discount. Depending on your invoice PDF template, this information will be included in the invoice PDF.
Reference PDF document	Lookup (Document Frisbii)	Link between from the subscription to the subscription PDF. This link is filled at the PDF creation.
Renewed	Formula (Checkbox)	Displays if the subscription has been renewed. If the field Next Subscription is filled, this checkbox is checked (versions prior to 3.64).
Special Terms	Text (255)	Allows you to enter the special conditions of the subscription. This field can be included in the PDF template of the subscription.
Subject	string (100)	To be filled in to be displayed on the subscription PDF, mentioned in the header of the invoice. Conditional field on the PDF template: if the field is empty, it will not be displayed on the PDF.
Subscription billing regularisation	Formula (Checkbox)	Displays the same value as the checkbox Billing regularization on the Corporate Name. This function allows you to regularize the billing when a modification occurs on a subscription line item while the billing period has already been issued. Here is an article on this subject: Subscriptions - Billing regularisation
Subscription Locked?	Formula (Checkbox)	The subscription is locked if the status is suspended or completed.
Tacit Renewal	Checkbox	Indicates that the subscription is automatically renewable from one period to another (if neither party expresses its will to break the contract). To be used when setting up the auto-renewal process.
Your Ref.	String (255)	Your reference : the reference you want to use to inform your customer (ex: purchase order number) Conditional field on the PDF template: if the field is empty, it will not be displayed on the PDF.