You are here: Reference > Field Reference > Contract Fields

Contract Fields

Here is a description of the fields on the Contract object.

Key: * – Mandatory field; R – Read-only in all contexts; C – Only used on contracts of type Change Request on the enhanced Contract Detail page; D – Not available on the enhanced Contract Detail page.

The number indicates the number of characters that are allowed in this text field, where appropriate.

Field Name

   

Description

Account

*

 

Lookup to the Salesforce Account to which this contract belongs.

Active Contract     Lookup to the active contract if this is a change request.
Annual Recurring Revenue D   Monthly Recurring Revenue Multiplied by 12. Contract line items with the billing type One-off are excluded from this calculation. This includes discounts.
Approval Status C   Contains the approval status if this contract is a contract change request.

Company

 

 

Company to which this contract relates.

Contract Name

 

80

Textual name of the contract.

Contract Number

   

Number of the Contract.

Currency     Currency of the contract. If the contract contains contract line items and you change the currency using the enhanced Contract Detail page, that change is applied to the contract line items, but the prices and discounts are not updated to reflect the change. If you select a price book using the enhanced Contract Detail page, the prices in that price book for the selected currency are listed when you choose a product to add to the contract. The Discount popup on the enhanced Contract Detail page lists the discounts for the selected currency.
Notes: Notes Notepad
This field is only displayed if multiple currencies are enabled in your Salesforce OrgSalesforce organization.
If the contract contains line items you cannot change the currency using the Salesforce Contracts tab.

Description

 

255

Description of the contract.

End Contract Notes

    Additional information about the reason for ending the contract. This field is shown as Notes when ending a contract.

End Date

   

End date of the contract. The end date of new contract line items are initially set to this date.

Tip: Tip Blue Lightbulb
If a contract has already been ended, this is indicated by a flag icon next to the End Date field. Click the end date to view the reasons for ending the contract early. If the contract has not yet expired, you can make further changes to the end date on the popup that appears when you click the end date.

First Bill Date

 

 

First date on which the contract is to be billed. The first bill date of new contract line items are initially set to this date.

Major Version D  

Indicates the major version of the contract. This field is set to one when the contract is created. When you create a renewal the value of this field is incremented by one.

Tip: Tip Blue Lightbulb
A draft contract with a Major Version greater than one is a renewal. When you activate a renewal, it becomes an active contract. For more information, see Renewals.
Monthly Recurring Revenue D   Total monthly recurring revenue for all contract line items that do not have the billing type One-off. This includes discounts.
Original End Date    

Original date on which the contract was due to end. If this field contains a date, the duration of a renewal is calculated using this date instead of the contract end date. In this scenario, the contract end date is still used to calculate start date of the new contract.

Previous Contract     Lookup to the previous contract to which this contract relates.
Reason for Ending Contract    

Reason that the contract was ended. The default options are:

  • Terminated
  • Did not renew
  • Renewed

Your administrator can change these options.

Renewal of Previous Contract R   Indicates whether this contract is a renewal of the previous contract.
Renewal Reminder     Date on which to report that the contract is due for renewal. When entering a Renewal Reminder, the date you enter must be on or after today's date and on or after the contract Start Date.

Start Date

*

 

Date on which the contract commences. The start date of new contract line items are initially set to this date.

Status

   

Status of the contract. The status can be:

  • Active – Once a contract is active, you may need to create a change request to edit the contract depending on the options your administrator has chosen. See FinancialForce Billing Central Settings and Contract.
  • Draft – You can edit, delete and add lines to the contract. You can also edit and delete the contract.
  • Expired – The end date of the contract has been reached and the contract is not continuous or the contract was ended.
  • Superseded – This is contract has been replaced by another contract. You cannot edit a contract with this status.
Note: Note Notepad
To activate the contract and generate billing schedules, use the Activate button. To generate billing schedules for an active contract, use the Create Billing Schedules button on the Salesforce Contract Detail page.
Total Contract Value   16.2

Total value of all recurring fixed and one-off contract lines over the entire life of the contract if the contract is not continuous. This is the sum of Sales Price x Number of Terms for each contract line item. This includes discounts. If the contract is continuous, no value is displayed. When you make changes to the contract this field updates automatically on the enhanced Contract Detail page. If you use the Salesforce Contract Detail Page, you must use the Calculate Total Contract Value button to update this field See Calculate Contract Values.

Type R   The Type of contract. This determines whether the record is a contract or a change request.

Related Contracts

When you apply a change request to a contract, the changes on that change request are applied to the active contract. The change request then becomes a superseded contract and contains the contract as it was before the change request was applied. The Related Contracts related list on the Salesforce Contract Detail page shows related superseded contracts.

Next Contract

If the contract has been superseded or renewed, the Next Contract related list on the Salesforce Contract Detail page contains the next related contract.

Contract Line Items

Products, services and plans are applied to contracts as contract line items. Here is a description of the fields on a contract line item.

Key: * – Mandatory field; R – Read-only in all contexts; D – Not available on the enhanced Contract Detail page.

The number indicates the number of characters that are allowed in this text field, where appropriate.

Field Name

     

Description

Active Contract Line Item       Lookup to the active contract line item if this is a change request line item for a contract line item on an active contract.
Annual Recurring Revenue D     Monthly Recurring Revenue Multiplied by 12. The Annual Recurring Revenue for Contract line items with the billing type One-off is zero. This includes discounts.

Bill In Arrears

 

 

 

Indicates whether the contract line is to be billed in arrears. This is used for reporting purposes only.

Billed To   R  

Date up to which the contract line item has been billed. This is the Billing Period End Date of the related billing document line item, which belongs to the last completed billing document associated with this contract line item. This field is updated when the related billing document is complete.

Note: Note Notepad
If a change request line item is related to a contract line item that has been billed and the Billed To field of the change request line item contains a date, you can only change the End Date of that line. In this situation, you can only enter an End Date that is on or after the Billed To date of that line.

Billing Term

 

 

 

Defines the frequency in which billing schedules are created for the contract line item. This is a Lookup to a soft date. For information about soft dates, see Soft Dates.

Billing Type

      The way in which a bill is to be generated. You can choose from:
  • Recurring Fixed – a fixed fee is billed at a regular interval.
  • Recurring Variable – a fee is billed at a regular interval based on the quantity and usage data associated with the contract line item.
  • One-off – a fee is billed once.

The default value is None.

Note: Note Notepad
You can only activate contracts with a billing type other than None.

Contract

     

Contract to which this contract line item belongs.

Contract End Date   R   End date of the contract to which this contract line item belongs.
Contract First Bill Date   R   First bill date of the contract to which this contract line item belongs.
Contract Start Date   R   Start date of the contract to which this contract line item belongs.

Contract Status

  R  

Status of the contract to which this contract line item belongs.

Contract Type   R   Type of contract to which this contract line item belongs.

Currency

     

Currency of this contract line item.

Description

   

255

Textual description of the contract line item.

Discount       Lookup to the discount applied to the contract line item.
End Date *     End Date of the contract line item. When a new contract line item is created, this is initially set to the end date of the contract.
Note: Note Notepad
If a change request line item is related to a contract line item that has been billed and the Billed To field of the change request line item contains a date, you can only change the End Date of that line. In this situation, you can only enter an End Date that is on or after the Billed To date of that line.

First Bill Date

 

 

 

First date on which the contract line item is to be billed. When a new contract line item is created, this is initially set to the first bill date of the contract.

Monthly Recurring Revenue D     Monthly recurring revenue for the contract line item including discounts. This is calculated by multiplying the Sales Price by the Monthly Recurring Revenue Multiplier of the Billing Term associated with the contract line item. The Monthly Recurring Revenue for contract line items with the billing type One-off is zero. For more information, see Monthly Recurring Revenue Multiplier and Billing Term.
Monthly Recurring Revenue Multiplier D    

Multiplier used to calculate monthly recurring revenue. This is copied from the Monthly Recurring Revenue Multiplier on the Billing Term associated with the contract line item. This is set to zero for contract line items with the billing type One-off. For information, see Monthly Recurring Revenue Multiplier.

Plan Name

 

 

 

Lookup to the plan from which the contract line item was created.

Previous Contract Line Item       Lookup to the previous contract line item to which this contract line item relates.
Pricing Structure       Lookup to the pricing structure that determines the Unit Price for different quantities on this contract line item.
Pricing Type      

Pricing type of the contract line item. You can choose from:

  • Fixed – The Unit Price is fixed.
  • Volume – The Unit Price varies depending on the quantity purchased.
  • Tiered – The Unit Price varies depending on the quantity purchased and the quantity breaks in the pricing structure. Each quantity break is only applied to the units that exceed its quantity. See Tiered Pricing Structure.
Notes: Notes Notepad
When the Billing Type is Recurring Variable and the Pricing Type is Volume, a pricing structure must be specified in the Unit Price field. In this scenario, you can click the Unit Price field to set quantity breaks or change the existing quantity breaks for the contract line item when editing a contract.
On the Salesforce Contract Line Item Detail page, this field is calculated automatically based on whether you have entered a pricing structure for the line.

Product or Service

*

   

Lookup to the Salesforce Product to which the contract relates. This can be a product or service.

Quantity

 

   

Quantity of the product or service being purchased to six decimal places. The default value is zero. You must enter a value greater than zero if a fixed Billing Type is selected such as One-off or Recurring Fixed.

Revenue Category      

The type of revenue from which the contract line item originates. You can choose from:

  • Churn
  • Downgrade
  • Net New Booking
  • Upgrade

Sales Price

     

Total price for the contract line including discounts. This is either calculated using the formula Quantity x Unit Price or it is equal to the Sales Price Override if that field contains a value.

Note: Note Notepad
If a discount would make the Sales Price negative, it is set to zero instead.
Sales Price Override       Contains a value that is used to calculate the Sales Price when a contract line item contains a pricing structure.

Start Date

     

First date from which billing can commence for this contract line item. This must be on or after the Start Date of the contract.

Total Billed   R 16.2

Total amount billed for the contract line item.

When you set a billing document to complete, the Total Billed field on related contract line items is updated:

  • If the billing document is of type Invoice, the value of the related billing document line item is added.
  • If the billing document is of type Credit Note, the value of the related billing document line item is subtracted.

This enables you to create reports to analyze the revenue on each contract.

When you convert a billing document of type Invoice to Credit Note, a process is started to update this field.

Total Contract Line Value   R  

Total value of the contract line item over its lifetime including discounts:

  • Total Contract Line Value is zero:
    • If the Billing Type is Recurring Variable and a quantity has not been previously entered for the line.
    • If the Billing Type is Recurring Fixed and there is no end date.
  • If the Billing Type is Recurring Fixed and there is an end date, the Total Contract Line Value is calculated using the formula: Sales Price x Number of Terms (including partial terms).
  • Billing Type is One-off, the Total Contract Line Value is the Sales Price.

Unit of Measure

     

Lookup to the unit of measure used for reporting.

Unit Price

     

Price of one item to nine decimal places. This is used to calculate the Sales Price. If a variable Billing Type and volume or tiered Pricing Type is selected, selecting this field in the enhanced Contracts Detail page displays the Unit Price popup that enables you to set quantity breaks or change the existing quantity breaks for the contract line item. If a pricing structure is set for the contract line item, this field shows the minimum and maximum unit prices of the quantity breaks in that pricing structure.

Notes: Notes Notepad
When you use the enhanced Contract Detail page to create a contract line item for a product that is in a price book with a price book structure entry, a copy of the related pricing structure is applied to the contract line item. Editing the pricing structure on a contract line item does not change the pricing structure applied to a price book.
On the Salesforce Contract Line Item Detail page, we recommend that you create a copy of the pricing structure and apply it to the contract line item manually.
If the same pricing structure is applied to several contract line items and the quantity breaks on one of the contract lines is changed using the enhanced Contract Detail page, a new pricing structure is created for that contract line item.

Buttons

Key: C – Only available for a change request on the enhanced Contract Detail page; E – Only available on the enhanced Contract Detail page; N – Not available on a change request; R – Not available on a renewal; S – Only available on the Salesforce Contract Detail page.

Button Name     Description

Activate contract icon Activate

N  

Activates the contract and creates the billing schedules for it. If the button is not displayed, you cannot activate the contract.

Activate contract icon Apply to Contract     Enables you to apply a change request to the active contract to which it relates.

Add Plan

   

Adds a plan to a contract.

Back to List

   

Returns to the contract list.

Calculate Contract Values N S Displays the Calculate Contract Values page where you can update the values and totals of the contract based on its projected lifetime and the discounts applied.
Gray shop ticket icon used to represent that no discount is applied to the contract line item. Add Discount   E Displays the Discount popup, which enables you to add a discount to the contract line item.
Blue shop ticket icon used to represent that a discount is applied to the contract line item. Edit Discount / Discount Applied   E Indicates that a discount is applied to the contract line item. Hover over the icon to view the discount. Displays the Discount popup, which enables you to choose a different discount for the line or remove the existing one.
Clear Filters   E Removes all filters applied to the columns on the enhanced Contract Detail page.

Create billing document icon. Create Billing Documents

N  

Enables you to create billing documents for active contracts from the contracts list or detail page. Displays the Create Billing Documents page, where you can choose a range of billing dates for which to process billing schedules. You can also enter the dates to appear on the billing document. If the button is not displayed, you cannot create billing documents. Clicking Create Billing Documents on the list view of the Contracts tab without selecting any contracts creates billing documents for all active contracts that are due to be billed.

Create Billing Schedules N   Displays the Create Billing Schedules page, which enables you to create billing schedules for the contract.
Create change request icon left/right arrows inside a circle. Create Change Request N   Creates a change request. This enables you to make changes to an active contract and submit them for approval before applying them to the contract.
Save Icon Create Contract N   Creates the contract.
Create Icon Create New Contract N  

Creates a new contract.

Renew Contract icon Document with circular arrow. Create Renewal N   Creates a renewal for an active or expired contract.
Create Renewals N R Creates renewals for selected active contracts on the contracts list view.

Cancel Icon Cancel

   

Cancels the action.

Delete Contract button icon Delete    

Enables you to delete contracts that are not Active. This deletes a single contract or the selected contracts depending on whether you are viewing the list of contracts or the contract detail page. If the button is not displayed, you cannot delete the contract.

Edit Icon Edit

   

Enables the fields for editing on the current contract.

Edit with Enhanced Page   S Displays the enhanced Contract Detail page in edit mode.
End Contract Icon. Document with cross in corner. End Contract     Enables you to end an active contract before its end date has been reached.
New Pricing Structure     Enables you to create a new pricing structure for a contract line item from the Contract Line Item Detail page.

Save Icon Save

   

Saves the contract.

Thumbs up icon Submit for Approval C  

Displays the Approvals page where you can submit a change request for approval and view approval history for that change request.

Note: Note Notepad
Once the change request is submitted for approval, the label of this button changes to View Approval History.
Related Change Request View related document icon. Square with a diagonal arrow pointing up from the top right corner.   E Enables you to view a change request for an active contract. This link appears on an active contract when a change request is in progress for that contract. Clicking the link opens the related change request in the same tab. Clicking the icon opens the related change request in a new tab.
Related Contract View related document icon. Square with a diagonal arrow pointing up from the top right corner.   E Enables you to view the contract to which change requests and renewals relate. This link appears on change requests and renewals. Clicking the link opens the related contract in the same tab. Clicking the icon opens the related contract in a new tab.
Related Renewal View related document icon. Square with a diagonal arrow pointing up from the top right corner.   E Enables you to view a renewal for an active or expired contract. This link appears on an active or expired contract when a renewal is in progress for that contract. Clicking the link opens the related renewal in the same tab. Clicking the icon opens the related renewal in a new tab.
Note: Note Notepad
You cannot renew a contract that has a related renewal.
Thumbs up icon View Approval History C  

Displays the Approvals page where you can view the approval history for a contract change request and submit a contract change request for approval.

Note: Note Notepad
The label of this button is Submit for Approval until the change request is submitted for approval.
Settings Icon Columns: Reset Layout   E Enables you to reset the columns on the enhanced Contract Detail page to the default layout.

Settings Icon Tips: Show / Hide

  E

Enables you to show or hide the field tips on the Edit Contract page.

Settings Icon Switch to Salesforce Detail page   E Enables you to display the contract using the Salesforce Detail page. To switch back to the enhanced page, click Edit with Enhanced Page or View on Enhanced Page.
View on Enhanced Page   S Displays the enhanced Contract Detail page in view mode.

Maximize Icon

Restore Icon

  E Maximizes / Restores the page in your browser window.
Help Icon     Opens the related help topic.
Delete Icon   E Removes the product or plan line item from the contract.
Expand Details Pane Icon Collapse Details Pane Icon   E Expands / Collapses the Contract Detail pane.
Information icon used to edit and view the description.   E Indicates that the contract line item has a description. Enables you to edit and view the description of a contract line item. Hover over the icon to view the current description.
Information icon indicating that there is no description for the liine. This is used to edit and view the description.   E Indicates that no description is set on the contract line item. Enables you to add a description for a contract line item.
Add Product drop-down list on the Plans tab.

Screenshot showing Add Product drop-down with Price Book drop-down

  E

Enables you to choose products to add to the contract and enter a product name to filter the list of products. The Price Book drop-down list is shown if one or more price books are active on your Salesforce OrgSalesforce organization. If a price book is selected, a price is shown for each product in the drop-down list if there is one for the selected price book.

Note: Note Notepad
If you select a different price book, this has no effect on contract line items that already exist on the contract.
Tips: Tips Blue Lightbulb
If you cannot see the product or plan you want to add, type the first few characters of the product or plan to filter the list.
If you are adding a product and a Price Book is selected, the drop-down list shows the default price for each product in that price book for the selected currency. The selected Price Book provides a default Unit Price. Unit Prices for existing contract line items are not updated if you select a different Price Book after adding them.
If a product shows –, this indicates that the price book does not contain a price for the product in the selected currency.
If a product shows a range of values for the Unit Price such as USD 70.00 - ..., this indicates that a pricing structure applies to that product. You can edit the quantity breaks applied to a contract line. See Applying a Pricing Structure.
When you add a product to a contract, the Billing Type of that product is added to the contract line item if there is one.
Long product names are truncated. To view the full product name, hover over that product in the list.

Related Concepts

Contracts

Change Requests

Enhanced Contracts Overview

Related Tasks

Activating a Contract

Adding a Plan or Product to a Contract

Billing for Usage

Calculating Contract Values

Creating a Contract

Creating a Contract from a Plan

Deleting a Contract

Editing a Contract

Ending Contracts

Creating Billing Documents from Contracts

Creating Billing Schedules from Contracts

© Copyright 2009-2017 FinancialForce.com, inc. All rights reserved.
Various trademarks held by their respective owners.