DELETE api/recurringTransactions/group/delete?recurringChargeId={recurringChargeId}&userId={userId}
Deletes a recurring charge from a group. Will update the end date of previous charge with the end date of deleted recurring charge.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| recurringChargeId |
Id of recurring charge to delete |
integer |
Required |
| userId |
User Id |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Deleted recurring charge
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
{
"id": 1,
"buildingId": 2,
"chargeCodeId": 3,
"unitId": 4,
"unitType": 5,
"chargeCodeAdjustedCodeId": 6,
"overrideDueDay": 7,
"startDate": "2025-10-29T04:44:26.6219377-04:00",
"endDate": "2025-10-29T04:44:26.6219377-04:00",
"rate": 10.0,
"amount": 11.0,
"type": 0,
"groupId": 12,
"status": 13,
"applyToId": 14,
"createdOn": "2025-10-29T04:44:26.6219377-04:00",
"createdBy": 1,
"modifiedBy": 1,
"modifiedOn": "2025-10-29T04:44:26.6219377-04:00",
"editDates": true,
"numberOfShares": 1.0
}
application/xml, text/xml
<RecurringTransactionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions"> <Amount>11</Amount> <ApplyToId>14</ApplyToId> <BuildingId>2</BuildingId> <ChargeCodeAdjustedCodeId>6</ChargeCodeAdjustedCodeId> <ChargeCodeId>3</ChargeCodeId> <CreatedBy>1</CreatedBy> <CreatedOn>2025-10-29T04:44:26.6219377-04:00</CreatedOn> <EditDates>true</EditDates> <EndDate>2025-10-29T04:44:26.6219377-04:00</EndDate> <GroupId>12</GroupId> <Id>1</Id> <ModifiedBy>1</ModifiedBy> <ModifiedOn>2025-10-29T04:44:26.6219377-04:00</ModifiedOn> <NumberOfShares>1</NumberOfShares> <OverrideDueDay>7</OverrideDueDay> <Rate>10</Rate> <StartDate>2025-10-29T04:44:26.6219377-04:00</StartDate> <Status>13</Status> <Type>Charge</Type> <UnitId>4</UnitId> <UnitType>5</UnitType> </RecurringTransactionViewModel>