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

Return resident detailed recurring transactions

Request Information

URI Parameters

Name	Type	Additional information
residentId	integer	Required
startDate	date	None.
endDate	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of DetailedRecurringTransactionViewModel

Name	Type	Additional information
RecurringTransactionId	integer	None.
ChargeCodeId	integer	None.
BuildingId	integer	None.
UnitId	integer	None.
UnitTypeId	integer	None.
OverrideDueDate	date	None.
Amount	decimal number	None.
StartDate	date	None.
EndDate	date	None.
TransactionType	string	None.
Status	string	None.
AppliesTo	string	None.
ChargeCodeDescription	string	None.
ChargeCode	string	None.
ChargeCodeTypeId	integer	None.
ChargeCodeFeeScheduleId	integer	None.
ChargeCodeFirstMonth	integer	None.
FeeScheduleDescription	string	None.
AdjustedCodeDescription	string	None.
AdjustedCode	string	None.
AdjustedCodeId	integer	None.
UnitTypeDescription	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "recurringTransactionId": 1,
    "chargeCodeId": 2,
    "buildingId": 1,
    "unitId": 1,
    "unitTypeId": 1,
    "overrideDueDate": "2024-10-13T07:29:27.27781-04:00",
    "amount": 3.0,
    "startDate": "2024-10-13T07:29:27.27781-04:00",
    "endDate": "2024-10-13T07:29:27.27781-04:00",
    "transactionType": "sample string 4",
    "status": "sample string 5",
    "appliesTo": "sample string 6",
    "chargeCodeDescription": "sample string 7",
    "chargeCode": "sample string 8",
    "chargeCodeTypeId": 9,
    "chargeCodeFeeScheduleId": 1,
    "chargeCodeFirstMonth": 1,
    "feeScheduleDescription": "sample string 10",
    "adjustedCodeDescription": "sample string 11",
    "adjustedCode": "sample string 12",
    "adjustedCodeId": 1,
    "unitTypeDescription": "sample string 13"
  },
  {
    "recurringTransactionId": 1,
    "chargeCodeId": 2,
    "buildingId": 1,
    "unitId": 1,
    "unitTypeId": 1,
    "overrideDueDate": "2024-10-13T07:29:27.27781-04:00",
    "amount": 3.0,
    "startDate": "2024-10-13T07:29:27.27781-04:00",
    "endDate": "2024-10-13T07:29:27.27781-04:00",
    "transactionType": "sample string 4",
    "status": "sample string 5",
    "appliesTo": "sample string 6",
    "chargeCodeDescription": "sample string 7",
    "chargeCode": "sample string 8",
    "chargeCodeTypeId": 9,
    "chargeCodeFeeScheduleId": 1,
    "chargeCodeFirstMonth": 1,
    "feeScheduleDescription": "sample string 10",
    "adjustedCodeDescription": "sample string 11",
    "adjustedCode": "sample string 12",
    "adjustedCodeId": 1,
    "unitTypeDescription": "sample string 13"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDetailedRecurringTransactionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <DetailedRecurringTransactionViewModel>
    <AdjustedCode>sample string 12</AdjustedCode>
    <AdjustedCodeDescription>sample string 11</AdjustedCodeDescription>
    <AdjustedCodeId>1</AdjustedCodeId>
    <Amount>3</Amount>
    <AppliesTo>sample string 6</AppliesTo>
    <BuildingId>1</BuildingId>
    <ChargeCode>sample string 8</ChargeCode>
    <ChargeCodeDescription>sample string 7</ChargeCodeDescription>
    <ChargeCodeFeeScheduleId>1</ChargeCodeFeeScheduleId>
    <ChargeCodeFirstMonth>1</ChargeCodeFirstMonth>
    <ChargeCodeId>2</ChargeCodeId>
    <ChargeCodeTypeId>9</ChargeCodeTypeId>
    <EndDate>2024-10-13T07:29:27.27781-04:00</EndDate>
    <FeeScheduleDescription>sample string 10</FeeScheduleDescription>
    <OverrideDueDate>2024-10-13T07:29:27.27781-04:00</OverrideDueDate>
    <RecurringTransactionId>1</RecurringTransactionId>
    <StartDate>2024-10-13T07:29:27.27781-04:00</StartDate>
    <Status>sample string 5</Status>
    <TransactionType>sample string 4</TransactionType>
    <UnitId>1</UnitId>
    <UnitTypeDescription>sample string 13</UnitTypeDescription>
    <UnitTypeId>1</UnitTypeId>
  </DetailedRecurringTransactionViewModel>
  <DetailedRecurringTransactionViewModel>
    <AdjustedCode>sample string 12</AdjustedCode>
    <AdjustedCodeDescription>sample string 11</AdjustedCodeDescription>
    <AdjustedCodeId>1</AdjustedCodeId>
    <Amount>3</Amount>
    <AppliesTo>sample string 6</AppliesTo>
    <BuildingId>1</BuildingId>
    <ChargeCode>sample string 8</ChargeCode>
    <ChargeCodeDescription>sample string 7</ChargeCodeDescription>
    <ChargeCodeFeeScheduleId>1</ChargeCodeFeeScheduleId>
    <ChargeCodeFirstMonth>1</ChargeCodeFirstMonth>
    <ChargeCodeId>2</ChargeCodeId>
    <ChargeCodeTypeId>9</ChargeCodeTypeId>
    <EndDate>2024-10-13T07:29:27.27781-04:00</EndDate>
    <FeeScheduleDescription>sample string 10</FeeScheduleDescription>
    <OverrideDueDate>2024-10-13T07:29:27.27781-04:00</OverrideDueDate>
    <RecurringTransactionId>1</RecurringTransactionId>
    <StartDate>2024-10-13T07:29:27.27781-04:00</StartDate>
    <Status>sample string 5</Status>
    <TransactionType>sample string 4</TransactionType>
    <UnitId>1</UnitId>
    <UnitTypeDescription>sample string 13</UnitTypeDescription>
    <UnitTypeId>1</UnitTypeId>
  </DetailedRecurringTransactionViewModel>
</ArrayOfDetailedRecurringTransactionViewModel>