GET api/residents/{residentId}/receipts/securityDeposits?pageSize={pageSize}&pageNum={pageNum}&orderBy={orderBy}&orderDesc={orderDesc}&startDate={startDate}&endDate={endDate}

Get Resident Security Deposits

Request Information

URI Parameters

Name	Description	Type	Additional information
residentId	Primary Resident Identifier	integer	Required
pageSize		integer	None.
pageNum		integer	None.
orderBy		string	None.
orderDesc		boolean	None.
startDate		date	None.
endDate		date	None.

Body Parameters

None.

Response Information

Resource Description

Resident Security Deposits

SecurityDepositsViewModel

Name	Type	Additional information
Balance	decimal number	None.
TotalCount	decimal number	None.
TotalPaid	decimal number	None.
TotalRefund	decimal number	None.
TotalChargeOff	decimal number	None.
Items	Collection of SecurityDepositItemViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "balance": 1.0,
  "totalCount": 1.0,
  "totalPaid": 1.0,
  "totalRefund": 2.0,
  "totalChargeOff": 3.0,
  "items": [
    {
      "batchId": 1,
      "receiptId": 2,
      "receiptLineItemId": 3,
      "bankCode": "sample string 4",
      "checkNo": "sample string 5",
      "receiptDate": "2024-10-14T08:24:57.4256018-04:00",
      "postDate": "2024-10-14T08:24:57.4256018-04:00",
      "jeId": 1,
      "receiptDescription": "sample string 7",
      "amount": 1.0,
      "reversed": true,
      "refunded": true,
      "refundDate": "2024-10-14T08:24:57.4256018-04:00",
      "refundAmount": 1.0,
      "balance": 1.0,
      "securityDepositTypeId": 10,
      "securityDepositTypeDecription": "sample string 11",
      "securityDepositTypeCode": "sample string 12",
      "chargeOffAmount": 1.0,
      "chargeCreditBatchIds": [
        1,
        2
      ],
      "arBatchIds": [
        1,
        2
      ]
    },
    {
      "batchId": 1,
      "receiptId": 2,
      "receiptLineItemId": 3,
      "bankCode": "sample string 4",
      "checkNo": "sample string 5",
      "receiptDate": "2024-10-14T08:24:57.4256018-04:00",
      "postDate": "2024-10-14T08:24:57.4256018-04:00",
      "jeId": 1,
      "receiptDescription": "sample string 7",
      "amount": 1.0,
      "reversed": true,
      "refunded": true,
      "refundDate": "2024-10-14T08:24:57.4256018-04:00",
      "refundAmount": 1.0,
      "balance": 1.0,
      "securityDepositTypeId": 10,
      "securityDepositTypeDecription": "sample string 11",
      "securityDepositTypeCode": "sample string 12",
      "chargeOffAmount": 1.0,
      "chargeCreditBatchIds": [
        1,
        2
      ],
      "arBatchIds": [
        1,
        2
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<SecurityDepositsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.ArReceipts">
  <Balance>1</Balance>
  <Items>
    <SecurityDepositItemViewModel>
      <Amount>1</Amount>
      <ArBatchIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ArBatchIds>
      <Balance>1</Balance>
      <BankCode>sample string 4</BankCode>
      <BatchId>1</BatchId>
      <ChargeCreditBatchIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ChargeCreditBatchIds>
      <ChargeOffAmount>1</ChargeOffAmount>
      <CheckNo>sample string 5</CheckNo>
      <JeId>1</JeId>
      <PostDate>2024-10-14T08:24:57.4256018-04:00</PostDate>
      <ReceiptDate>2024-10-14T08:24:57.4256018-04:00</ReceiptDate>
      <ReceiptDescription>sample string 7</ReceiptDescription>
      <ReceiptId>2</ReceiptId>
      <ReceiptLineItemId>3</ReceiptLineItemId>
      <RefundAmount>1</RefundAmount>
      <RefundDate>2024-10-14T08:24:57.4256018-04:00</RefundDate>
      <Refunded>true</Refunded>
      <Reversed>true</Reversed>
      <SecurityDepositTypeCode>sample string 12</SecurityDepositTypeCode>
      <SecurityDepositTypeDecription>sample string 11</SecurityDepositTypeDecription>
      <SecurityDepositTypeId>10</SecurityDepositTypeId>
    </SecurityDepositItemViewModel>
    <SecurityDepositItemViewModel>
      <Amount>1</Amount>
      <ArBatchIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ArBatchIds>
      <Balance>1</Balance>
      <BankCode>sample string 4</BankCode>
      <BatchId>1</BatchId>
      <ChargeCreditBatchIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ChargeCreditBatchIds>
      <ChargeOffAmount>1</ChargeOffAmount>
      <CheckNo>sample string 5</CheckNo>
      <JeId>1</JeId>
      <PostDate>2024-10-14T08:24:57.4256018-04:00</PostDate>
      <ReceiptDate>2024-10-14T08:24:57.4256018-04:00</ReceiptDate>
      <ReceiptDescription>sample string 7</ReceiptDescription>
      <ReceiptId>2</ReceiptId>
      <ReceiptLineItemId>3</ReceiptLineItemId>
      <RefundAmount>1</RefundAmount>
      <RefundDate>2024-10-14T08:24:57.4256018-04:00</RefundDate>
      <Refunded>true</Refunded>
      <Reversed>true</Reversed>
      <SecurityDepositTypeCode>sample string 12</SecurityDepositTypeCode>
      <SecurityDepositTypeDecription>sample string 11</SecurityDepositTypeDecription>
      <SecurityDepositTypeId>10</SecurityDepositTypeId>
    </SecurityDepositItemViewModel>
  </Items>
  <TotalChargeOff>3</TotalChargeOff>
  <TotalCount>1</TotalCount>
  <TotalPaid>1</TotalPaid>
  <TotalRefund>2</TotalRefund>
</SecurityDepositsViewModel>