GET api/entities/{entityId}/recurringTransactionsWidgets?year={year}&month={month}

Return a collection for recurring transactions widgets for entity and building

Request Information

URI Parameters

Name	Type	Additional information
entityId	integer	Required
year	integer	Required
month	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of RecurringTransactionWidgetListItemViewModel

Name	Description	Type	Additional information
ChargeCode	Charge Code	string	None.
Frequency	Frequency	string	None.
PeriodChargeCount	Charge Count	integer	None.
PeriodTotalAmount	Total Amount for Period	decimal number	None.
AnualChargeCount	Charge Count Anual	integer	None.
AnualTotalAmount	Total Amount for Anual	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "chargeCode": "sample string 1",
    "frequency": "sample string 2",
    "periodChargeCount": 3,
    "periodTotalAmount": 4.1,
    "anualChargeCount": 5,
    "anualTotalAmount": 6.1
  },
  {
    "chargeCode": "sample string 1",
    "frequency": "sample string 2",
    "periodChargeCount": 3,
    "periodTotalAmount": 4.1,
    "anualChargeCount": 5,
    "anualTotalAmount": 6.1
  }
]

application/xml, text/xml

Sample:

<ArrayOfRecurringTransactionWidgetListItemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <RecurringTransactionWidgetListItemViewModel>
    <AnualChargeCount>5</AnualChargeCount>
    <AnualTotalAmount>6.1</AnualTotalAmount>
    <ChargeCode>sample string 1</ChargeCode>
    <Frequency>sample string 2</Frequency>
    <PeriodChargeCount>3</PeriodChargeCount>
    <PeriodTotalAmount>4.1</PeriodTotalAmount>
  </RecurringTransactionWidgetListItemViewModel>
  <RecurringTransactionWidgetListItemViewModel>
    <AnualChargeCount>5</AnualChargeCount>
    <AnualTotalAmount>6.1</AnualTotalAmount>
    <ChargeCode>sample string 1</ChargeCode>
    <Frequency>sample string 2</Frequency>
    <PeriodChargeCount>3</PeriodChargeCount>
    <PeriodTotalAmount>4.1</PeriodTotalAmount>
  </RecurringTransactionWidgetListItemViewModel>
</ArrayOfRecurringTransactionWidgetListItemViewModel>