GET api/residents/{residentId}/receipts?receiptType={receiptType}&startDate={startDate}&endDate={endDate}&excludeRefundedLines={excludeRefundedLines}

Get Security Deposit payments by residentId and date. Use yyyy-mm-dd format for date param

Request Information

URI Parameters

Name	Type	Additional information
residentId	integer	Required
receiptType	ArReceiptTypeEnum	None.
startDate	date	None.
endDate	date	None.
excludeRefundedLines	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

ARReceiptRefundViewModel

Collection of ArReceiptRefundViewModel

Name	Description	Type	Additional information
Balance	Balance	decimal number	None.
ReceiptId	ReceiptId	integer	None.
UnitId	UnitId	integer	None.
ResidentId	ResidentId	integer	None.
PaymentType	PaymentType	string	None.
CheckNumber	CheckNumber	string	None.
ReceiptDate	ReceiptDate	date	None.
ReceiptDescriptions	ReceiptDescriptions	string	None.
ReceiptType	ReceiptType	integer	None.
ArBatchReceiptId	ArBatchReceiptId	integer	None.
AuxillaryField	AuxillaryField	integer	None.
ArReceiptTypeId	ArReceiptTypeId	integer	None.
BuildingId	BuildingId	integer	None.
CreatedDate	CreatedDate	date	None.
PostDate	PostDate	date	None.
Posted	Posted	integer	None.
Transfered	Transfered	integer	None.
Reversed	Reversed	boolean	None.
ReceiptAmount	ReceiptAmount	decimal number	None.
ReceiptLineItems	ReceiptLineItems	Collection of ReceiptLineItemViewModel	None.
BankCode	BankCode	string	None.
IsBankCodeActive	IsBankCodeActive	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "balance": 1.0,
    "receiptId": 2,
    "unitId": 1,
    "residentId": 1,
    "paymentType": "sample string 3",
    "checkNumber": "sample string 4",
    "receiptDate": "2024-10-14T04:25:35.710125-04:00",
    "receiptDescriptions": "sample string 5",
    "receiptType": 6,
    "arBatchReceiptId": 1,
    "auxillaryField": 1,
    "arReceiptTypeId": 7,
    "buildingId": 1,
    "createdDate": "2024-10-14T04:25:35.710125-04:00",
    "postDate": "2024-10-14T04:25:35.710125-04:00",
    "posted": 8,
    "transfered": 9,
    "reversed": true,
    "receiptAmount": 11.0,
    "receiptLineItems": [
      {
        "receiptLineItemId": 1,
        "receiptId": 2,
        "paymentAmount": 3.0,
        "chartOfAccountsId": 1,
        "glSubAccountId": 1,
        "prepayChargeCodeId": 1,
        "chargeId": 1,
        "creditId": 1,
        "securityDepositTypeId": 4,
        "originalAmount": 5.0,
        "refundAmount": 6.0,
        "refunded": true,
        "dateRefunded": "2024-10-14T04:25:35.710125-04:00",
        "securityDepositType": {
          "id": 1,
          "description": "sample string 2",
          "depositCode": "sample string 3",
          "depositGLAccountId": 4,
          "depositGLSubAccountId": 5,
          "refundGLAccountId": 6,
          "refundGLSubAccount": 7,
          "interestRate": 8.0,
          "isActive": true
        }
      },
      {
        "receiptLineItemId": 1,
        "receiptId": 2,
        "paymentAmount": 3.0,
        "chartOfAccountsId": 1,
        "glSubAccountId": 1,
        "prepayChargeCodeId": 1,
        "chargeId": 1,
        "creditId": 1,
        "securityDepositTypeId": 4,
        "originalAmount": 5.0,
        "refundAmount": 6.0,
        "refunded": true,
        "dateRefunded": "2024-10-14T04:25:35.710125-04:00",
        "securityDepositType": {
          "id": 1,
          "description": "sample string 2",
          "depositCode": "sample string 3",
          "depositGLAccountId": 4,
          "depositGLSubAccountId": 5,
          "refundGLAccountId": 6,
          "refundGLSubAccount": 7,
          "interestRate": 8.0,
          "isActive": true
        }
      }
    ],
    "bankCode": "sample string 12",
    "isBankCodeActive": true
  },
  {
    "balance": 1.0,
    "receiptId": 2,
    "unitId": 1,
    "residentId": 1,
    "paymentType": "sample string 3",
    "checkNumber": "sample string 4",
    "receiptDate": "2024-10-14T04:25:35.710125-04:00",
    "receiptDescriptions": "sample string 5",
    "receiptType": 6,
    "arBatchReceiptId": 1,
    "auxillaryField": 1,
    "arReceiptTypeId": 7,
    "buildingId": 1,
    "createdDate": "2024-10-14T04:25:35.710125-04:00",
    "postDate": "2024-10-14T04:25:35.710125-04:00",
    "posted": 8,
    "transfered": 9,
    "reversed": true,
    "receiptAmount": 11.0,
    "receiptLineItems": [
      {
        "receiptLineItemId": 1,
        "receiptId": 2,
        "paymentAmount": 3.0,
        "chartOfAccountsId": 1,
        "glSubAccountId": 1,
        "prepayChargeCodeId": 1,
        "chargeId": 1,
        "creditId": 1,
        "securityDepositTypeId": 4,
        "originalAmount": 5.0,
        "refundAmount": 6.0,
        "refunded": true,
        "dateRefunded": "2024-10-14T04:25:35.710125-04:00",
        "securityDepositType": {
          "id": 1,
          "description": "sample string 2",
          "depositCode": "sample string 3",
          "depositGLAccountId": 4,
          "depositGLSubAccountId": 5,
          "refundGLAccountId": 6,
          "refundGLSubAccount": 7,
          "interestRate": 8.0,
          "isActive": true
        }
      },
      {
        "receiptLineItemId": 1,
        "receiptId": 2,
        "paymentAmount": 3.0,
        "chartOfAccountsId": 1,
        "glSubAccountId": 1,
        "prepayChargeCodeId": 1,
        "chargeId": 1,
        "creditId": 1,
        "securityDepositTypeId": 4,
        "originalAmount": 5.0,
        "refundAmount": 6.0,
        "refunded": true,
        "dateRefunded": "2024-10-14T04:25:35.710125-04:00",
        "securityDepositType": {
          "id": 1,
          "description": "sample string 2",
          "depositCode": "sample string 3",
          "depositGLAccountId": 4,
          "depositGLSubAccountId": 5,
          "refundGLAccountId": 6,
          "refundGLSubAccount": 7,
          "interestRate": 8.0,
          "isActive": true
        }
      }
    ],
    "bankCode": "sample string 12",
    "isBankCodeActive": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfArReceiptRefundViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <ArReceiptRefundViewModel>
    <ArBatchReceiptId>1</ArBatchReceiptId>
    <ArReceiptTypeId>7</ArReceiptTypeId>
    <AuxillaryField>1</AuxillaryField>
    <BankCode>sample string 12</BankCode>
    <BuildingId>1</BuildingId>
    <CheckNumber>sample string 4</CheckNumber>
    <CreatedDate>2024-10-14T04:25:35.710125-04:00</CreatedDate>
    <IsBankCodeActive>true</IsBankCodeActive>
    <PaymentType>sample string 3</PaymentType>
    <PostDate>2024-10-14T04:25:35.710125-04:00</PostDate>
    <Posted>8</Posted>
    <ReceiptAmount>11</ReceiptAmount>
    <ReceiptDate>2024-10-14T04:25:35.710125-04:00</ReceiptDate>
    <ReceiptDescriptions>sample string 5</ReceiptDescriptions>
    <ReceiptId>2</ReceiptId>
    <ReceiptLineItems>
      <ReceiptLineItemViewModel>
        <ChargeId>1</ChargeId>
        <ChartOfAccountsId>1</ChartOfAccountsId>
        <CreditId>1</CreditId>
        <DateRefunded>2024-10-14T04:25:35.710125-04:00</DateRefunded>
        <GlSubAccountId>1</GlSubAccountId>
        <OriginalAmount>5</OriginalAmount>
        <PaymentAmount>3</PaymentAmount>
        <PrepayChargeCodeId>1</PrepayChargeCodeId>
        <ReceiptId>2</ReceiptId>
        <ReceiptLineItemId>1</ReceiptLineItemId>
        <RefundAmount>6</RefundAmount>
        <Refunded>true</Refunded>
        <SecurityDepositType>
          <DepositCode>sample string 3</DepositCode>
          <DepositGLAccountId>4</DepositGLAccountId>
          <DepositGLSubAccountId>5</DepositGLSubAccountId>
          <Description>sample string 2</Description>
          <Id>1</Id>
          <InterestRate>8</InterestRate>
          <IsActive>true</IsActive>
          <RefundGLAccountId>6</RefundGLAccountId>
          <RefundGLSubAccount>7</RefundGLSubAccount>
        </SecurityDepositType>
        <SecurityDepositTypeId>4</SecurityDepositTypeId>
      </ReceiptLineItemViewModel>
      <ReceiptLineItemViewModel>
        <ChargeId>1</ChargeId>
        <ChartOfAccountsId>1</ChartOfAccountsId>
        <CreditId>1</CreditId>
        <DateRefunded>2024-10-14T04:25:35.710125-04:00</DateRefunded>
        <GlSubAccountId>1</GlSubAccountId>
        <OriginalAmount>5</OriginalAmount>
        <PaymentAmount>3</PaymentAmount>
        <PrepayChargeCodeId>1</PrepayChargeCodeId>
        <ReceiptId>2</ReceiptId>
        <ReceiptLineItemId>1</ReceiptLineItemId>
        <RefundAmount>6</RefundAmount>
        <Refunded>true</Refunded>
        <SecurityDepositType>
          <DepositCode>sample string 3</DepositCode>
          <DepositGLAccountId>4</DepositGLAccountId>
          <DepositGLSubAccountId>5</DepositGLSubAccountId>
          <Description>sample string 2</Description>
          <Id>1</Id>
          <InterestRate>8</InterestRate>
          <IsActive>true</IsActive>
          <RefundGLAccountId>6</RefundGLAccountId>
          <RefundGLSubAccount>7</RefundGLSubAccount>
        </SecurityDepositType>
        <SecurityDepositTypeId>4</SecurityDepositTypeId>
      </ReceiptLineItemViewModel>
    </ReceiptLineItems>
    <ReceiptType>6</ReceiptType>
    <ResidentId>1</ResidentId>
    <Reversed>true</Reversed>
    <Transfered>9</Transfered>
    <UnitId>1</UnitId>
    <Balance>1</Balance>
  </ArReceiptRefundViewModel>
  <ArReceiptRefundViewModel>
    <ArBatchReceiptId>1</ArBatchReceiptId>
    <ArReceiptTypeId>7</ArReceiptTypeId>
    <AuxillaryField>1</AuxillaryField>
    <BankCode>sample string 12</BankCode>
    <BuildingId>1</BuildingId>
    <CheckNumber>sample string 4</CheckNumber>
    <CreatedDate>2024-10-14T04:25:35.710125-04:00</CreatedDate>
    <IsBankCodeActive>true</IsBankCodeActive>
    <PaymentType>sample string 3</PaymentType>
    <PostDate>2024-10-14T04:25:35.710125-04:00</PostDate>
    <Posted>8</Posted>
    <ReceiptAmount>11</ReceiptAmount>
    <ReceiptDate>2024-10-14T04:25:35.710125-04:00</ReceiptDate>
    <ReceiptDescriptions>sample string 5</ReceiptDescriptions>
    <ReceiptId>2</ReceiptId>
    <ReceiptLineItems>
      <ReceiptLineItemViewModel>
        <ChargeId>1</ChargeId>
        <ChartOfAccountsId>1</ChartOfAccountsId>
        <CreditId>1</CreditId>
        <DateRefunded>2024-10-14T04:25:35.710125-04:00</DateRefunded>
        <GlSubAccountId>1</GlSubAccountId>
        <OriginalAmount>5</OriginalAmount>
        <PaymentAmount>3</PaymentAmount>
        <PrepayChargeCodeId>1</PrepayChargeCodeId>
        <ReceiptId>2</ReceiptId>
        <ReceiptLineItemId>1</ReceiptLineItemId>
        <RefundAmount>6</RefundAmount>
        <Refunded>true</Refunded>
        <SecurityDepositType>
          <DepositCode>sample string 3</DepositCode>
          <DepositGLAccountId>4</DepositGLAccountId>
          <DepositGLSubAccountId>5</DepositGLSubAccountId>
          <Description>sample string 2</Description>
          <Id>1</Id>
          <InterestRate>8</InterestRate>
          <IsActive>true</IsActive>
          <RefundGLAccountId>6</RefundGLAccountId>
          <RefundGLSubAccount>7</RefundGLSubAccount>
        </SecurityDepositType>
        <SecurityDepositTypeId>4</SecurityDepositTypeId>
      </ReceiptLineItemViewModel>
      <ReceiptLineItemViewModel>
        <ChargeId>1</ChargeId>
        <ChartOfAccountsId>1</ChartOfAccountsId>
        <CreditId>1</CreditId>
        <DateRefunded>2024-10-14T04:25:35.710125-04:00</DateRefunded>
        <GlSubAccountId>1</GlSubAccountId>
        <OriginalAmount>5</OriginalAmount>
        <PaymentAmount>3</PaymentAmount>
        <PrepayChargeCodeId>1</PrepayChargeCodeId>
        <ReceiptId>2</ReceiptId>
        <ReceiptLineItemId>1</ReceiptLineItemId>
        <RefundAmount>6</RefundAmount>
        <Refunded>true</Refunded>
        <SecurityDepositType>
          <DepositCode>sample string 3</DepositCode>
          <DepositGLAccountId>4</DepositGLAccountId>
          <DepositGLSubAccountId>5</DepositGLSubAccountId>
          <Description>sample string 2</Description>
          <Id>1</Id>
          <InterestRate>8</InterestRate>
          <IsActive>true</IsActive>
          <RefundGLAccountId>6</RefundGLAccountId>
          <RefundGLSubAccount>7</RefundGLSubAccount>
        </SecurityDepositType>
        <SecurityDepositTypeId>4</SecurityDepositTypeId>
      </ReceiptLineItemViewModel>
    </ReceiptLineItems>
    <ReceiptType>6</ReceiptType>
    <ResidentId>1</ResidentId>
    <Reversed>true</Reversed>
    <Transfered>9</Transfered>
    <UnitId>1</UnitId>
    <Balance>1</Balance>
  </ArReceiptRefundViewModel>
</ArrayOfArReceiptRefundViewModel>