GET api/residents/{residentId}/recurringTransactions?type={type}&startDate={startDate}

Get all recurring charges, past, present, and future, by resident when date is not passed in Pass in date if searching for charges by start date

Request Information

URI Parameters

Name	Description	Type	Additional information
residentId	Required - Resident Id	integer	Required
type	Required - Searching by charge or credit	RecurringTransactionType	Required
startDate	Optional - If not passed, return all recurring charges	date	None.

Body Parameters

None.

Response Information

Resource Description

List RecurringTransactionUpdateViewModel

Collection of RecurringTransactionListItemViewModel

Name	Description	Type	Additional information
Id	Id of the recurring transaction.	integer	None.
AppliesTo	Applies To Option of Recurring Transaction.	string	None.
UnitType	Unit Type Id. It will default to 0 for ApplyTo is All\Shares\Unit.	string	None.
UnitNumber	Number of the unit. Populated only when Recurring Transaction is By Unit or By Shares.	string	None.
ChargeCode	Charge code description for Recurring Transaction.	string	None.
Amount	Amount. Use when ApplyTo is not Shares. Will be 0.00M when ApplyTo is Shares.	decimal number	None.
StartDate	Date the Recurring Transaction begins.	date	None.
EndDate	Date the Recurring Transaction ends.	date	None.
DueEvery	Schedule of recurring transaction. Ex. Monthly	string	None.
TransactionType	Type of the Recurring Transaction. Possible values are 'Credit' or 'Charge'	string	None.
OverrideDueDay	Override Due Day. Valid values are betwee 01 and 31.	string	None.
NumberOfShares	Number of shares for unit. Data will only appear if applicable.	decimal number	None.
CanGroupIncrease	Used to show or hide the Group Increase button.	boolean	None.
ChargeCodeDescription	Full description of the charge code	string	None.
CanBeDeleted	Indicates whether a recurring transaction can be deleted or not	boolean	None.
Status	status of the recurrung transaction ex: Current, Past, base on the EndDate	string	None.
AdjustedCode	Adjusted code - Adjusted description for Recurring Transaction.	string	None.
AnnualAmount	Estimate of annual amount for recurring transaction (amount * frecuency[anual, monthly, semianual, Quarterly] )	decimal number	None.
Action	Usetd to allow or denied actions for recurring charge	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "appliesTo": "sample string 2",
    "unitType": "sample string 3",
    "unitNumber": "sample string 4",
    "chargeCode": "sample string 5",
    "amount": 6.0,
    "startDate": "2025-04-03T18:09:12.0122502-04:00",
    "endDate": "2025-04-03T18:09:12.0122502-04:00",
    "dueEvery": "sample string 9",
    "transactionType": "sample string 10",
    "overrideDueDay": "sample string 11",
    "numberOfShares": 1.0,
    "canGroupIncrease": true,
    "chargeCodeDescription": "sample string 13",
    "canBeDeleted": true,
    "status": "sample string 15",
    "adjustedCode": "sample string 16",
    "annualAmount": 17.0,
    "action": true
  },
  {
    "id": 1,
    "appliesTo": "sample string 2",
    "unitType": "sample string 3",
    "unitNumber": "sample string 4",
    "chargeCode": "sample string 5",
    "amount": 6.0,
    "startDate": "2025-04-03T18:09:12.0122502-04:00",
    "endDate": "2025-04-03T18:09:12.0122502-04:00",
    "dueEvery": "sample string 9",
    "transactionType": "sample string 10",
    "overrideDueDay": "sample string 11",
    "numberOfShares": 1.0,
    "canGroupIncrease": true,
    "chargeCodeDescription": "sample string 13",
    "canBeDeleted": true,
    "status": "sample string 15",
    "adjustedCode": "sample string 16",
    "annualAmount": 17.0,
    "action": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfRecurringTransactionListItemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <RecurringTransactionListItemViewModel>
    <Action>true</Action>
    <AdjustedCode>sample string 16</AdjustedCode>
    <Amount>6</Amount>
    <AnnualAmount>17</AnnualAmount>
    <AppliesTo>sample string 2</AppliesTo>
    <CanBeDeleted>true</CanBeDeleted>
    <CanGroupIncrease>true</CanGroupIncrease>
    <ChargeCode>sample string 5</ChargeCode>
    <ChargeCodeDescription>sample string 13</ChargeCodeDescription>
    <DueEvery>sample string 9</DueEvery>
    <EndDate>2025-04-03T18:09:12.0122502-04:00</EndDate>
    <Id>1</Id>
    <NumberOfShares>1</NumberOfShares>
    <OverrideDueDay>sample string 11</OverrideDueDay>
    <StartDate>2025-04-03T18:09:12.0122502-04:00</StartDate>
    <Status>sample string 15</Status>
    <TransactionType>sample string 10</TransactionType>
    <UnitNumber>sample string 4</UnitNumber>
    <UnitType>sample string 3</UnitType>
  </RecurringTransactionListItemViewModel>
  <RecurringTransactionListItemViewModel>
    <Action>true</Action>
    <AdjustedCode>sample string 16</AdjustedCode>
    <Amount>6</Amount>
    <AnnualAmount>17</AnnualAmount>
    <AppliesTo>sample string 2</AppliesTo>
    <CanBeDeleted>true</CanBeDeleted>
    <CanGroupIncrease>true</CanGroupIncrease>
    <ChargeCode>sample string 5</ChargeCode>
    <ChargeCodeDescription>sample string 13</ChargeCodeDescription>
    <DueEvery>sample string 9</DueEvery>
    <EndDate>2025-04-03T18:09:12.0122502-04:00</EndDate>
    <Id>1</Id>
    <NumberOfShares>1</NumberOfShares>
    <OverrideDueDay>sample string 11</OverrideDueDay>
    <StartDate>2025-04-03T18:09:12.0122502-04:00</StartDate>
    <Status>sample string 15</Status>
    <TransactionType>sample string 10</TransactionType>
    <UnitNumber>sample string 4</UnitNumber>
    <UnitType>sample string 3</UnitType>
  </RecurringTransactionListItemViewModel>
</ArrayOfRecurringTransactionListItemViewModel>