Newer Version Available

This content describes an older version of this product. View Latest

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 is 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.
enableInvoicePdfGeneration
Field Type
boolean
Description
Indicates whether to enable Document Generation setting (true) or not (false). The default value is false.
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.

Declarative Metadata Sample Definition

The following is an example of a BillingSettings component.

1<BillingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
2    <enableBillingSetup>true</enableBillingSetup>
3    <enableInvoicePdfGeneration>true</enableInvoicePdfGeneration>
4    <enableTransactionsApplicationToInvoices>true</enableTransactionsApplicationToInvoices>
5    <enableCrMemoApplicationToPostedInvoices>true</enableCrMemoApplicationToPostedInvoices>
6    <enableInvoiceEmailDelivery>true</enableInvoiceEmailDelivery>
7</BillingSettings>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Billing</members>
5        <name>Settings</name>
6    </types>
7    <version>62.0</version>
8</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.