POST api/v2/AR/ReversePayment

Reverses a previously submitted payment.

Request Information

URI Parameters

None.

Body Parameters

ReversePaymentArgs
NameDescriptionTypeAdditional information
CustomerId

Customer Id for the payment to reverse.

 string

None.
BatchId

The Batch Id where original payment was created.

 string

None.
ReferenceId

Reference number for the payment in the original batch.

 string

None.
StatementDesc

The description of this reversal to show when posting to the General Ledger.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerId": "sample string 1",
  "BatchId": "sample string 2",
  "ReferenceId": "sample string 3",
  "StatementDesc": "sample string 4"
}

application/xml, text/xml

Sample: 
<ReversePaymentArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <BatchId>sample string 2</BatchId>
  <CustomerId>sample string 1</CustomerId>
  <ReferenceId>sample string 3</ReferenceId>
  <StatementDesc>sample string 4</StatementDesc>
</ReversePaymentArgs>

Response Information

Resource Description

ReversePaymentResult
NameDescriptionTypeAdditional information
ReversalBatchId

string

None.
ReversalResult

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ReversalBatchId": "sample string 1",
  "ReversalResult": "sample string 2"
}

application/xml, text/xml

Sample: 
<ReversePaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <ReversalBatchId>sample string 1</ReversalBatchId>
  <ReversalResult>sample string 2</ReversalResult>
</ReversePaymentResult>