---
updatedAt: 2025-06-19T12:43:50.000Z
agentTools:
  projectIndex: https://developers.directscale.com/llms.txt
---

# Volume Accumulators

# `<VA_Personal>`

It looks at an Associate's personal orders and sums the volume. Within the element, you call a [Volume Type](https://developers.directscale.com/docs/volumetype).

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `AssociateBaseTypes`
      </td>

      <td>
        Restrict to an Associate Type.

        [Base Associatey Types](https://help.directscale.com/hc/en-us/articles/360047422313-Base-Associate-Types-Associate-Types-and-Price-Groups-Explained):

        1 = Distributor\
        2 = Retail Associate\
        3 = Preferred Customer
      </td>
    </tr>

    <tr>
      <td>
        `VolumeRange`
      </td>

      <td>
        Declare a [Volume Range](https://developers.directscale.com/docs/defining-volume-ranges) to gather volume.
      </td>
    </tr>

    <tr>
      <td>
        `Min`
      </td>

      <td>
        The minimum volume amount the Associate needs.
      </td>
    </tr>

    <tr>
      <td>
        `Max`
      </td>

      <td>
        The maximum volume amount an Associate can have.
      </td>
    </tr>

    <tr>
      <td>
        `SplitMethod`
      </td>

      <td>
        Use when splitting orders for the `Min` and `Max` requirements.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_Personal AssociateBaseTypes="1" Name="DistributorPV">
   <VolumeType>
       <DefVolType VolumeGroup="QV" />
   </VolumeType>
</VA_Personal>
```

***

***

# `<IncomeCenterSplit>`

If you have income centers (people in the Tree more than once), `<IncomeCenterSplit>` sums the income centers' volume together.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `Volume`
      </td>

      <td>
        Reference a [volume](https://developers.directscale.com/docs/defining-volumes) name.
      </td>
    </tr>

    <tr>
      <td>
        `PrimaryMin`
      </td>

      <td>
        The amount of volume to keep on the primary income center before splitting begins.
      </td>
    </tr>

    <tr>
      <td>
        `SecondaryMin`
      </td>

      <td>
        The amount of volume to put in each income center before volume goes to the next income center.
      </td>
    </tr>

    <tr>
      <td>
        `SecondaryMax`
      </td>

      <td>
        The maximum volume that any additional income center, not counting the primary, can have. Any remaining volume is assigned to the primary income center.
      </td>
    </tr>

    <tr>
      <td>
        `IncomeCenterSortOrder`
      </td>

      <td>
        The order of income centers to sort volume among, based upon signup date.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<IncomeCenterSplit Name="ICPS" Volume="PS" PrimaryMin="" SecondaryMin="" SecondaryMax="" IncomeCenterSortOrder="" />
```

***

***

# `<RegionOrderVolume>`

If `InRegions` is `true`, and the Associate places an order in the defined `RegionIds`, then the volume will have a value. If an Associate has zero orders in `RegionIds`, they will have zero volume, no matter how many orders they have. `<RegionOrderVolume>` is helpful if you need to build different compensation plans for different countries.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `Volume`
      </td>

      <td>
        Reference a [volume](https://developers.directscale.com/docs/defining-volumes) name.
      </td>
    </tr>

    <tr>
      <td>
        `RegionIds`
      </td>

      <td>
        The regions to include. 

        You can find the region's ID:

        * The URL of the Administration > Regions > \{region} page `/Corporate/Admin/RegionDetail?rID=7`
        * The **dbo.Regions** table **recordnumber** value for the region.
      </td>
    </tr>

    <tr>
      <td>
        `InRegions`
      </td>

      <td>
        True or false. 

        * If `true`, the value must be in the `RegionIds`. 
        * If `false`, the value must *not* be in the `RegionIds`.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<RegionOrderVolume Name="RegionPS" Volume="PS" RegionIds="7" InRegions="true" />
```

***

***

# `<Retail>`

\<Retail> returns all the volume for a Distributor Associate's customers with a Base Associate Type=2 (Retail Associate). It only looks at a Distributor's customers. If a customer enrolls another customer, then the Distributor would earn volume, the customers would not.

Within the element, you call a [Volume Type](https://developers.directscale.com/docs/volumetype).

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `VolumeRange`
      </td>

      <td>
        Declare a [Volume Range](https://developers.directscale.com/docs/defining-volume-ranges) to gather volume.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<Retail Name="DistRetail" VolumeRange="Monthly">
  <VolumeType>
    <DefVolType VolumeGroup="QV" />
  </VolumeType>
</Retail>
```

***

***

# `<VA_AccumulatorAND>`

`<VA_AccumulatorAND>` combines two or more Volume Accumulators.

> ❗Warning
>
> Use of this element could double volume if you add two of the same Volume Acculuators.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `Accumulators`
      </td>

      <td>
        A comma-separated list of Accumulators to combine together.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_AccumulatorAND Name="VAAND" Accumulators="PS,PS4M,PS1M" />
```

***

***

# `<VA_CodingMatrix>`

Accumulates `Volume` from each `CodingRank` while only counting an Associate once.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `Volume`
      </td>

      <td>
        Reference a [volume](https://developers.directscale.com/docs/defining-volumes) name.
      </td>
    </tr>

    <tr>
      <td>
        `CodingRanks`
      </td>

      <td>
        A comma-separated list of Rank IDs for each Coding Tree from which to accumulate volume.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_CodingMatrix Name="" CodingRanks="" Volume="" />
```

***

***

# `<VA_EnrolledInWindow>`

Compare all the Associates' signup dates that contributed to `Volume` to the primary Associate's signup date. If the signup date is within `Days`, the volume accumulates.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `Volume`
      </td>

      <td>
        Reference a [volume](https://developers.directscale.com/docs/defining-volumes) name.
      </td>
    </tr>

    <tr>
      <td>
        `Days`
      </td>

      <td>
        The number of days to compare enrollment dates to.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_EnrolledInWindow Name="" Volume="QualifiedVolume" Days="7" />
```

***

***

# `<VA_Except>`

Compares `First` volume with a `Second` volume and removes duplicate contributing Associates.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `First`
      </td>

      <td>
        Reference a [volume](https://developers.directscale.com/docs/defining-volumes) name to be compared.
      </td>
    </tr>

    <tr>
      <td>
        `Second`
      </td>

      <td>
        The volume to remove from `First`.
      </td>
    </tr>

    <tr>
      <td>
        `Symmetric`
      </td>

      <td>
        True or false. 

        If true, the result will contain results from `First` and `Second` that are not in each list.
      </td>
    </tr>

    <tr>
      <td>
        `OrderNumberSplit`
      </td>

      <td>
        True or false. 

        * If true, `<VA_Except>` looks at `OrderNumber` only, `Volume` will be adjusted if not equal. 

           For example, suppose you have the `first` and `second` volumes defined. If an `OrderNumber`  has 100 volume in the `first` and 50 volume in the `second`, then `<VA_Except>` will have 50 volume.

        * If false, then `<VA_Except>` looks for a perfect match. If `OrderNumber`, Associate, volume amount, etc., is the same, then it removes the duplicates.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_Except Name="vaexcept" First="QV" Second="pcv" Symmetric="false" />
```

***

***

# `<VA_FirstOrderVolume>`

Get the volume for the first order in the current period. Within the element, you call a [Volume Type](https://developers.directscale.com/docs/volumetype).

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `Rule`
      </td>

      <td>
        Reference a [Rule](https://developers.directscale.com/docs/creating-rules) name.
      </td>
    </tr>

    <tr>
      <td>
        `MinVolume`
      </td>

      <td>
        Pass in a minimum volume amount for the order to count.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_FirstOrderVolume Name="" Rule="" MinVolume="">
  <VolumeType>
    <DefVolType VolumeGroup="QV" />
  </VolumeType>
</VA_FirstOrderVolume>
```

***

***

# `<VA_Intersect>`

Pass in two Volume Accumulators (`First` and `Second`) and it returns only the orders that happened in both.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `First`
      </td>

      <td>
        The first Volume Accumulator that intersects with the `Second`.
      </td>
    </tr>

    <tr>
      <td>
        `Second`
      </td>

      <td>
        The second Volume Accumulator that intersects with the `First`.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_Intersect Name="VAIntersect" First="QS" Second="RRCV" />
```

***

***

# `<VA_Personal_Retail>`

Sums personal and personally enrolled Associates of `AssociateBaseTypes`. Within the element, you call a [Volume Type](https://developers.directscale.com/docs/volumetype).

> ⚠Caution
>
> Be careful when using this element. You're doubling volume and if used in the wrong place, the client will pay way more than they should have.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `AssociateBaseTypes`
      </td>

      <td>
        Restrict to an Associate Type.

        [Base Associate Types](https://help.directscale.com/hc/en-us/articles/360047422313-Base-Associate-Types-Associate-Types-and-Price-Groups-Explained):

        1 = Distributor\
        2 = Retail Associate\
        3 = Preferred Customer
      </td>
    </tr>

    <tr>
      <td>
        `Max`
      </td>

      <td>
        The maximum amount to roll up from `AssociateBaseType`.
      </td>
    </tr>

    <tr>
      <td>
        `ExchangeRate`
      </td>

      <td>
        Enter a percentage of the volume an Associate gets from `AssociateBaseType`.
      </td>
    </tr>

    <tr>
      <td>
        `SplitMethod`
      </td>

      <td>
        The split method for splitting the orders up. 

        * `AverageAllOrders`
        * `SplitOrder`
        * `FullOrderDown`
        * `FullOrderUp`
      </td>
    </tr>

    <tr>
      <td>
        `VolumeRange`
      </td>

      <td>
        Declare a [Volume Range](https://developers.directscale.com/docs/defining-volume-ranges) to gather volume.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_Personal_Retail Name="VAPR" AssociateBaseTypes="2" ExchangeRate="50" SplitMethod="SplitOrder" VolumeRange="Weekly">
  <VolumeType>
    <DefVolType VolumeGroup="QV" />
  </VolumeType>
</VA_Personal_Retail>
```

***

***

# `<VA_RetailRollup>`

`<VA_RetailRollup>` does almost the same things as `<VA_Personal_Retail>` except the customer doesn't get volume. Within the element, you call a [Volume Type](https://developers.directscale.com/docs/volumetype).

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `Rule`
      </td>

      <td>
        Reference a [Rule](https://developers.directscale.com/docs/creating-rules) name.
      </td>
    </tr>

    <tr>
      <td>
        `AmountToSubtract`
      </td>

      <td>

      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_RetailRollup Name="PS3M" VolumeRange="ThreeMonthly" >
    <VolumeType>
        <DefVolType VolumeGroup="QV" />
    </VolumeType>
</VA_RetailRollup>
```

***

***

# `<VA_SplitVolume>`

Creates a volume bucket with a sub amount of another `Volume`. This can be used to split volume into multiple groups.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Name`
      </td>

      <td>
        Give the Accumulator a name to reference later.
      </td>
    </tr>

    <tr>
      <td>
        `Volume`
      </td>

      <td>
        Reference a [volume](https://developers.directscale.com/docs/defining-volumes) name to split.
      </td>
    </tr>

    <tr>
      <td>
        `Min`
      </td>

      <td>
        The begin amount to start to split
      </td>
    </tr>

    <tr>
      <td>
        `Max`
      </td>

      <td>
        The end amount to end the split.
      </td>
    </tr>

    <tr>
      <td>
        `SplitMethod`
      </td>

      <td>
        The split method for splitting the orders up. 

        * `AverageAllOrders`
        * `SplitOrder`
        * `FullOrderDown`
        * `FullOrderUp`
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_SplitVolume Name="" Volume="" Min="" Max="" SplitMethod="" />
```

***

***

# `<VA_Union>`

Adds two Volume Accumulators together. Includes both the contributing orders from `First` and `Second`.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `First`
      </td>

      <td>
        The first [volume](https://developers.directscale.com/docs/defining-volumes) to include.
      </td>
    </tr>

    <tr>
      <td>
        `Second`
      </td>

      <td>
        The second [volume](https://developers.directscale.com/docs/defining-volumes) to include.
      </td>
    </tr>
  </tbody>
</Table>

**Example**

```xml
<VA_Union Name="" First="" Second="" />
```