POST api/Purchase/InsertPurchaseReturn?isOpen={isOpen}&userId={userId}

Request Information

URI Parameters

Name	Description	Type	Additional information
isOpen		boolean	Default value is False
userId		integer	Default value is 0

Body Parameters

PurchaseReturnModel

Name	Type	Additional information
PurReturnId	integer	None.
PurchaseId	integer	None.
VendorId	string	None.
ReturnDate	date	None.
Disc2Ratio	decimal number	None.
FTaxRatio	decimal number	None.
SpecialDiscount	decimal number	None.
InvOfferDiscount	decimal number	None.
InvOfferSTax	decimal number	None.
InvOfferFTax	decimal number	None.
ReceivedAmount	decimal number	None.
PreviousCredit	decimal number	None.
Narration	string	None.
IsPosted	boolean	None.
IsPosted2	boolean	None.
IsPosted3	boolean	None.
IsPosted4	boolean	None.
OfficeID	integer	None.
NetValue	decimal number	None.
UserID	integer	None.
AccountNo	string	None.
IsFinalized	boolean	None.
BillNo	string	None.
IDOffice	integer	None.
PurchaseDate	date	None.
PartyName	string	None.
ListBody	Collection of PurchaseReturnBody	None.

Request Formats

application/json, text/json

Sample:

{
  "PurReturnId": 1,
  "PurchaseId": 2,
  "VendorId": "sample string 3",
  "ReturnDate": "2025-12-16T08:18:10.0015307+05:00",
  "Disc2Ratio": 5.0,
  "FTaxRatio": 6.0,
  "SpecialDiscount": 7.0,
  "InvOfferDiscount": 8.0,
  "InvOfferSTax": 9.0,
  "InvOfferFTax": 10.0,
  "ReceivedAmount": 11.0,
  "PreviousCredit": 12.0,
  "Narration": "sample string 13",
  "IsPosted": true,
  "IsPosted2": true,
  "IsPosted3": true,
  "IsPosted4": true,
  "OfficeID": 18,
  "NetValue": 19.0,
  "UserID": 20,
  "AccountNo": "sample string 21",
  "IsFinalized": true,
  "BillNo": "sample string 22",
  "IDOffice": 23,
  "PurchaseDate": "2025-12-16T08:18:10.0171224+05:00",
  "PartyName": "sample string 25",
  "ListBody": [
    {
      "PurReturnId": 1,
      "ProductId": "sample string 2",
      "PackingId": 3,
      "Multiplier": 4.0,
      "QtyPack": 5,
      "QtyLose": 6,
      "BnsLose": 7,
      "PricePack": 8.0,
      "DiscRatio": 9.0,
      "DiscValPack": 10.0,
      "DiscValLose": 11.0,
      "OfferDiscount": 12.0,
      "STaxRatio": 13.0,
      "STaxValPack": 14.0,
      "IsValueB4Ratio": true,
      "IsSTaxOnBns": true,
      "IsFTaxExempted": true,
      "TTLValue": 18.0,
      "TTLSTax": 19.0,
      "TTLFTax": 20.0,
      "ExtraSTaxBns": 21.0,
      "ExtraFTaxBns": 22.0,
      "PerUnitCostLose": 23.0,
      "IsFreeProduct": true,
      "IsFinalized": true,
      "ThanQty": 25,
      "Meters": 26.0
    },
    {
      "PurReturnId": 1,
      "ProductId": "sample string 2",
      "PackingId": 3,
      "Multiplier": 4.0,
      "QtyPack": 5,
      "QtyLose": 6,
      "BnsLose": 7,
      "PricePack": 8.0,
      "DiscRatio": 9.0,
      "DiscValPack": 10.0,
      "DiscValLose": 11.0,
      "OfferDiscount": 12.0,
      "STaxRatio": 13.0,
      "STaxValPack": 14.0,
      "IsValueB4Ratio": true,
      "IsSTaxOnBns": true,
      "IsFTaxExempted": true,
      "TTLValue": 18.0,
      "TTLSTax": 19.0,
      "TTLFTax": 20.0,
      "ExtraSTaxBns": 21.0,
      "ExtraFTaxBns": 22.0,
      "PerUnitCostLose": 23.0,
      "IsFreeProduct": true,
      "IsFinalized": true,
      "ThanQty": 25,
      "Meters": 26.0
    }
  ]
}

application/xml, text/xml

Sample:

<PurchaseReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ultrabiz_ERP_API.Models">
  <AccountNo>sample string 21</AccountNo>
  <BillNo>sample string 22</BillNo>
  <Disc2Ratio>5</Disc2Ratio>
  <FTaxRatio>6</FTaxRatio>
  <IDOffice>23</IDOffice>
  <InvOfferDiscount>8</InvOfferDiscount>
  <InvOfferFTax>10</InvOfferFTax>
  <InvOfferSTax>9</InvOfferSTax>
  <IsFinalized>true</IsFinalized>
  <IsPosted>true</IsPosted>
  <IsPosted2>true</IsPosted2>
  <IsPosted3>true</IsPosted3>
  <IsPosted4>true</IsPosted4>
  <ListBody>
    <PurchaseReturnBody>
      <BnsLose>7</BnsLose>
      <DiscRatio>9</DiscRatio>
      <DiscValLose>11</DiscValLose>
      <DiscValPack>10</DiscValPack>
      <ExtraFTaxBns>22</ExtraFTaxBns>
      <ExtraSTaxBns>21</ExtraSTaxBns>
      <IsFTaxExempted>true</IsFTaxExempted>
      <IsFinalized>true</IsFinalized>
      <IsFreeProduct>true</IsFreeProduct>
      <IsSTaxOnBns>true</IsSTaxOnBns>
      <IsValueB4Ratio>true</IsValueB4Ratio>
      <Meters>26</Meters>
      <Multiplier>4</Multiplier>
      <OfferDiscount>12</OfferDiscount>
      <PackingId>3</PackingId>
      <PerUnitCostLose>23</PerUnitCostLose>
      <PricePack>8</PricePack>
      <ProductId>sample string 2</ProductId>
      <PurReturnId>1</PurReturnId>
      <QtyLose>6</QtyLose>
      <QtyPack>5</QtyPack>
      <STaxRatio>13</STaxRatio>
      <STaxValPack>14</STaxValPack>
      <TTLFTax>20</TTLFTax>
      <TTLSTax>19</TTLSTax>
      <TTLValue>18</TTLValue>
      <ThanQty>25</ThanQty>
    </PurchaseReturnBody>
    <PurchaseReturnBody>
      <BnsLose>7</BnsLose>
      <DiscRatio>9</DiscRatio>
      <DiscValLose>11</DiscValLose>
      <DiscValPack>10</DiscValPack>
      <ExtraFTaxBns>22</ExtraFTaxBns>
      <ExtraSTaxBns>21</ExtraSTaxBns>
      <IsFTaxExempted>true</IsFTaxExempted>
      <IsFinalized>true</IsFinalized>
      <IsFreeProduct>true</IsFreeProduct>
      <IsSTaxOnBns>true</IsSTaxOnBns>
      <IsValueB4Ratio>true</IsValueB4Ratio>
      <Meters>26</Meters>
      <Multiplier>4</Multiplier>
      <OfferDiscount>12</OfferDiscount>
      <PackingId>3</PackingId>
      <PerUnitCostLose>23</PerUnitCostLose>
      <PricePack>8</PricePack>
      <ProductId>sample string 2</ProductId>
      <PurReturnId>1</PurReturnId>
      <QtyLose>6</QtyLose>
      <QtyPack>5</QtyPack>
      <STaxRatio>13</STaxRatio>
      <STaxValPack>14</STaxValPack>
      <TTLFTax>20</TTLFTax>
      <TTLSTax>19</TTLSTax>
      <TTLValue>18</TTLValue>
      <ThanQty>25</ThanQty>
    </PurchaseReturnBody>
  </ListBody>
  <Narration>sample string 13</Narration>
  <NetValue>19</NetValue>
  <OfficeID>18</OfficeID>
  <PartyName>sample string 25</PartyName>
  <PreviousCredit>12</PreviousCredit>
  <PurReturnId>1</PurReturnId>
  <PurchaseDate>2025-12-16T08:18:10.0171224+05:00</PurchaseDate>
  <PurchaseId>2</PurchaseId>
  <ReceivedAmount>11</ReceivedAmount>
  <ReturnDate>2025-12-16T08:18:10.0015307+05:00</ReturnDate>
  <SpecialDiscount>7</SpecialDiscount>
  <UserID>20</UserID>
  <VendorId>sample string 3</VendorId>
</PurchaseReturnModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.