POST api/credits/prepaid/refunds

Post the payments for the credits and prepayments

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OverrideBankCodeId

integer

Required

Range: inclusive between 1 and 2147483647

Description

string

Required

Max length: 100

RefundDate

date

None.

LineItems

Collection of PrepaymentPostingLineItemViewModel

None.

Credentials

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of PrepaymentPostingResultViewModel
NameDescriptionTypeAdditional information
BatchId

integer

None.

LineItems

Collection of PrepaymentPostingLineItemResultViewModel

None.

Messages

Collection of string

None.

Status

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "batchId": 1,
    "lineItems": [
      {
        "creditId": 1,
        "status": "sample string 2",
        "messages": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "creditId": 1,
        "status": "sample string 2",
        "messages": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "messages": [
      "sample string 1",
      "sample string 2"
    ],
    "status": "sample string 2"
  },
  {
    "batchId": 1,
    "lineItems": [
      {
        "creditId": 1,
        "status": "sample string 2",
        "messages": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "creditId": 1,
        "status": "sample string 2",
        "messages": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "messages": [
      "sample string 1",
      "sample string 2"
    ],
    "status": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPrepaymentPostingResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Prepaid">
  <PrepaymentPostingResultViewModel>
    <BatchId>1</BatchId>
    <LineItems>
      <PrepaymentPostingLineItemResultViewModel>
        <CreditId>1</CreditId>
        <Messages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Messages>
        <Status>sample string 2</Status>
      </PrepaymentPostingLineItemResultViewModel>
      <PrepaymentPostingLineItemResultViewModel>
        <CreditId>1</CreditId>
        <Messages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Messages>
        <Status>sample string 2</Status>
      </PrepaymentPostingLineItemResultViewModel>
    </LineItems>
    <Status>sample string 2</Status>
  </PrepaymentPostingResultViewModel>
  <PrepaymentPostingResultViewModel>
    <BatchId>1</BatchId>
    <LineItems>
      <PrepaymentPostingLineItemResultViewModel>
        <CreditId>1</CreditId>
        <Messages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Messages>
        <Status>sample string 2</Status>
      </PrepaymentPostingLineItemResultViewModel>
      <PrepaymentPostingLineItemResultViewModel>
        <CreditId>1</CreditId>
        <Messages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Messages>
        <Status>sample string 2</Status>
      </PrepaymentPostingLineItemResultViewModel>
    </LineItems>
    <Status>sample string 2</Status>
  </PrepaymentPostingResultViewModel>
</ArrayOfPrepaymentPostingResultViewModel>