GET api/credits/prepaid/refunds?residentId={residentId}&startDate={startDate}&endDate={endDate}&includePrepayments={includePrepayments}

Get all avaliable prepayment items for refund, a prepayment will be consider either an open credit or a receipt line item

Request Information

URI Parameters

Name	Type	Additional information
residentId	integer	Required
startDate	date	None.
endDate	date	None.
includePrepayments	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of PrepaymentViewModel

Name	Type	Additional information
Description	string	None.
Date	date	None.
Amount	decimal number	None.
Balance	decimal number	None.
Type	string	None.
Details	Collection of PrepaymentDetailViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "description": "sample string 1",
    "date": "2025-04-03T18:11:48.2913725-04:00",
    "amount": 3.0,
    "balance": 4.0,
    "type": "sample string 5",
    "details": [
      {
        "type": "sample string 1",
        "chargeCode": "sample string 2",
        "description": "sample string 3",
        "balance": 4.0,
        "detailId": 5
      },
      {
        "type": "sample string 1",
        "chargeCode": "sample string 2",
        "description": "sample string 3",
        "balance": 4.0,
        "detailId": 5
      }
    ]
  },
  {
    "description": "sample string 1",
    "date": "2025-04-03T18:11:48.2913725-04:00",
    "amount": 3.0,
    "balance": 4.0,
    "type": "sample string 5",
    "details": [
      {
        "type": "sample string 1",
        "chargeCode": "sample string 2",
        "description": "sample string 3",
        "balance": 4.0,
        "detailId": 5
      },
      {
        "type": "sample string 1",
        "chargeCode": "sample string 2",
        "description": "sample string 3",
        "balance": 4.0,
        "detailId": 5
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPrepaymentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Prepaid">
  <PrepaymentViewModel>
    <Amount>3</Amount>
    <Balance>4</Balance>
    <Date>2025-04-03T18:11:48.2913725-04:00</Date>
    <Description>sample string 1</Description>
    <Details>
      <PrepaymentDetailViewModel>
        <Balance>4</Balance>
        <ChargeCode>sample string 2</ChargeCode>
        <Description>sample string 3</Description>
        <DetailId>5</DetailId>
        <Type>sample string 1</Type>
      </PrepaymentDetailViewModel>
      <PrepaymentDetailViewModel>
        <Balance>4</Balance>
        <ChargeCode>sample string 2</ChargeCode>
        <Description>sample string 3</Description>
        <DetailId>5</DetailId>
        <Type>sample string 1</Type>
      </PrepaymentDetailViewModel>
    </Details>
    <Type>sample string 5</Type>
  </PrepaymentViewModel>
  <PrepaymentViewModel>
    <Amount>3</Amount>
    <Balance>4</Balance>
    <Date>2025-04-03T18:11:48.2913725-04:00</Date>
    <Description>sample string 1</Description>
    <Details>
      <PrepaymentDetailViewModel>
        <Balance>4</Balance>
        <ChargeCode>sample string 2</ChargeCode>
        <Description>sample string 3</Description>
        <DetailId>5</DetailId>
        <Type>sample string 1</Type>
      </PrepaymentDetailViewModel>
      <PrepaymentDetailViewModel>
        <Balance>4</Balance>
        <ChargeCode>sample string 2</ChargeCode>
        <Description>sample string 3</Description>
        <DetailId>5</DetailId>
        <Type>sample string 1</Type>
      </PrepaymentDetailViewModel>
    </Details>
    <Type>sample string 5</Type>
  </PrepaymentViewModel>
</ArrayOfPrepaymentViewModel>