GET api/entities/{entityId}/recurringTransactions/chargeCodes/{chargeCodeId}/groupbydates

List of recurring transactions group by Charge Code, StartDate and EndDate

Request Information

URI Parameters

Name	Description	Type	Additional information
entityId	Entity Id	integer	Required
chargeCodeId	Charge Code Id	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of RecurringTransactionGroupbyDatesViewModel

Name	Type	Additional information
StartDate	date	None.
EndDate	date	None.
ChargeType	string	None.
ChargeCode	ChargeCodeViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "startDate": "2024-10-14T04:19:35.0310678-04:00",
    "endDate": "2024-10-14T04:19:35.0310678-04:00",
    "chargeType": "sample string 1",
    "chargeCode": {
      "id": 1,
      "displayCode": "sample string 2",
      "chargeCodeDescription": "sample string 3",
      "vacancyLoss": 4,
      "firstMonth": 1,
      "prepaymentApplicable": 5,
      "applyinMonthlyCharges": 6,
      "feeScheduleId": 1,
      "isAutoAssigned": true
    }
  },
  {
    "startDate": "2024-10-14T04:19:35.0310678-04:00",
    "endDate": "2024-10-14T04:19:35.0310678-04:00",
    "chargeType": "sample string 1",
    "chargeCode": {
      "id": 1,
      "displayCode": "sample string 2",
      "chargeCodeDescription": "sample string 3",
      "vacancyLoss": 4,
      "firstMonth": 1,
      "prepaymentApplicable": 5,
      "applyinMonthlyCharges": 6,
      "feeScheduleId": 1,
      "isAutoAssigned": true
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfRecurringTransactionGroupbyDatesViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <RecurringTransactionGroupbyDatesViewModel>
    <ChargeCode xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
      <d3p1:ApplyinMonthlyCharges>6</d3p1:ApplyinMonthlyCharges>
      <d3p1:ChargeCodeDescription>sample string 3</d3p1:ChargeCodeDescription>
      <d3p1:DisplayCode>sample string 2</d3p1:DisplayCode>
      <d3p1:FeeScheduleId>1</d3p1:FeeScheduleId>
      <d3p1:FirstMonth>1</d3p1:FirstMonth>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:IsAutoAssigned>true</d3p1:IsAutoAssigned>
      <d3p1:PrepaymentApplicable>5</d3p1:PrepaymentApplicable>
      <d3p1:VacancyLoss>4</d3p1:VacancyLoss>
    </ChargeCode>
    <ChargeType>sample string 1</ChargeType>
    <EndDate>2024-10-14T04:19:35.0310678-04:00</EndDate>
    <StartDate>2024-10-14T04:19:35.0310678-04:00</StartDate>
  </RecurringTransactionGroupbyDatesViewModel>
  <RecurringTransactionGroupbyDatesViewModel>
    <ChargeCode xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
      <d3p1:ApplyinMonthlyCharges>6</d3p1:ApplyinMonthlyCharges>
      <d3p1:ChargeCodeDescription>sample string 3</d3p1:ChargeCodeDescription>
      <d3p1:DisplayCode>sample string 2</d3p1:DisplayCode>
      <d3p1:FeeScheduleId>1</d3p1:FeeScheduleId>
      <d3p1:FirstMonth>1</d3p1:FirstMonth>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:IsAutoAssigned>true</d3p1:IsAutoAssigned>
      <d3p1:PrepaymentApplicable>5</d3p1:PrepaymentApplicable>
      <d3p1:VacancyLoss>4</d3p1:VacancyLoss>
    </ChargeCode>
    <ChargeType>sample string 1</ChargeType>
    <EndDate>2024-10-14T04:19:35.0310678-04:00</EndDate>
    <StartDate>2024-10-14T04:19:35.0310678-04:00</StartDate>
  </RecurringTransactionGroupbyDatesViewModel>
</ArrayOfRecurringTransactionGroupbyDatesViewModel>