POST api/ReversalApi/AmountReversal

Reversal using any amount.

Request Information

URI Parameters

None.

Body Parameters

Contains invoice identification and the reversal amount.

AmountReversal
NameDescriptionTypeAdditional information
Amount

Reversal amount

decimal number

None.

Description

Description of credit note

string

None.

Id

Voucher record id, must be present if Number is not present

integer

None.

Number

Voucher number, must be present if Id is not present

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Amount": 1.0,
  "Description": "sample string 2",
  "Id": 3,
  "Number": "sample string 4"
}

application/xml, text/xml

Sample:
<AmountReversal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models.Api">
  <Id>3</Id>
  <Number>sample string 4</Number>
  <Amount>1</Amount>
  <Description>sample string 2</Description>
</AmountReversal>

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

Response Information

Resource Description

Id of created credit note, 0 means it has failed.

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>