PUT Payment/VoidPayment

Voids a Received on Account payment.

Request Information

URI Parameters

Body Parameters

The AR payment object to void.

Name	Description	Type	Additional Information
PaymentGUID	GUID of the payment to void	globally unique identifier	Required
VoidReason	Reason for the void	string	Max length: 255

Request Formats

application/json, text/json

Sample:

{
  "PaymentGUID": "9cc29c41-13a3-40ab-a578-0c5a8bc13d58",
  "VoidReason": "sample string 2"
}

application/xml, text/xml

Sample:

<PaymentVoid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.AR.Payment">
  <PaymentGUID>9cc29c41-13a3-40ab-a578-0c5a8bc13d58</PaymentGUID>
  <VoidReason>sample string 2</VoidReason>
</PaymentVoid>

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 'ClsPaymentVoid'.

Response Information

Resource Description

Voids a Received on Account payment.

AgvPayment

Name	Description	Type
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.