# CollectionsDashboardSettings Metadata Guide

> CollectionsDashboardSettings controls the org-wide enablement of the Collections Dashboard in Salesforce Revenue Cloud and Billing for tracking overdue invoices and accounts receivable.

- Source: https://sfdxtalk.com/docs/metadata/collections-dashboard-settings-metadata-type/
- Category: Metadata
- Applies to: Salesforce Winter '27 (API version 68.0)
- Level: intermediate
- Published: 2026-11-12
- Last updated: 2026-11-12
- Publisher: SFDX Talk Editorial (unofficial; not affiliated with or endorsed by Salesforce)
- License: CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/)

## Architectural Overview

In Salesforce Revenue Cloud and Subscription Management / Billing implementations, accounts receivable specialists rely on the **Collections Dashboard** to monitor past-due invoices, promised payments, dunning stages, and collector performance metrics. The `CollectionsDashboardSettings` metadata type (`CollectionsDashboard.settings-meta.xml`) provides the declarative org-level toggle to enable this capability.

By managing `CollectionsDashboardSettings` in SFDX source format, architects ensure that collections analytics and underlying collections objects are consistently enabled across SIT, UAT, and Production orgs before deploying collections [Flow](/docs/metadata/flow-metadata-type/) automations or custom lightning pages.

```mermaid
flowchart LR
    A["CollectionsDashboardSettings"] --> B["enableCollectionsDashboard = true"]
    B --> C["Collections Plan & Invoice Aging Tracking"]
    C --> D["Collector Worklist & CRM Analytics Views"]
```

## Directory Location and File Suffix

In Salesforce DX projects, `CollectionsDashboardSettings` is stored in the `settings` directory as `CollectionsDashboard.settings-meta.xml`.

| Property | Value |
| :--- | :--- |
| **Directory Path (SFDX)** | `force-app/main/default/settings/` |
| **File Name (SFDX)** | `CollectionsDashboard.settings-meta.xml` |
| **Classic Metadata File** | `settings/CollectionsDashboard.settings` |
| **Package.xml Type & Member** | `<name>Settings</name>` with `<members>CollectionsDashboard</members>` |

## Key Metadata Fields

The following table describes the primary boolean flag on `CollectionsDashboardSettings` in API version `68.0` (Winter '27):

| Field Name | Field Type | Architectural Description |
| :--- | :--- | :--- |
| `enableCollectionsDashboard` | `boolean` | Enables (`true`) or disables (`false`) the Revenue Cloud Collections Dashboard in the org. Defaults to `false`. |

## Declarative Metadata Example

The following `CollectionsDashboard.settings-meta.xml` file enables the Collections Dashboard:

```xml title="force-app/main/default/settings/CollectionsDashboard.settings-meta.xml"
<?xml version="1.0" encoding="UTF-8"?>
<CollectionsDashboardSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCollectionsDashboard>true</enableCollectionsDashboard>
</CollectionsDashboardSettings>
```

### Package Manifest (`package.xml`)

```xml title="manifest/package.xml"
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>CollectionsDashboard</members>
        <name>Settings</name>
    </types>
    <version>68.0</version>
</Package>
```

## SFDX CLI Retrieval and Deployment

Retrieve and deploy `CollectionsDashboardSettings` using the Salesforce CLI (`sf`):

```bash
# Retrieve CollectionsDashboardSettings from an org
sf project retrieve start --metadata Settings:CollectionsDashboard

# Deploy CollectionsDashboardSettings to the target org
sf project deploy start --metadata Settings:CollectionsDashboard
```

## Architect Best Practices and Gotchas

> [!WARNING]
> Deploying `<enableCollectionsDashboard>true</enableCollectionsDashboard>` requires that Revenue Cloud Billing / Collections licenses are active in the target org. If you maintain a shared repository across orgs with different license footprints, isolate `CollectionsDashboard.settings-meta.xml` in your Revenue Cloud package directory.

- **Assign Collector Permission Sets:** Enabling `CollectionsDashboardSettings` turns on the org-wide feature, but finance users still need the Collections permission set license and [PermissionSet](/docs/metadata/permission-set-metadata-type/) assignments to view the dashboard and manage `CollectionPlan` records.

## Frequently Asked Questions

### What does CollectionsDashboardSettings control in Salesforce Revenue Cloud?

It controls the enableCollectionsDashboard setting, which activates the native Collections Dashboard and accounts receivable tracking features for overdue invoices in Revenue Cloud Billing.

### How is CollectionsDashboardSettings referenced in package.xml?

Use the Settings metadata type with member name CollectionsDashboard in package.xml, which maps to force-app/main/default/settings/CollectionsDashboard.settings-meta.xml.

### Why would a deployment of CollectionsDashboard.settings-meta.xml fail?

Deploying CollectionsDashboardSettings fails if the target org does not have the required Revenue Cloud Billing / Collections licenses and CRM Analytics dependencies provisioned.

### Can CollectionsDashboardSettings be enabled in scratch orgs?

Yes, provided the scratch org definition file includes the corresponding Billing and Collections features and settings.

## Official References

- https://developer.salesforce.com/docs/platform/api-metadata/references/meta-types/metadata-collectionsdashboardsettings.md