POST api/residents/{residentId}/receipts/securityDeposits/refund

Posting Ar Refunds

Request Information

URI Parameters

Name	Type	Additional information
OverrideBankCodeId	integer	Required Range: inclusive between 1 and 2147483647
DateRefunded	date	Required
RefundDescription	string	Required String length: inclusive between 1 and 100
SubletItems	Collection of ArRefundSubletItemViewModel	Required
residentId	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of RefundResultViewModel

Name	Type	Additional information
BatchId	integer	None.
Receipts	Collection of RefundReceiptResultViewModel	None.
Status	string	None.
Messages	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "batchId": 1,
    "receipts": [
      {
        "receiptId": 1,
        "lineItems": [
          {
            "receiptLineItemId": 1,
            "messages": [
              "sample string 1",
              "sample string 2"
            ],
            "status": "sample string 2"
          },
          {
            "receiptLineItemId": 1,
            "messages": [
              "sample string 1",
              "sample string 2"
            ],
            "status": "sample string 2"
          }
        ],
        "status": "Error"
      },
      {
        "receiptId": 1,
        "lineItems": [
          {
            "receiptLineItemId": 1,
            "messages": [
              "sample string 1",
              "sample string 2"
            ],
            "status": "sample string 2"
          },
          {
            "receiptLineItemId": 1,
            "messages": [
              "sample string 1",
              "sample string 2"
            ],
            "status": "sample string 2"
          }
        ],
        "status": "Error"
      }
    ],
    "status": "sample string 2",
    "messages": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "batchId": 1,
    "receipts": [
      {
        "receiptId": 1,
        "lineItems": [
          {
            "receiptLineItemId": 1,
            "messages": [
              "sample string 1",
              "sample string 2"
            ],
            "status": "sample string 2"
          },
          {
            "receiptLineItemId": 1,
            "messages": [
              "sample string 1",
              "sample string 2"
            ],
            "status": "sample string 2"
          }
        ],
        "status": "Error"
      },
      {
        "receiptId": 1,
        "lineItems": [
          {
            "receiptLineItemId": 1,
            "messages": [
              "sample string 1",
              "sample string 2"
            ],
            "status": "sample string 2"
          },
          {
            "receiptLineItemId": 1,
            "messages": [
              "sample string 1",
              "sample string 2"
            ],
            "status": "sample string 2"
          }
        ],
        "status": "Error"
      }
    ],
    "status": "sample string 2",
    "messages": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfRefundResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Refund">
  <RefundResultViewModel>
    <BatchId>1</BatchId>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Receipts>
      <RefundReceiptResultViewModel>
        <LineItems>
          <ArReceiptLineItemResultViewModel>
            <Messages xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Messages>
            <ReceiptLineItemId>1</ReceiptLineItemId>
            <Status>sample string 2</Status>
          </ArReceiptLineItemResultViewModel>
          <ArReceiptLineItemResultViewModel>
            <Messages xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Messages>
            <ReceiptLineItemId>1</ReceiptLineItemId>
            <Status>sample string 2</Status>
          </ArReceiptLineItemResultViewModel>
        </LineItems>
        <ReceiptId>1</ReceiptId>
      </RefundReceiptResultViewModel>
      <RefundReceiptResultViewModel>
        <LineItems>
          <ArReceiptLineItemResultViewModel>
            <Messages xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Messages>
            <ReceiptLineItemId>1</ReceiptLineItemId>
            <Status>sample string 2</Status>
          </ArReceiptLineItemResultViewModel>
          <ArReceiptLineItemResultViewModel>
            <Messages xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Messages>
            <ReceiptLineItemId>1</ReceiptLineItemId>
            <Status>sample string 2</Status>
          </ArReceiptLineItemResultViewModel>
        </LineItems>
        <ReceiptId>1</ReceiptId>
      </RefundReceiptResultViewModel>
    </Receipts>
    <Status>sample string 2</Status>
  </RefundResultViewModel>
  <RefundResultViewModel>
    <BatchId>1</BatchId>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Receipts>
      <RefundReceiptResultViewModel>
        <LineItems>
          <ArReceiptLineItemResultViewModel>
            <Messages xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Messages>
            <ReceiptLineItemId>1</ReceiptLineItemId>
            <Status>sample string 2</Status>
          </ArReceiptLineItemResultViewModel>
          <ArReceiptLineItemResultViewModel>
            <Messages xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Messages>
            <ReceiptLineItemId>1</ReceiptLineItemId>
            <Status>sample string 2</Status>
          </ArReceiptLineItemResultViewModel>
        </LineItems>
        <ReceiptId>1</ReceiptId>
      </RefundReceiptResultViewModel>
      <RefundReceiptResultViewModel>
        <LineItems>
          <ArReceiptLineItemResultViewModel>
            <Messages xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Messages>
            <ReceiptLineItemId>1</ReceiptLineItemId>
            <Status>sample string 2</Status>
          </ArReceiptLineItemResultViewModel>
          <ArReceiptLineItemResultViewModel>
            <Messages xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </Messages>
            <ReceiptLineItemId>1</ReceiptLineItemId>
            <Status>sample string 2</Status>
          </ArReceiptLineItemResultViewModel>
        </LineItems>
        <ReceiptId>1</ReceiptId>
      </RefundReceiptResultViewModel>
    </Receipts>
    <Status>sample string 2</Status>
  </RefundResultViewModel>
</ArrayOfRefundResultViewModel>