---
schema_version: "1"
id: 453b312102e28d5cbc0a7d086203b038f9fddabe4608cca933a98336b5ff297f
title: SubAccounts.SubAccount
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/TPM_SubAccountsSubAccount.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccountsSubAccount.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: c9823d48d6d849ad0ff83f7396bb41a834e6b70ef3016af5c99c16cd36104eb6
description: This APEX class provides programmatic access to a single Sub Account information contained in a TPM_SubAccounts instance.Gets the included/excluded status of the sub account.Get the volume percent of the sub account.Gets the sub account Account External ID.Sets the sub account account external ID.Sets the sub account as included or excluded.Sets the sub account volume percent (Decimal between 0 and 100)
---
# SubAccounts.SubAccount

This APEX class provides programmatic access to a single Sub Account information contained in a TPM\_SubAccounts instance.

## Namespace

cgcloud

- **[TPM\_SubAccounts.SubAccount Methods](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccountsSubAccount.htm#unique_1343807077)**

## TPM\_SubAccounts.SubAccount Methods

The following are methods for TPM\_SubAccounts.SubAccount.

- **[global Boolean isIncluded](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccountsSubAccount.htm#method_promotion.do.work)**  
    Gets the included/excluded status of the sub account.
- **[global Decimal getVolume](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccountsSubAccount.htm#unique_227471620)**  
    Get the volume percent of the sub account.
- **[global String getAccountExternalId](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccountsSubAccount.htm#unique_137620977)**  
    Gets the sub account Account External ID.
- **[global SubAccount setAccountExternalId](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccountsSubAccount.htm#unique_1724312312)**  
    Sets the sub account account external ID.
- **[global SubAccount setIncluded](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccountsSubAccount.htm#global_SubAccount)**  
    Sets the sub account as included or excluded.
- **[global SubAccount setVolume](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccountsSubAccount.htm#unique_912207537)**  
    Sets the sub account volume percent (Decimal between 0 and 100)

### global Boolean isIncluded

Gets the included/excluded status of the sub account.

#### API Version

55

#### Signature

global Boolean isIncluded()

### global Decimal getVolume

Get the volume percent of the sub account.

#### API Version

55

#### Signature

global Decimal getVolume()

### global String getAccountExternalId

Gets the sub account Account External ID.

#### API Version

55

#### Signature

global String getAccountExternalId()

### global SubAccount setAccountExternalId

Sets the sub account account external ID.

#### API Version

55

#### Signature

global SubAccount setAccountExternalId(String value)

### global SubAccount setIncluded

Sets the sub account as included or excluded.

#### API Version

55

#### Signature

global SubAccount setIncluded(Boolean value)

### global SubAccount setVolume

Sets the sub account volume percent (Decimal between 0 and 100)

#### API Version

55

#### Signature

global SubAccount setVolume(Decimal volume)