POST Payment/ReversePayment

Reverses a Received on Account payment.

Request Information

URI Parameters

Body Parameters

The AR payment object to reverse.

ClsPaymentReverse
NameDescriptionTypeAdditional Information
PaymentGUID

GUID of the payment to void

 globally unique identifier

Required
ReverseReason

Reason for the void

 string

Max length: 255
ReverseDate

Date of the reversing payment.

 string

Data type: DateTime

Format must be MM/dd/yyyy

Request Formats

application/json, text/json

Sample: 
{
  "PaymentGUID": "44a20312-3f7b-4672-bbbe-d8af917c1c9b",
  "ReverseReason": "sample string 2",
  "ReverseDate": "sample string 3"
}

application/xml, text/xml

Sample: 
<PaymentReverse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.AR.Payment">
  <PaymentGUID>44a20312-3f7b-4672-bbbe-d8af917c1c9b</PaymentGUID>
  <ReverseDate>sample string 3</ReverseDate>
  <ReverseReason>sample string 2</ReverseReason>
</PaymentReverse>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsPaymentReverse'.

Response Information

Resource Description

Reverses a Received on Account payment.

AgvPayment
NameDescriptionTypeAdditional Information
Status

Status of the API call.

 string
Message

Message of the API call.

 string
ErrorList

List of error messages of the API call.

 Collection of string
WarningList

List of warning messages of the API call.

 Collection of string
Count

Count of how many Payments.

 string
PaymentRecords

JSON dictionary of PaymentRecords.

 Collection of clsAPIPayment

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "PaymentRecords": [
    {
      "PaymentDate": "sample string 1",
      "PaymentLocation": "sample string 2",
      "PaymentNumber": "sample string 3",
      "PaymentRecordHeaderDetails": null,
      "PaymentRecordPayMethodDetails": [],
      "PaymentRecordLineItemDetails": []
    },
    {
      "PaymentDate": "sample string 1",
      "PaymentLocation": "sample string 2",
      "PaymentNumber": "sample string 3",
      "PaymentRecordHeaderDetails": null,
      "PaymentRecordPayMethodDetails": [],
      "PaymentRecordLineItemDetails": []
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.