Billing Contract Field Sets

Here is a description of the field sets on the Billing Contract and Billing Contract Line Item objects. Billing Central checks whether you have been granted access to fields in the Billing Central field sets. Fields that you do not have access to are hidden. For more information, see Field-Level Security.

Enhanced Contract Additional Fields

The Enhanced Contract Additional Fields field set on the Billing Contract Line Item object is used by the following component and page to determine which additional contract line item fields to display:

  • The BC Contract Line Items Lightning component which presents a custom related list for Billing Contract Line Items on the Billing Contract Detail page.
  • The Edit Selected Products page that is displayed when you click the Add or Edit button in the custom related list presented by the BC Contract Line Items Lightning component.

You can control whether the contract line item fields in this field set are added to, or replace, the default fields displayed by the BC Contract Line Items Lightning component and the Edit Selected Products page. Do this using the Replace Fields in Custom Related List field in the Billing Central Settings custom setting. When Replace Fields in Custom Related List is enabled, the fields in the field set replace the default fields. When Replace Fields in Custom Related List is disabled, the fields in the field set are appended to the default fields.

The Enhanced Contract Additional Fields field set on the Billing Contract object is used by the return value of the API method that creates change requests.

Note:

Billing Central's own fields that are already displayed are not repeated if they are also included in these field sets.

Name

Description

Object

Where is it Used?

Enhanced Contract Additional Fields

You can add these types of field to this field set:

  • Checkbox
  • Currency
  • Date and Date / Time
  • Email
  • Lookup Relationship
  • Master-Detail Relationship
  • Number
  • Percent
  • Phone
  • Picklist
  • Text
  • URL

Additionally, you can also add related object fields, formula fields and roll-up summary fields of a type listed here. For information about using a different field set, see Enhanced Contract Field Set.

Notes:

Adding custom fields that require a unique value is not supported.

Dependent picklists are not fully supported. Updates to controlling fields might not be validated.

Billing Contract

The return value of the API method that creates change requests.

Enhanced Contract Additional Fields

Most contract line item fields can be added to this field set. The only ones that cannot be added are Currency, Deleted, Description, and Value Calculation Warning.

You can add these types of field to this field set:

  • Checkbox
  • Currency
  • Date and Date / Time
  • Email
  • Lookup Relationship
  • Number
  • Percent
  • Phone
  • Picklist
  • Text
  • URL

Additionally, you can also add related object fields, formula fields and roll-up summary fields of a type listed here. For information about using a different field set, see Enhanced Contract Line Field Set.

Notes:

Adding custom fields that require a unique value is not supported.

Dependent picklists are not fully supported. Updates to controlling fields might not be validated.

Billing Contract Line Item
  • In Lightning Experience, the custom related list for Billing Contract Line Items on the Billing Contract Detail page, and the Edit Selected Products page that is displayed when you click the Add or Edit button in this custom related list.

Active Contract Locked Fields

These field sets are used by contracts with the "Active" status. The field sets define which fields on a contract are read-only when the contract is active, in addition to an internal list of fields that Billing Central locks on active contract lines.

Warning:

Removing fields from these field sets might compromise your billing data because users will be able to edit active contracts without going through a change request. The change request process ensures that only valid changes can be made to an active contract, and that billing schedules and billing documents are automatically regenerated to reflect the changes. If you allow users to bypass this process you must manually rectify any billing schedules, billing documents, and any transactions in your accounting system that are impacted by their edits.

Name

Description

Supported Fields

Object

Active Contract Locked Fields

Only the fields listed opposite on the Billing Contract object are supported in this field set. If other fields are added to this field set, errors might occur when saving contracts.

Note:

If the Start Date, End Date or First Bill date fields are not included in this field set but are protected from being edited on active contract lines, errors may occur when you save changes to those fields on an active contract.

  • Account
  • Company
  • Contract Name
  • Description
  • End Contract Notes
  • End Date
  • First Bill Date
  • Original End Date
  • Proration Policy
  • Reason for Ending Contract
  • Renewal Reminder
  • Start Date
Billing Contract
Active Contract Line Locked Fields

The fields listed opposite on the Billing Contract Line Item object are supported in this field set.

Four of the fields listed opposite are included in the field set by default.

Billing Central holds the other fields in an internal list of contract line fields that are locked on active contracts to prevent them from being edited. For more information about this internal list of locked fields and how you might bypass it, see Protecting Contract Line Fields from Edits When a Contract Is Active.

Tip:

You can add custom fields to this field set if their values need to be locked once the contract has been activated.

Included in the field set by default:

  • Bill in Arrears
  • Description
  • Revenue Category
  • Unit of Measure

Locked via an internal list

  • Align for Billing
  • Billing Term
  • Billing Type
  • Canceled
  • Charge Term
  • Discount
  • End Date
  • First Bill Date
  • Pricing Structure
  • Product or Service
  • Quantity
  • Recurring Bill Date
  • Start Date
  • Unit Price
Billing Contract Line Item

Cloned Line Excluded Fields

Billing Central is sometimes required to clone a contract line item. For example, this can happen when you use the Amend Prices feature. If you do not want the values of some Billing Contract Line Item fields to be copied to a cloned contract line item, you can exclude them by adding the fields to the Cloned Line Excluded Fields field set. Any fields that you add to this field set are cleared on a cloned contract line item.

In addition to fields in the Cloned Line Excluded Fields field set, the following fields are always cleared on cloned contract line items:

  • ActiveContractLineItem__c
  • PreviousContractLineItem__c
  • TriggerId__c
  • BilledTo__c
  • BilledExternallyTo__c
  • TotalBilled__c
  • AmountBilledExternally__c
  • IsControllingLine__c
Warning:

If you are using Revenue Management with Billing Central, we recommend that any fields Revenue Management adds to the Billing Contract Line Item object are added to the Cloned Line Excluded Fields field set so that values in these fields are not copied when a contract line item is cloned.

Name

Description

Object

Cloned Line Excluded Fields

There are no fields in this field set by default.

Notes:

Adding custom fields that require a unique value is not supported.

Adding formula fields is not supported.

Billing Contract Line Item