GET api/recurringTransactions/preview/insert?BuildingId={BuildingId}&ChargeCodeId={ChargeCodeId}&UnitId={UnitId}&UnitType={UnitType}&ChargeCodeAdjustedCodeId={ChargeCodeAdjustedCodeId}&OverrideDueDay={OverrideDueDay}&StartDate={StartDate}&EndDate={EndDate}&Rate={Rate}&Amount={Amount}&Type={Type}&ApplyToId={ApplyToId}&CreatedBy={CreatedBy}&IsLinkedCredit={IsLinkedCredit}&LinkedCreditGroupId={LinkedCreditGroupId}&Id={Id}&RetroGLPostDate={RetroGLPostDate}

Preview before the user can submit to create recurring charge Goes through the same process as insert except nothing is created in the db yet

Request Information

URI Parameters

Name	Description	Type	Additional information
BuildingId	[Required] Building Id	integer	Range: inclusive between 1 and 2147483647
ChargeCodeId	[Required] Charge Code Id	integer	Range: inclusive between 1 and 2147483647
UnitId	[Required when AppliesTo = Unit] It will default to 0 for ApplyTo is All\UnitType	integer	None.
UnitType	[Required when AppliesTo = UnitType] It will default to 0 for ApplyTo is All\Shares\Unit	integer	None.
ChargeCodeAdjustedCodeId	[Required when Type = Credit] Adjusted Code Id	integer	None.
OverrideDueDay	[Required] Day of the month the charge/credit is going to be posted. Valid values are betwee 1 and 31.	integer	Range: inclusive between 1 and 31
StartDate	[Required] Date the Recurring Transaction begins.	date	Required
EndDate	[Required] Date the Recurring Transaction ends.	date	Required
Rate	[Required when ApplyTo = Shares] Will default to 0.00M when ApplyTo is not Shares	decimal number	None.
Amount	[Required when ApplyTo is not Shares]. Will default to 0.00M when ApplyTo = Shares.	decimal number	None.
Type	[Required] Type of the Recurring Transaction. Possible values for charge: 'Charge' or 0. Possible values for credit: 'Credit' or 1. If Type isn't passed in then it is defaulted to Charge	RecurringTransactionType	None.
ApplyToId	[Required] Id of Apply To configuration.	RecurringTransactionAppliesTo	None.
CreatedBy	[Required] Id of User who created the recurring transaction	integer	Range: inclusive between 1 and 2147483647
IsLinkedCredit	Indicates if the new recurring credit is associated with a recurring charge.	boolean	None.
LinkedCreditGroupId	Id of recurring charge that is going to be associated with new recurring credit. Provide if IsLinkedCredit is set to True.	integer	None.
Id	Id of Linked Credit	integer	None.
RetroGLPostDate	Retro GL Post Date	date	None.

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-05-29T02:42:28.4344057-04:00",
          "endDate": "2025-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-04:00",
          "endDate": "2025-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-04:00",
          "endDate": "2025-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-04:00",
          "endDate": "2025-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-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-05-29T02:42:28.4344057-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>