GET api/residents/{residentId}/recurringTransactions/all?orderBy={orderBy}&orderDesc={orderDesc}&pageSize={pageSize}&pageNum={pageNum}

Get recurring charges for the resident selected

Request Information

URI Parameters

Name	Description	Type	Additional information
residentId	Required - Resident Id	integer	Required
orderBy	Required - order by column, if not passed or not in list of available fields, return Bad Request	string	Required
orderDesc	Required - If not passed, return all recurring charges	boolean	Required
pageSize	Required - size of records per page, if not passed or less than zero, return Bad Request	integer	Required
pageNum	Required - number of the page request, if not passed or less than zero, return bad Request	integer	Required

Body Parameters

None.

Response Information

Resource Description

List RecurringTransactionResponseViewModel

Collection of RecurringTransactionResponseViewModel

Name	Description	Type	Additional information
TotalCount		integer	None.
Items		Collection of RecurringTransactionListItemViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "totalCount": 1,
    "items": [
      {
        "id": 1,
        "appliesTo": "sample string 2",
        "unitType": "sample string 3",
        "unitNumber": "sample string 4",
        "chargeCode": "sample string 5",
        "amount": 6.0,
        "startDate": "2024-10-14T08:25:41.7495908-04:00",
        "endDate": "2024-10-14T08:25:41.7495908-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": "2024-10-14T08:25:41.7495908-04:00",
        "endDate": "2024-10-14T08:25:41.7495908-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
      }
    ]
  },
  {
    "totalCount": 1,
    "items": [
      {
        "id": 1,
        "appliesTo": "sample string 2",
        "unitType": "sample string 3",
        "unitNumber": "sample string 4",
        "chargeCode": "sample string 5",
        "amount": 6.0,
        "startDate": "2024-10-14T08:25:41.7495908-04:00",
        "endDate": "2024-10-14T08:25:41.7495908-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": "2024-10-14T08:25:41.7495908-04:00",
        "endDate": "2024-10-14T08:25:41.7495908-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:

<ArrayOfRecurringTransactionResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <RecurringTransactionResponseViewModel>
    <Items>
      <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>2024-10-14T08:25:41.7495908-04:00</EndDate>
        <Id>1</Id>
        <NumberOfShares>1</NumberOfShares>
        <OverrideDueDay>sample string 11</OverrideDueDay>
        <StartDate>2024-10-14T08:25:41.7495908-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>2024-10-14T08:25:41.7495908-04:00</EndDate>
        <Id>1</Id>
        <NumberOfShares>1</NumberOfShares>
        <OverrideDueDay>sample string 11</OverrideDueDay>
        <StartDate>2024-10-14T08:25:41.7495908-04:00</StartDate>
        <Status>sample string 15</Status>
        <TransactionType>sample string 10</TransactionType>
        <UnitNumber>sample string 4</UnitNumber>
        <UnitType>sample string 3</UnitType>
      </RecurringTransactionListItemViewModel>
    </Items>
    <TotalCount>1</TotalCount>
  </RecurringTransactionResponseViewModel>
  <RecurringTransactionResponseViewModel>
    <Items>
      <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>2024-10-14T08:25:41.7495908-04:00</EndDate>
        <Id>1</Id>
        <NumberOfShares>1</NumberOfShares>
        <OverrideDueDay>sample string 11</OverrideDueDay>
        <StartDate>2024-10-14T08:25:41.7495908-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>2024-10-14T08:25:41.7495908-04:00</EndDate>
        <Id>1</Id>
        <NumberOfShares>1</NumberOfShares>
        <OverrideDueDay>sample string 11</OverrideDueDay>
        <StartDate>2024-10-14T08:25:41.7495908-04:00</StartDate>
        <Status>sample string 15</Status>
        <TransactionType>sample string 10</TransactionType>
        <UnitNumber>sample string 4</UnitNumber>
        <UnitType>sample string 3</UnitType>
      </RecurringTransactionListItemViewModel>
    </Items>
    <TotalCount>1</TotalCount>
  </RecurringTransactionResponseViewModel>
</ArrayOfRecurringTransactionResponseViewModel>