POST api/recurringTransactions?retroChargesPostDate={retroChargesPostDate}&retroChargesDescription={retroChargesDescription}

Post, Create new recurring Transaction (recurring charge or credit)

Request Information

URI Parameters

Name	Description	Type	Additional information
retroChargesPostDate	[Required if any retro charges are created]Post date of retroactive charges/credit	date	None.
retroChargesDescription	[Required if any retro charges are created]Description of retroactive charges/credit	string	None.

Body Parameters

[Required] Transaction to be created

RecurringTransactionCreateViewModel

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.

Request Formats

application/json, text/json

Sample:

{
  "buildingId": 1,
  "chargeCodeId": 2,
  "unitId": 3,
  "unitType": 4,
  "chargeCodeAdjustedCodeId": 5,
  "overrideDueDay": 6,
  "startDate": "2024-10-14T04:22:12.497561-04:00",
  "endDate": "2024-10-14T04:22:12.497561-04:00",
  "rate": 7.0,
  "amount": 8.0,
  "type": 0,
  "applyToId": 1,
  "createdBy": 9,
  "isLinkedCredit": true,
  "linkedCreditGroupId": 10,
  "id": 11,
  "retroGLPostDate": "2024-10-14T04:22:12.497561-04:00"
}

application/xml, text/xml

Sample:

<RecurringTransactionCreateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <Amount>8</Amount>
  <ApplyToId>All</ApplyToId>
  <BuildingId>1</BuildingId>
  <ChargeCodeAdjustedCodeId>5</ChargeCodeAdjustedCodeId>
  <ChargeCodeId>2</ChargeCodeId>
  <CreatedBy>9</CreatedBy>
  <EndDate>2024-10-14T04:22:12.497561-04:00</EndDate>
  <Id>11</Id>
  <IsLinkedCredit>true</IsLinkedCredit>
  <LinkedCreditGroupId>10</LinkedCreditGroupId>
  <OverrideDueDay>6</OverrideDueDay>
  <Rate>7</Rate>
  <RetroGLPostDate>2024-10-14T04:22:12.497561-04:00</RetroGLPostDate>
  <StartDate>2024-10-14T04:22:12.497561-04:00</StartDate>
  <Type>Charge</Type>
  <UnitId>3</UnitId>
  <UnitType>4</UnitType>
</RecurringTransactionCreateViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RecurringTransactionCreateViewModel'.

Response Information

Resource Description

Collection of RecurringTransactionViewModel

Name	Description	Type	Additional information
Id	Id of the Recurring Charge/Credit, it will default to 0 for new Transaction.	integer	None.
BuildingId	Building Id	integer	None.
ChargeCodeId	Charge Code Id	integer	None.
UnitId	Unit Id. It will default to 0 for ApplyTo is All\UnitType	integer	None.
UnitType	Unit Type Id. It will default to 0 for ApplyTo is All\Shares\Unit	integer	None.
ChargeCodeAdjustedCodeId	Adjusted Code Id	integer	None.
OverrideDueDay	Override Due Day. Valid values are betwee 1 and 31.	integer	None.
StartDate	Date the Recurring Transaction begins.	date	None.
EndDate	Date the Recurring Transaction ends.	date	None.
Rate	Rate. Use when ApplyTo is Shares. Will be 0.00M when ApplyTo is not Shares	decimal number	None.
Amount	Amount. Use when ApplyTo is not Shares. Will be 0.00M when ApplyTo is Shares.	decimal number	None.
Type	Type of the Recurring Transaction. Possible values are 'Credit' or 'Charge'	RecurringTransactionType	None.
GroupId	Group Id. Used to handle Group Increase action. Will be initially set to the Id of the Recurring Transaction.	integer	None.
Status	Status. Used to handle Group Increase action. Will be initially set to Created.	integer	None.
ApplyToId	Id of Apply To configuration.	integer	None.
CreatedOn	Date the recurring transaction was created. Defaults to system date and time at the time of creation.	date	None.
CreatedBy	Id of User who created the recurring transaction	integer	None.
ModifiedBy	Id of User who last modified the recurring transaction. Initial value is null	integer	None.
ModifiedOn	Date the recurring transaction was last modified. Initial value is null	date	None.
EditDates	Indicates whether dates can be updated for this recurring transaction.	boolean	None.
NumberOfShares	If ApplyTo = Shares this will be populated with the Number Of Shares of the unit.	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "buildingId": 2,
    "chargeCodeId": 3,
    "unitId": 4,
    "unitType": 5,
    "chargeCodeAdjustedCodeId": 6,
    "overrideDueDay": 7,
    "startDate": "2024-10-14T04:22:12.5132317-04:00",
    "endDate": "2024-10-14T04:22:12.5132317-04:00",
    "rate": 10.0,
    "amount": 11.0,
    "type": 0,
    "groupId": 12,
    "status": 13,
    "applyToId": 14,
    "createdOn": "2024-10-14T04:22:12.5132317-04:00",
    "createdBy": 1,
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T04:22:12.5132317-04:00",
    "editDates": true,
    "numberOfShares": 1.0
  },
  {
    "id": 1,
    "buildingId": 2,
    "chargeCodeId": 3,
    "unitId": 4,
    "unitType": 5,
    "chargeCodeAdjustedCodeId": 6,
    "overrideDueDay": 7,
    "startDate": "2024-10-14T04:22:12.5132317-04:00",
    "endDate": "2024-10-14T04:22:12.5132317-04:00",
    "rate": 10.0,
    "amount": 11.0,
    "type": 0,
    "groupId": 12,
    "status": 13,
    "applyToId": 14,
    "createdOn": "2024-10-14T04:22:12.5132317-04:00",
    "createdBy": 1,
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T04:22:12.5132317-04:00",
    "editDates": true,
    "numberOfShares": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfRecurringTransactionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <RecurringTransactionViewModel>
    <Amount>11</Amount>
    <ApplyToId>14</ApplyToId>
    <BuildingId>2</BuildingId>
    <ChargeCodeAdjustedCodeId>6</ChargeCodeAdjustedCodeId>
    <ChargeCodeId>3</ChargeCodeId>
    <CreatedBy>1</CreatedBy>
    <CreatedOn>2024-10-14T04:22:12.5132317-04:00</CreatedOn>
    <EditDates>true</EditDates>
    <EndDate>2024-10-14T04:22:12.5132317-04:00</EndDate>
    <GroupId>12</GroupId>
    <Id>1</Id>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T04:22:12.5132317-04:00</ModifiedOn>
    <NumberOfShares>1</NumberOfShares>
    <OverrideDueDay>7</OverrideDueDay>
    <Rate>10</Rate>
    <StartDate>2024-10-14T04:22:12.5132317-04:00</StartDate>
    <Status>13</Status>
    <Type>Charge</Type>
    <UnitId>4</UnitId>
    <UnitType>5</UnitType>
  </RecurringTransactionViewModel>
  <RecurringTransactionViewModel>
    <Amount>11</Amount>
    <ApplyToId>14</ApplyToId>
    <BuildingId>2</BuildingId>
    <ChargeCodeAdjustedCodeId>6</ChargeCodeAdjustedCodeId>
    <ChargeCodeId>3</ChargeCodeId>
    <CreatedBy>1</CreatedBy>
    <CreatedOn>2024-10-14T04:22:12.5132317-04:00</CreatedOn>
    <EditDates>true</EditDates>
    <EndDate>2024-10-14T04:22:12.5132317-04:00</EndDate>
    <GroupId>12</GroupId>
    <Id>1</Id>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T04:22:12.5132317-04:00</ModifiedOn>
    <NumberOfShares>1</NumberOfShares>
    <OverrideDueDay>7</OverrideDueDay>
    <Rate>10</Rate>
    <StartDate>2024-10-14T04:22:12.5132317-04:00</StartDate>
    <Status>13</Status>
    <Type>Charge</Type>
    <UnitId>4</UnitId>
    <UnitType>5</UnitType>
  </RecurringTransactionViewModel>
</ArrayOfRecurringTransactionViewModel>