POST api/ReversalApi/ReversalLinesInformation

Get reversal information for position-wise reversal of invoices.

Request Information

URI Parameters

None.

Body Parameters

Voucher number or record id of invoice.

Name	Description	Type	Additional information
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:

{
  "Id": 1,
  "Number": "sample string 2"
}

application/xml, text/xml

Sample:

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

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

Response Information

Resource Description

Information needed for partial reversal.

ReversalLinesInformationContainer

Name	Description	Type	Additional information
VoucherLines	Voucher lines of requested voucher	Collection of CustomVoucherLine	None.
RevertedLines	Already reverted lines of the requested voucher	Collection of CustomVoucherLine	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.

Response Formats

application/json, text/json

Sample:

{
  "VoucherLines": [
    {
      "Id": 1,
      "ArticleNumber": "sample string 2",
      "Description": "sample string 3",
      "Quantity": 4.0,
      "VatCode": "sample string 5",
      "SinglePrice": 6.0,
      "DiscountPercent": 7.0,
      "LineAmount": 8.0,
      "Text": "sample string 9",
      "VoucherLineNumber": "sample string 10",
      "ReversalFlag": 0,
      "ReversalQuantity": 11.0
    },
    {
      "Id": 1,
      "ArticleNumber": "sample string 2",
      "Description": "sample string 3",
      "Quantity": 4.0,
      "VatCode": "sample string 5",
      "SinglePrice": 6.0,
      "DiscountPercent": 7.0,
      "LineAmount": 8.0,
      "Text": "sample string 9",
      "VoucherLineNumber": "sample string 10",
      "ReversalFlag": 0,
      "ReversalQuantity": 11.0
    }
  ],
  "RevertedLines": [
    {
      "Id": 1,
      "ArticleNumber": "sample string 2",
      "Description": "sample string 3",
      "Quantity": 4.0,
      "VatCode": "sample string 5",
      "SinglePrice": 6.0,
      "DiscountPercent": 7.0,
      "LineAmount": 8.0,
      "Text": "sample string 9",
      "VoucherLineNumber": "sample string 10",
      "ReversalFlag": 0,
      "ReversalQuantity": 11.0
    },
    {
      "Id": 1,
      "ArticleNumber": "sample string 2",
      "Description": "sample string 3",
      "Quantity": 4.0,
      "VatCode": "sample string 5",
      "SinglePrice": 6.0,
      "DiscountPercent": 7.0,
      "LineAmount": 8.0,
      "Text": "sample string 9",
      "VoucherLineNumber": "sample string 10",
      "ReversalFlag": 0,
      "ReversalQuantity": 11.0
    }
  ],
  "Id": 1,
  "Number": "sample string 2"
}

application/xml, text/xml

Sample:

<ReversalLinesInformationContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models.Api">
  <Id>1</Id>
  <Number>sample string 2</Number>
  <RevertedLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models">
    <d2p1:CustomVoucherLine>
      <d2p1:ArticleNumber>sample string 2</d2p1:ArticleNumber>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DiscountPercent>7</d2p1:DiscountPercent>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LineAmount>8</d2p1:LineAmount>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:ReversalFlag>None</d2p1:ReversalFlag>
      <d2p1:ReversalQuantity>11</d2p1:ReversalQuantity>
      <d2p1:SinglePrice>6</d2p1:SinglePrice>
      <d2p1:Text>sample string 9</d2p1:Text>
      <d2p1:VatCode>sample string 5</d2p1:VatCode>
      <d2p1:VoucherLineNumber>sample string 10</d2p1:VoucherLineNumber>
    </d2p1:CustomVoucherLine>
    <d2p1:CustomVoucherLine>
      <d2p1:ArticleNumber>sample string 2</d2p1:ArticleNumber>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DiscountPercent>7</d2p1:DiscountPercent>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LineAmount>8</d2p1:LineAmount>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:ReversalFlag>None</d2p1:ReversalFlag>
      <d2p1:ReversalQuantity>11</d2p1:ReversalQuantity>
      <d2p1:SinglePrice>6</d2p1:SinglePrice>
      <d2p1:Text>sample string 9</d2p1:Text>
      <d2p1:VatCode>sample string 5</d2p1:VatCode>
      <d2p1:VoucherLineNumber>sample string 10</d2p1:VoucherLineNumber>
    </d2p1:CustomVoucherLine>
  </RevertedLines>
  <VoucherLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models">
    <d2p1:CustomVoucherLine>
      <d2p1:ArticleNumber>sample string 2</d2p1:ArticleNumber>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DiscountPercent>7</d2p1:DiscountPercent>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LineAmount>8</d2p1:LineAmount>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:ReversalFlag>None</d2p1:ReversalFlag>
      <d2p1:ReversalQuantity>11</d2p1:ReversalQuantity>
      <d2p1:SinglePrice>6</d2p1:SinglePrice>
      <d2p1:Text>sample string 9</d2p1:Text>
      <d2p1:VatCode>sample string 5</d2p1:VatCode>
      <d2p1:VoucherLineNumber>sample string 10</d2p1:VoucherLineNumber>
    </d2p1:CustomVoucherLine>
    <d2p1:CustomVoucherLine>
      <d2p1:ArticleNumber>sample string 2</d2p1:ArticleNumber>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DiscountPercent>7</d2p1:DiscountPercent>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LineAmount>8</d2p1:LineAmount>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:ReversalFlag>None</d2p1:ReversalFlag>
      <d2p1:ReversalQuantity>11</d2p1:ReversalQuantity>
      <d2p1:SinglePrice>6</d2p1:SinglePrice>
      <d2p1:Text>sample string 9</d2p1:Text>
      <d2p1:VatCode>sample string 5</d2p1:VatCode>
      <d2p1:VoucherLineNumber>sample string 10</d2p1:VoucherLineNumber>
    </d2p1:CustomVoucherLine>
  </VoucherLines>
</ReversalLinesInformationContainer>