GET api/recurringTransactions/preview/group/increase?groupId={groupId}&amount={amount}&effectiveDate={effectiveDate}&userId={userId}

Get Preview for Group Increase

Request Information

URI Parameters

Name	Description	Type	Additional information
groupId	[Required] Group id	integer	Required
amount	[Required] Amount	decimal number	Required
effectiveDate	[Required] Effective date	date	Required
userId	[Required] User id	integer	Required

Body Parameters

None.

Response Information

Resource Description

RecurringTransactionPreviewViewModel

Name	Description	Type	Additional information
EntityId	Entity Id	integer	None.
EntityName	Entity Name	string	None.
EntityChargeCodeTotal	Entity Charge Code Total currently only applies to Global Adjustment.	decimal number	None.
EntityRetroChargeTotal	Entity Retro Total currently only applies to Global Adjustment.	decimal number	None.
Buildings	Building(s) along with Recurring Transaction Line Items	Collection of BuildingRecurringTransactionViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "entityId": 1,
  "entityName": "sample string 2",
  "entityChargeCodeTotal": 1.0,
  "entityRetroChargeTotal": 1.0,
  "buildings": [
    {
      "buildingId": 1,
      "readableBuildingId": "sample string 2",
      "buildingName": "sample string 3",
      "buildingRetroChargeTotal": 4.0,
      "buildingChargeCodeTotal": 5.0,
      "areRecurringChargesRounded": true,
      "recurringTransactions": [
        {
          "id": 1,
          "buildingId": 2,
          "chargeCodeDescription": "sample string 3",
          "unitId": 4,
          "unitNumber": "sample string 5",
          "unitType": "sample string 6",
          "unitTypeId": 7,
          "overrideDueDay": "sample string 8",
          "startDate": "2025-10-29T04:44:44.0123041-04:00",
          "endDate": "2025-10-29T04:44:44.0123041-04:00",
          "rate": 1.0,
          "numberOfShares": 1.0,
          "newAmount": 11.0,
          "oldAmount": 1.0,
          "chargeType": "sample string 12",
          "applyTo": "sample string 13",
          "feeSchedule": "sample string 14",
          "retroChargeAmount": 1.0
        },
        {
          "id": 1,
          "buildingId": 2,
          "chargeCodeDescription": "sample string 3",
          "unitId": 4,
          "unitNumber": "sample string 5",
          "unitType": "sample string 6",
          "unitTypeId": 7,
          "overrideDueDay": "sample string 8",
          "startDate": "2025-10-29T04:44:44.0123041-04:00",
          "endDate": "2025-10-29T04:44:44.0123041-04:00",
          "rate": 1.0,
          "numberOfShares": 1.0,
          "newAmount": 11.0,
          "oldAmount": 1.0,
          "chargeType": "sample string 12",
          "applyTo": "sample string 13",
          "feeSchedule": "sample string 14",
          "retroChargeAmount": 1.0
        }
      ]
    },
    {
      "buildingId": 1,
      "readableBuildingId": "sample string 2",
      "buildingName": "sample string 3",
      "buildingRetroChargeTotal": 4.0,
      "buildingChargeCodeTotal": 5.0,
      "areRecurringChargesRounded": true,
      "recurringTransactions": [
        {
          "id": 1,
          "buildingId": 2,
          "chargeCodeDescription": "sample string 3",
          "unitId": 4,
          "unitNumber": "sample string 5",
          "unitType": "sample string 6",
          "unitTypeId": 7,
          "overrideDueDay": "sample string 8",
          "startDate": "2025-10-29T04:44:44.0123041-04:00",
          "endDate": "2025-10-29T04:44:44.0123041-04:00",
          "rate": 1.0,
          "numberOfShares": 1.0,
          "newAmount": 11.0,
          "oldAmount": 1.0,
          "chargeType": "sample string 12",
          "applyTo": "sample string 13",
          "feeSchedule": "sample string 14",
          "retroChargeAmount": 1.0
        },
        {
          "id": 1,
          "buildingId": 2,
          "chargeCodeDescription": "sample string 3",
          "unitId": 4,
          "unitNumber": "sample string 5",
          "unitType": "sample string 6",
          "unitTypeId": 7,
          "overrideDueDay": "sample string 8",
          "startDate": "2025-10-29T04:44:44.0123041-04:00",
          "endDate": "2025-10-29T04:44:44.0123041-04:00",
          "rate": 1.0,
          "numberOfShares": 1.0,
          "newAmount": 11.0,
          "oldAmount": 1.0,
          "chargeType": "sample string 12",
          "applyTo": "sample string 13",
          "feeSchedule": "sample string 14",
          "retroChargeAmount": 1.0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<RecurringTransactionPreviewViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <Buildings>
    <BuildingRecurringTransactionViewModel>
      <AreRecurringChargesRounded>true</AreRecurringChargesRounded>
      <BuildingChargeCodeTotal>5</BuildingChargeCodeTotal>
      <BuildingId>1</BuildingId>
      <BuildingName>sample string 3</BuildingName>
      <BuildingRetroChargeTotal>4</BuildingRetroChargeTotal>
      <ReadableBuildingId>sample string 2</ReadableBuildingId>
      <RecurringTransactions>
        <RecurringTransactionPreviewLineItemViewModel>
          <ApplyTo>sample string 13</ApplyTo>
          <BuildingId>2</BuildingId>
          <ChargeCodeDescription>sample string 3</ChargeCodeDescription>
          <ChargeType>sample string 12</ChargeType>
          <EndDate>2025-10-29T04:44:44.0123041-04:00</EndDate>
          <FeeSchedule>sample string 14</FeeSchedule>
          <Id>1</Id>
          <NewAmount>11</NewAmount>
          <NumberOfShares>1</NumberOfShares>
          <OldAmount>1</OldAmount>
          <OverrideDueDay>sample string 8</OverrideDueDay>
          <Rate>1</Rate>
          <RetroChargeAmount>1</RetroChargeAmount>
          <StartDate>2025-10-29T04:44:44.0123041-04:00</StartDate>
          <UnitId>4</UnitId>
          <UnitNumber>sample string 5</UnitNumber>
          <UnitType>sample string 6</UnitType>
          <UnitTypeId>7</UnitTypeId>
        </RecurringTransactionPreviewLineItemViewModel>
        <RecurringTransactionPreviewLineItemViewModel>
          <ApplyTo>sample string 13</ApplyTo>
          <BuildingId>2</BuildingId>
          <ChargeCodeDescription>sample string 3</ChargeCodeDescription>
          <ChargeType>sample string 12</ChargeType>
          <EndDate>2025-10-29T04:44:44.0123041-04:00</EndDate>
          <FeeSchedule>sample string 14</FeeSchedule>
          <Id>1</Id>
          <NewAmount>11</NewAmount>
          <NumberOfShares>1</NumberOfShares>
          <OldAmount>1</OldAmount>
          <OverrideDueDay>sample string 8</OverrideDueDay>
          <Rate>1</Rate>
          <RetroChargeAmount>1</RetroChargeAmount>
          <StartDate>2025-10-29T04:44:44.0123041-04:00</StartDate>
          <UnitId>4</UnitId>
          <UnitNumber>sample string 5</UnitNumber>
          <UnitType>sample string 6</UnitType>
          <UnitTypeId>7</UnitTypeId>
        </RecurringTransactionPreviewLineItemViewModel>
      </RecurringTransactions>
    </BuildingRecurringTransactionViewModel>
    <BuildingRecurringTransactionViewModel>
      <AreRecurringChargesRounded>true</AreRecurringChargesRounded>
      <BuildingChargeCodeTotal>5</BuildingChargeCodeTotal>
      <BuildingId>1</BuildingId>
      <BuildingName>sample string 3</BuildingName>
      <BuildingRetroChargeTotal>4</BuildingRetroChargeTotal>
      <ReadableBuildingId>sample string 2</ReadableBuildingId>
      <RecurringTransactions>
        <RecurringTransactionPreviewLineItemViewModel>
          <ApplyTo>sample string 13</ApplyTo>
          <BuildingId>2</BuildingId>
          <ChargeCodeDescription>sample string 3</ChargeCodeDescription>
          <ChargeType>sample string 12</ChargeType>
          <EndDate>2025-10-29T04:44:44.0123041-04:00</EndDate>
          <FeeSchedule>sample string 14</FeeSchedule>
          <Id>1</Id>
          <NewAmount>11</NewAmount>
          <NumberOfShares>1</NumberOfShares>
          <OldAmount>1</OldAmount>
          <OverrideDueDay>sample string 8</OverrideDueDay>
          <Rate>1</Rate>
          <RetroChargeAmount>1</RetroChargeAmount>
          <StartDate>2025-10-29T04:44:44.0123041-04:00</StartDate>
          <UnitId>4</UnitId>
          <UnitNumber>sample string 5</UnitNumber>
          <UnitType>sample string 6</UnitType>
          <UnitTypeId>7</UnitTypeId>
        </RecurringTransactionPreviewLineItemViewModel>
        <RecurringTransactionPreviewLineItemViewModel>
          <ApplyTo>sample string 13</ApplyTo>
          <BuildingId>2</BuildingId>
          <ChargeCodeDescription>sample string 3</ChargeCodeDescription>
          <ChargeType>sample string 12</ChargeType>
          <EndDate>2025-10-29T04:44:44.0123041-04:00</EndDate>
          <FeeSchedule>sample string 14</FeeSchedule>
          <Id>1</Id>
          <NewAmount>11</NewAmount>
          <NumberOfShares>1</NumberOfShares>
          <OldAmount>1</OldAmount>
          <OverrideDueDay>sample string 8</OverrideDueDay>
          <Rate>1</Rate>
          <RetroChargeAmount>1</RetroChargeAmount>
          <StartDate>2025-10-29T04:44:44.0123041-04:00</StartDate>
          <UnitId>4</UnitId>
          <UnitNumber>sample string 5</UnitNumber>
          <UnitType>sample string 6</UnitType>
          <UnitTypeId>7</UnitTypeId>
        </RecurringTransactionPreviewLineItemViewModel>
      </RecurringTransactions>
    </BuildingRecurringTransactionViewModel>
  </Buildings>
  <EntityChargeCodeTotal>1</EntityChargeCodeTotal>
  <EntityId>1</EntityId>
  <EntityName>sample string 2</EntityName>
  <EntityRetroChargeTotal>1</EntityRetroChargeTotal>
</RecurringTransactionPreviewViewModel>