GET api/collectionsapproval/residents?from={from}&to={to}&runFor={runFor}&entityId={entityId}

Request Information

URI Parameters

Name	Type	Additional information
from	date	Required
to	date	Required
runFor	date	Required
entityId	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of PreApprovalResidentViewModel

Name	Description	Type	Additional information
Id	Resident ID	integer	None.
DisplayName	Display Name	string	None.
StatusCode	Resident Status ID	string	None.
MoveInDate	Move In Date	date	None.
LastPaymentDate	Last Payment Date	date	None.
LastPaymentAmount	Last Payment Amount	decimal number	None.
RecurringChargeAmount	Recurring Charge Amount	decimal number	None.
PercentOfRecurring	Percent Of Recurring	decimal number	None.
TotalBalance	Total Balance	decimal number	None.
Actions	Actions	Collection of PreApprovalActionViewModel	None.
OutstandingCharges	Pre-Approval Outstanding Charge	Collection of PreApprovalOutstandingChargeViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "displayName": "sample string 2",
    "statusCode": "sample string 3",
    "moveInDate": "2024-10-14T04:24:00.4005392-04:00",
    "lastPaymentDate": "2024-10-14T04:24:00.4005392-04:00",
    "lastPaymentAmount": 6.0,
    "recurringChargeAmount": 7.0,
    "percentOfRecurring": 8.1,
    "totalBalance": 9.0,
    "actions": [
      {
        "id": 1,
        "isApproved": true,
        "name": "sample string 3",
        "value": "sample string 4",
        "stageId": 5,
        "dollarAmount": 6.0
      },
      {
        "id": 1,
        "isApproved": true,
        "name": "sample string 3",
        "value": "sample string 4",
        "stageId": 5,
        "dollarAmount": 6.0
      }
    ],
    "outstandingCharges": [
      {
        "outstandingDays": 1,
        "postDate": "2024-10-14T04:24:00.4005392-04:00",
        "setlementDate": "2024-10-14T04:24:00.4005392-04:00",
        "type": "sample string 4",
        "chargeCodeDescription": "sample string 5",
        "amount": 6.0
      },
      {
        "outstandingDays": 1,
        "postDate": "2024-10-14T04:24:00.4005392-04:00",
        "setlementDate": "2024-10-14T04:24:00.4005392-04:00",
        "type": "sample string 4",
        "chargeCodeDescription": "sample string 5",
        "amount": 6.0
      }
    ]
  },
  {
    "id": 1,
    "displayName": "sample string 2",
    "statusCode": "sample string 3",
    "moveInDate": "2024-10-14T04:24:00.4005392-04:00",
    "lastPaymentDate": "2024-10-14T04:24:00.4005392-04:00",
    "lastPaymentAmount": 6.0,
    "recurringChargeAmount": 7.0,
    "percentOfRecurring": 8.1,
    "totalBalance": 9.0,
    "actions": [
      {
        "id": 1,
        "isApproved": true,
        "name": "sample string 3",
        "value": "sample string 4",
        "stageId": 5,
        "dollarAmount": 6.0
      },
      {
        "id": 1,
        "isApproved": true,
        "name": "sample string 3",
        "value": "sample string 4",
        "stageId": 5,
        "dollarAmount": 6.0
      }
    ],
    "outstandingCharges": [
      {
        "outstandingDays": 1,
        "postDate": "2024-10-14T04:24:00.4005392-04:00",
        "setlementDate": "2024-10-14T04:24:00.4005392-04:00",
        "type": "sample string 4",
        "chargeCodeDescription": "sample string 5",
        "amount": 6.0
      },
      {
        "outstandingDays": 1,
        "postDate": "2024-10-14T04:24:00.4005392-04:00",
        "setlementDate": "2024-10-14T04:24:00.4005392-04:00",
        "type": "sample string 4",
        "chargeCodeDescription": "sample string 5",
        "amount": 6.0
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPreApprovalResidentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">
  <PreApprovalResidentViewModel>
    <Actions>
      <PreApprovalActionViewModel>
        <DollarAmount>6</DollarAmount>
        <Id>1</Id>
        <IsApproved>true</IsApproved>
        <Name>sample string 3</Name>
        <StageId>5</StageId>
        <Value>sample string 4</Value>
      </PreApprovalActionViewModel>
      <PreApprovalActionViewModel>
        <DollarAmount>6</DollarAmount>
        <Id>1</Id>
        <IsApproved>true</IsApproved>
        <Name>sample string 3</Name>
        <StageId>5</StageId>
        <Value>sample string 4</Value>
      </PreApprovalActionViewModel>
    </Actions>
    <DisplayName>sample string 2</DisplayName>
    <Id>1</Id>
    <LastPaymentAmount>6</LastPaymentAmount>
    <LastPaymentDate>2024-10-14T04:24:00.4005392-04:00</LastPaymentDate>
    <MoveInDate>2024-10-14T04:24:00.4005392-04:00</MoveInDate>
    <OutstandingCharges>
      <PreApprovalOutstandingChargeViewModel>
        <Amount>6</Amount>
        <ChargeCodeDescription>sample string 5</ChargeCodeDescription>
        <OutstandingDays>1</OutstandingDays>
        <PostDate>2024-10-14T04:24:00.4005392-04:00</PostDate>
        <SetlementDate>2024-10-14T04:24:00.4005392-04:00</SetlementDate>
        <Type>sample string 4</Type>
      </PreApprovalOutstandingChargeViewModel>
      <PreApprovalOutstandingChargeViewModel>
        <Amount>6</Amount>
        <ChargeCodeDescription>sample string 5</ChargeCodeDescription>
        <OutstandingDays>1</OutstandingDays>
        <PostDate>2024-10-14T04:24:00.4005392-04:00</PostDate>
        <SetlementDate>2024-10-14T04:24:00.4005392-04:00</SetlementDate>
        <Type>sample string 4</Type>
      </PreApprovalOutstandingChargeViewModel>
    </OutstandingCharges>
    <PercentOfRecurring>8.1</PercentOfRecurring>
    <RecurringChargeAmount>7</RecurringChargeAmount>
    <StatusCode>sample string 3</StatusCode>
    <TotalBalance>9</TotalBalance>
  </PreApprovalResidentViewModel>
  <PreApprovalResidentViewModel>
    <Actions>
      <PreApprovalActionViewModel>
        <DollarAmount>6</DollarAmount>
        <Id>1</Id>
        <IsApproved>true</IsApproved>
        <Name>sample string 3</Name>
        <StageId>5</StageId>
        <Value>sample string 4</Value>
      </PreApprovalActionViewModel>
      <PreApprovalActionViewModel>
        <DollarAmount>6</DollarAmount>
        <Id>1</Id>
        <IsApproved>true</IsApproved>
        <Name>sample string 3</Name>
        <StageId>5</StageId>
        <Value>sample string 4</Value>
      </PreApprovalActionViewModel>
    </Actions>
    <DisplayName>sample string 2</DisplayName>
    <Id>1</Id>
    <LastPaymentAmount>6</LastPaymentAmount>
    <LastPaymentDate>2024-10-14T04:24:00.4005392-04:00</LastPaymentDate>
    <MoveInDate>2024-10-14T04:24:00.4005392-04:00</MoveInDate>
    <OutstandingCharges>
      <PreApprovalOutstandingChargeViewModel>
        <Amount>6</Amount>
        <ChargeCodeDescription>sample string 5</ChargeCodeDescription>
        <OutstandingDays>1</OutstandingDays>
        <PostDate>2024-10-14T04:24:00.4005392-04:00</PostDate>
        <SetlementDate>2024-10-14T04:24:00.4005392-04:00</SetlementDate>
        <Type>sample string 4</Type>
      </PreApprovalOutstandingChargeViewModel>
      <PreApprovalOutstandingChargeViewModel>
        <Amount>6</Amount>
        <ChargeCodeDescription>sample string 5</ChargeCodeDescription>
        <OutstandingDays>1</OutstandingDays>
        <PostDate>2024-10-14T04:24:00.4005392-04:00</PostDate>
        <SetlementDate>2024-10-14T04:24:00.4005392-04:00</SetlementDate>
        <Type>sample string 4</Type>
      </PreApprovalOutstandingChargeViewModel>
    </OutstandingCharges>
    <PercentOfRecurring>8.1</PercentOfRecurring>
    <RecurringChargeAmount>7</RecurringChargeAmount>
    <StatusCode>sample string 3</StatusCode>
    <TotalBalance>9</TotalBalance>
  </PreApprovalResidentViewModel>
</ArrayOfPreApprovalResidentViewModel>