Revenue Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Revenue Cloud Developer Resources
Product Catalog Management
Salesforce Pricing
Product Configurator
Transaction Management
Usage Management
Rate Management
Dynamic Revenue Orchestrator
Billing
Billing Standard Objects
Billing Platform Events
Billing Standard Invocable Actions
Billing Business APIs
Billing Apex Reference
Billing Metadata API Types
BillingSettings
Flow for Billing
Revenue Cloud Associated Objects
PDF

BillingSettings

Represents the settings for Salesforce Billing.

Parent Type and Manifest Access

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

The BillingSettings values are stored in the BillingSettings.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

Version

BillingSettings components are available in API version 62.0 and later.

Special Access Rules

These settings are available when Billing is enabled.

Fields

Field Name Description
enableBillingSetup
Field Type
boolean
Description
Indicates whether to enable Billing setting (true) or not (false). The default value is false.
enableCr​MemoApplication​ToPosted​Invoices
Field Type
boolean
Description
Indicates whether to enable Apply Credits to Posted Invoices setting (true) or not (false). The default value is false.
enableInvoiceEmailDelivery
Field Type
boolean
Description
Indicates whether to enable Configure Email Delivery Settings (true) or not (false). The default value is false. Available in API version 63.0 and later with Revenue Cloud Billing.
enableInvoicePdfGeneration
Field Type
boolean
Description
Indicates whether to enable Document Generation setting (true) or not (false). The default value is false. Available in API version 63.0 and later with Revenue Cloud Billing.
enableNeg​InvoiceLn​ConversionTo​CrMemoLn
Field Type
boolean
Description
Indicates whether to enable Convert Negative Invoice Lines to Credit Memo Lines setting (true) or not (false). The default value is false.
enableTransactions​ApplicationTo​Invoices
Field Type
boolean
Description
Indicates whether to enable Credit Application Level setting (true) or not (false). The default value is false.
enableTransaction​Journal​Creation
Field Type
boolean
Description

Indicates whether to create Transaction Journal records based on the defined general ledger account assignment rules for the billing entities when billing transaction records are created or updated (true) or not (false). The default value is false. Available in API version 63.0 and later with Revenue Cloud Billing.

Billing transaction records include these transaction types.

  • Invoice
  • Invoice Line
  • Invoice Line Tax
  • Credit Memo
  • Credit Memo Line
  • Credit Memo Line Tax
  • Payment
  • Refund
  • Payment Line Invoice
  • Payment Line Invoice Line
  • Credit Memo Inv Application
  • Credit Memo Line Invoice Line
enableTrxn​AmountsStorage​InCorp​Currency
Field Type
boolean
Description

Indicates whether to allow conversion of amounts of the Invoice, Invoice Line, Credit Memo, and Credit Memo Line records to your corporate currency (true) or not (false). The default value is false. Available in API version 63.0 and later.

Store the converted amounts in corporate currency-specific amount fields.

Declarative Metadata Sample Definition

The following is an example of a BillingSettings component.

<BillingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableBillingSetup>true</enableBillingSetup>
    <enableInvoicePdfGeneration>true</enableInvoicePdfGeneration>
    <enableTransactionsApplicationToInvoices>true</enableTransactionsApplicationToInvoices>
    <enableCrMemoApplicationToPostedInvoices>true</enableCrMemoApplicationToPostedInvoices>
    <enableInvoiceEmailDelivery>true</enableInvoiceEmailDelivery>
    <enableTransactionJournalCreation>true</enableTransactionJournalCreation>
    <enableTrxnAmountsStorageInCorpCurrency>true</enableTrxnAmountsStorageInCorpCurrency>
</BillingSettings>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Billing</members>
        <name>Settings</name>
    </types>
    <version>63.0</version>
</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.