POST api/Purchase/Add

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
SuppierInvoiceNo	string	Required
Supplier	string	None.
PaymentMode	string	None.
dTotalPurchaseValue	decimal number	None.
dTotalPurchaseValueFC	decimal number	None.
dTotalPurchaseValueString	string	None.
dDiscountPercentage	decimal number	None.
dDiscountValue	decimal number	None.
dDiscountValueFC	decimal number	None.
dDiscountValueString	string	None.
dTotalPaidValue	decimal number	None.
dTotalPaidValueFC	decimal number	None.
dTotalPaidValueString	string	None.
PurchaseDate	date	None.
PurchaseDateString	string	None.
DueDate	date	None.
DueDateString	string	None.
sRemarks	string	None.
CreatedAt	date	None.
UpdatedAt	date	None.
CreatedByUserID	integer	None.
SupplierID	integer	Required
PaymentModeID	integer	None.
ReturnedTyped	integer	None.
IsReceived	boolean	None.
IsReturned	boolean	None.
isReturnVisible	string	None.
ExchangeRateID	integer	None.
CurrentExchangeRate	decimal number	None.
OutletID	integer	None.
Outlet	string	None.
OpenPurchaseID	integer	None.
ExchangeRate	string	None.
IsHoldPurchase	boolean	None.
PurchasesDetails	Collection of PurchaseDetailModel	None.
StockHistories	Collection of StockHistoryModel	None.
PurchaseTaxDetails	PurchaseTaxDetailModel	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "SuppierInvoiceNo": "sample string 2",
  "Supplier": "sample string 3",
  "PaymentMode": "sample string 4",
  "dTotalPurchaseValue": 1.0,
  "dTotalPurchaseValueFC": 1.0,
  "dTotalPurchaseValueString": "sample string 5",
  "dDiscountPercentage": 1.0,
  "dDiscountValue": 1.0,
  "dDiscountValueFC": 1.0,
  "dDiscountValueString": "sample string 6",
  "dTotalPaidValue": 1.0,
  "dTotalPaidValueFC": 1.0,
  "dTotalPaidValueString": "sample string 7",
  "PurchaseDate": "2026-07-28T08:34:04.7987467+02:00",
  "PurchaseDateString": "sample string 8",
  "DueDate": "2026-07-28T08:34:04.7987467+02:00",
  "DueDateString": "sample string 9",
  "sRemarks": "sample string 10",
  "CreatedAt": "2026-07-28T08:34:04.7987467+02:00",
  "UpdatedAt": "2026-07-28T08:34:04.7987467+02:00",
  "CreatedByUserID": 1,
  "SupplierID": 1,
  "PaymentModeID": 1,
  "ReturnedTyped": 1,
  "IsReceived": true,
  "IsReturned": true,
  "isReturnVisible": "sample string 11",
  "ExchangeRateID": 1,
  "CurrentExchangeRate": 1.0,
  "OutletID": 1,
  "Outlet": "sample string 12",
  "OpenPurchaseID": 1,
  "ExchangeRate": "sample string 13",
  "IsHoldPurchase": true,
  "PurchasesDetails": [
    {
      "ID": 1,
      "Product": "sample string 2",
      "Image": "sample string 3",
      "Description": "sample string 4",
      "ProductVariant": "sample string 5",
      "PurchaseID": 1,
      "ProductID": 1,
      "ProductVariantID": 1,
      "ProductUnitPrice": 6.0,
      "ProductUnitPriceString": "sample string 7",
      "OriginalQuantity": 1,
      "Quantity": 1,
      "dTotalAmount": 1.0,
      "dTotalAmountFC": 1.0,
      "dTotalAmountString": "sample string 8",
      "TaxAmount": 1.0,
      "TaxAmountFC": 1.0,
      "TaxAmountString": "sample string 9",
      "dTotalDiscount": 1.0,
      "dTotalDiscountFC": 1.0,
      "dTotalDiscountValue": 1.0,
      "dTotalDiscountValueFC": 1.0,
      "dTotalDiscountValueString": "sample string 10",
      "IsActive": true,
      "IsTrackableVisibility": "sample string 11",
      "ReturnedTyped": 1,
      "IsReturned": true,
      "ReturnedQuantity": 1,
      "isReturnProductChecked": true,
      "ProductPrice": 13.0,
      "ProductPriceString": "sample string 14",
      "BLabel": "sample string 15",
      "NonTrackableLocations": [
        {
          "NonTrackableProductLocationID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "PurchaseDetailID": 1,
          "LevelID": 1,
          "Quantity": 1,
          "Location": "sample string 2"
        },
        {
          "NonTrackableProductLocationID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "PurchaseDetailID": 1,
          "LevelID": 1,
          "Quantity": 1,
          "Location": "sample string 2"
        }
      ],
      "TrackableProductsPurchaseDetails": [
        {
          "ID": 1,
          "PurchaseDetailID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "Product": "sample string 2",
          "ProductVariant": "sample string 3",
          "TrackableCode": "sample string 4",
          "CreatedAt": "2026-07-28T08:34:04.7987467+02:00",
          "IsReturned": true,
          "IsReturnedItem": true
        },
        {
          "ID": 1,
          "PurchaseDetailID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "Product": "sample string 2",
          "ProductVariant": "sample string 3",
          "TrackableCode": "sample string 4",
          "CreatedAt": "2026-07-28T08:34:04.7987467+02:00",
          "IsReturned": true,
          "IsReturnedItem": true
        }
      ]
    },
    {
      "ID": 1,
      "Product": "sample string 2",
      "Image": "sample string 3",
      "Description": "sample string 4",
      "ProductVariant": "sample string 5",
      "PurchaseID": 1,
      "ProductID": 1,
      "ProductVariantID": 1,
      "ProductUnitPrice": 6.0,
      "ProductUnitPriceString": "sample string 7",
      "OriginalQuantity": 1,
      "Quantity": 1,
      "dTotalAmount": 1.0,
      "dTotalAmountFC": 1.0,
      "dTotalAmountString": "sample string 8",
      "TaxAmount": 1.0,
      "TaxAmountFC": 1.0,
      "TaxAmountString": "sample string 9",
      "dTotalDiscount": 1.0,
      "dTotalDiscountFC": 1.0,
      "dTotalDiscountValue": 1.0,
      "dTotalDiscountValueFC": 1.0,
      "dTotalDiscountValueString": "sample string 10",
      "IsActive": true,
      "IsTrackableVisibility": "sample string 11",
      "ReturnedTyped": 1,
      "IsReturned": true,
      "ReturnedQuantity": 1,
      "isReturnProductChecked": true,
      "ProductPrice": 13.0,
      "ProductPriceString": "sample string 14",
      "BLabel": "sample string 15",
      "NonTrackableLocations": [
        {
          "NonTrackableProductLocationID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "PurchaseDetailID": 1,
          "LevelID": 1,
          "Quantity": 1,
          "Location": "sample string 2"
        },
        {
          "NonTrackableProductLocationID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "PurchaseDetailID": 1,
          "LevelID": 1,
          "Quantity": 1,
          "Location": "sample string 2"
        }
      ],
      "TrackableProductsPurchaseDetails": [
        {
          "ID": 1,
          "PurchaseDetailID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "Product": "sample string 2",
          "ProductVariant": "sample string 3",
          "TrackableCode": "sample string 4",
          "CreatedAt": "2026-07-28T08:34:04.7987467+02:00",
          "IsReturned": true,
          "IsReturnedItem": true
        },
        {
          "ID": 1,
          "PurchaseDetailID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "Product": "sample string 2",
          "ProductVariant": "sample string 3",
          "TrackableCode": "sample string 4",
          "CreatedAt": "2026-07-28T08:34:04.7987467+02:00",
          "IsReturned": true,
          "IsReturnedItem": true
        }
      ]
    }
  ],
  "StockHistories": [
    {
      "ID": 1,
      "Product": "sample string 2",
      "ProductVariant": "sample string 3",
      "TotalStock": 1,
      "RemainingStock": 1,
      "HoldStock": 1,
      "SalePrice": 1.0,
      "PurchasePrice": 1.0,
      "SalePriceString": "sample string 4",
      "PurchasePriceString": "sample string 5",
      "ProductID": 1,
      "ProductVariantID": 1,
      "PurchaseID": 1,
      "PurchaseDate": "2026-07-28T08:34:04.7987467+02:00",
      "PurchaseDateString": "sample string 6",
      "CreateAt": "2026-07-28T08:34:04.7987467+02:00",
      "UpdatedAt": "2026-07-28T08:34:04.7987467+02:00",
      "IsActive": true,
      "By": "sample string 7"
    },
    {
      "ID": 1,
      "Product": "sample string 2",
      "ProductVariant": "sample string 3",
      "TotalStock": 1,
      "RemainingStock": 1,
      "HoldStock": 1,
      "SalePrice": 1.0,
      "PurchasePrice": 1.0,
      "SalePriceString": "sample string 4",
      "PurchasePriceString": "sample string 5",
      "ProductID": 1,
      "ProductVariantID": 1,
      "PurchaseID": 1,
      "PurchaseDate": "2026-07-28T08:34:04.7987467+02:00",
      "PurchaseDateString": "sample string 6",
      "CreateAt": "2026-07-28T08:34:04.7987467+02:00",
      "UpdatedAt": "2026-07-28T08:34:04.7987467+02:00",
      "IsActive": true,
      "By": "sample string 7"
    }
  ],
  "PurchaseTaxDetails": {
    "ID": 1,
    "PurchaseID": 2,
    "dTotalTaxAmount": 1.0,
    "IsWithHolding": true,
    "CreatedAt": "2026-07-28T08:34:04.7987467+02:00"
  }
}

application/xml, text/xml

Sample:

<PurchaseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <CreatedAt>2026-07-28T08:34:04.7987467+02:00</CreatedAt>
  <CreatedByUserID>1</CreatedByUserID>
  <CurrentExchangeRate>1</CurrentExchangeRate>
  <DueDate>2026-07-28T08:34:04.7987467+02:00</DueDate>
  <DueDateString>sample string 9</DueDateString>
  <ExchangeRate>sample string 13</ExchangeRate>
  <ExchangeRateID>1</ExchangeRateID>
  <ID>1</ID>
  <IsHoldPurchase>true</IsHoldPurchase>
  <IsReceived>true</IsReceived>
  <IsReturned>true</IsReturned>
  <OpenPurchaseID>1</OpenPurchaseID>
  <Outlet>sample string 12</Outlet>
  <OutletID>1</OutletID>
  <PaymentMode>sample string 4</PaymentMode>
  <PaymentModeID>1</PaymentModeID>
  <PurchaseDate>2026-07-28T08:34:04.7987467+02:00</PurchaseDate>
  <PurchaseDateString>sample string 8</PurchaseDateString>
  <PurchaseTaxDetails>
    <CreatedAt>2026-07-28T08:34:04.7987467+02:00</CreatedAt>
    <ID>1</ID>
    <IsWithHolding>true</IsWithHolding>
    <PurchaseID>2</PurchaseID>
    <dTotalTaxAmount>1</dTotalTaxAmount>
  </PurchaseTaxDetails>
  <PurchasesDetails>
    <PurchaseDetailModel>
      <BLabel>sample string 15</BLabel>
      <Description>sample string 4</Description>
      <ID>1</ID>
      <Image>sample string 3</Image>
      <IsActive>true</IsActive>
      <IsReturned>true</IsReturned>
      <IsTrackableVisibility>sample string 11</IsTrackableVisibility>
      <NonTrackableLocations>
        <NonTrackableLocationModel>
          <LevelID>1</LevelID>
          <Location>sample string 2</Location>
          <NonTrackableProductLocationID>1</NonTrackableProductLocationID>
          <ProductID>1</ProductID>
          <ProductVariantID>1</ProductVariantID>
          <PurchaseDetailID>1</PurchaseDetailID>
          <Quantity>1</Quantity>
        </NonTrackableLocationModel>
        <NonTrackableLocationModel>
          <LevelID>1</LevelID>
          <Location>sample string 2</Location>
          <NonTrackableProductLocationID>1</NonTrackableProductLocationID>
          <ProductID>1</ProductID>
          <ProductVariantID>1</ProductVariantID>
          <PurchaseDetailID>1</PurchaseDetailID>
          <Quantity>1</Quantity>
        </NonTrackableLocationModel>
      </NonTrackableLocations>
      <OriginalQuantity>1</OriginalQuantity>
      <Product>sample string 2</Product>
      <ProductID>1</ProductID>
      <ProductPrice>13</ProductPrice>
      <ProductPriceString>sample string 14</ProductPriceString>
      <ProductUnitPrice>6</ProductUnitPrice>
      <ProductUnitPriceString>sample string 7</ProductUnitPriceString>
      <ProductVariant>sample string 5</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <PurchaseID>1</PurchaseID>
      <Quantity>1</Quantity>
      <ReturnedQuantity>1</ReturnedQuantity>
      <ReturnedTyped>1</ReturnedTyped>
      <TaxAmount>1</TaxAmount>
      <TaxAmountFC>1</TaxAmountFC>
      <TaxAmountString>sample string 9</TaxAmountString>
      <TrackableProductsPurchaseDetails>
        <TrackableProductsPurchaseDetailModel>
          <CreatedAt>2026-07-28T08:34:04.7987467+02:00</CreatedAt>
          <ID>1</ID>
          <IsReturned>true</IsReturned>
          <IsReturnedItem>true</IsReturnedItem>
          <Product>sample string 2</Product>
          <ProductID>1</ProductID>
          <ProductVariant>sample string 3</ProductVariant>
          <ProductVariantID>1</ProductVariantID>
          <PurchaseDetailID>1</PurchaseDetailID>
          <TrackableCode>sample string 4</TrackableCode>
        </TrackableProductsPurchaseDetailModel>
        <TrackableProductsPurchaseDetailModel>
          <CreatedAt>2026-07-28T08:34:04.7987467+02:00</CreatedAt>
          <ID>1</ID>
          <IsReturned>true</IsReturned>
          <IsReturnedItem>true</IsReturnedItem>
          <Product>sample string 2</Product>
          <ProductID>1</ProductID>
          <ProductVariant>sample string 3</ProductVariant>
          <ProductVariantID>1</ProductVariantID>
          <PurchaseDetailID>1</PurchaseDetailID>
          <TrackableCode>sample string 4</TrackableCode>
        </TrackableProductsPurchaseDetailModel>
      </TrackableProductsPurchaseDetails>
      <dTotalAmount>1</dTotalAmount>
      <dTotalAmountFC>1</dTotalAmountFC>
      <dTotalAmountString>sample string 8</dTotalAmountString>
      <dTotalDiscount>1</dTotalDiscount>
      <dTotalDiscountFC>1</dTotalDiscountFC>
      <dTotalDiscountValue>1</dTotalDiscountValue>
      <dTotalDiscountValueFC>1</dTotalDiscountValueFC>
      <dTotalDiscountValueString>sample string 10</dTotalDiscountValueString>
      <isReturnProductChecked>true</isReturnProductChecked>
    </PurchaseDetailModel>
    <PurchaseDetailModel>
      <BLabel>sample string 15</BLabel>
      <Description>sample string 4</Description>
      <ID>1</ID>
      <Image>sample string 3</Image>
      <IsActive>true</IsActive>
      <IsReturned>true</IsReturned>
      <IsTrackableVisibility>sample string 11</IsTrackableVisibility>
      <NonTrackableLocations>
        <NonTrackableLocationModel>
          <LevelID>1</LevelID>
          <Location>sample string 2</Location>
          <NonTrackableProductLocationID>1</NonTrackableProductLocationID>
          <ProductID>1</ProductID>
          <ProductVariantID>1</ProductVariantID>
          <PurchaseDetailID>1</PurchaseDetailID>
          <Quantity>1</Quantity>
        </NonTrackableLocationModel>
        <NonTrackableLocationModel>
          <LevelID>1</LevelID>
          <Location>sample string 2</Location>
          <NonTrackableProductLocationID>1</NonTrackableProductLocationID>
          <ProductID>1</ProductID>
          <ProductVariantID>1</ProductVariantID>
          <PurchaseDetailID>1</PurchaseDetailID>
          <Quantity>1</Quantity>
        </NonTrackableLocationModel>
      </NonTrackableLocations>
      <OriginalQuantity>1</OriginalQuantity>
      <Product>sample string 2</Product>
      <ProductID>1</ProductID>
      <ProductPrice>13</ProductPrice>
      <ProductPriceString>sample string 14</ProductPriceString>
      <ProductUnitPrice>6</ProductUnitPrice>
      <ProductUnitPriceString>sample string 7</ProductUnitPriceString>
      <ProductVariant>sample string 5</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <PurchaseID>1</PurchaseID>
      <Quantity>1</Quantity>
      <ReturnedQuantity>1</ReturnedQuantity>
      <ReturnedTyped>1</ReturnedTyped>
      <TaxAmount>1</TaxAmount>
      <TaxAmountFC>1</TaxAmountFC>
      <TaxAmountString>sample string 9</TaxAmountString>
      <TrackableProductsPurchaseDetails>
        <TrackableProductsPurchaseDetailModel>
          <CreatedAt>2026-07-28T08:34:04.7987467+02:00</CreatedAt>
          <ID>1</ID>
          <IsReturned>true</IsReturned>
          <IsReturnedItem>true</IsReturnedItem>
          <Product>sample string 2</Product>
          <ProductID>1</ProductID>
          <ProductVariant>sample string 3</ProductVariant>
          <ProductVariantID>1</ProductVariantID>
          <PurchaseDetailID>1</PurchaseDetailID>
          <TrackableCode>sample string 4</TrackableCode>
        </TrackableProductsPurchaseDetailModel>
        <TrackableProductsPurchaseDetailModel>
          <CreatedAt>2026-07-28T08:34:04.7987467+02:00</CreatedAt>
          <ID>1</ID>
          <IsReturned>true</IsReturned>
          <IsReturnedItem>true</IsReturnedItem>
          <Product>sample string 2</Product>
          <ProductID>1</ProductID>
          <ProductVariant>sample string 3</ProductVariant>
          <ProductVariantID>1</ProductVariantID>
          <PurchaseDetailID>1</PurchaseDetailID>
          <TrackableCode>sample string 4</TrackableCode>
        </TrackableProductsPurchaseDetailModel>
      </TrackableProductsPurchaseDetails>
      <dTotalAmount>1</dTotalAmount>
      <dTotalAmountFC>1</dTotalAmountFC>
      <dTotalAmountString>sample string 8</dTotalAmountString>
      <dTotalDiscount>1</dTotalDiscount>
      <dTotalDiscountFC>1</dTotalDiscountFC>
      <dTotalDiscountValue>1</dTotalDiscountValue>
      <dTotalDiscountValueFC>1</dTotalDiscountValueFC>
      <dTotalDiscountValueString>sample string 10</dTotalDiscountValueString>
      <isReturnProductChecked>true</isReturnProductChecked>
    </PurchaseDetailModel>
  </PurchasesDetails>
  <ReturnedTyped>1</ReturnedTyped>
  <StockHistories>
    <StockHistoryModel>
      <By>sample string 7</By>
      <CreateAt>2026-07-28T08:34:04.7987467+02:00</CreateAt>
      <HoldStock>1</HoldStock>
      <ID>1</ID>
      <IsActive>true</IsActive>
      <Product>sample string 2</Product>
      <ProductID>1</ProductID>
      <ProductVariant>sample string 3</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <PurchaseDate>2026-07-28T08:34:04.7987467+02:00</PurchaseDate>
      <PurchaseDateString>sample string 6</PurchaseDateString>
      <PurchaseID>1</PurchaseID>
      <PurchasePrice>1</PurchasePrice>
      <PurchasePriceString>sample string 5</PurchasePriceString>
      <RemainingStock>1</RemainingStock>
      <SalePrice>1</SalePrice>
      <SalePriceString>sample string 4</SalePriceString>
      <TotalStock>1</TotalStock>
      <UpdatedAt>2026-07-28T08:34:04.7987467+02:00</UpdatedAt>
    </StockHistoryModel>
    <StockHistoryModel>
      <By>sample string 7</By>
      <CreateAt>2026-07-28T08:34:04.7987467+02:00</CreateAt>
      <HoldStock>1</HoldStock>
      <ID>1</ID>
      <IsActive>true</IsActive>
      <Product>sample string 2</Product>
      <ProductID>1</ProductID>
      <ProductVariant>sample string 3</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <PurchaseDate>2026-07-28T08:34:04.7987467+02:00</PurchaseDate>
      <PurchaseDateString>sample string 6</PurchaseDateString>
      <PurchaseID>1</PurchaseID>
      <PurchasePrice>1</PurchasePrice>
      <PurchasePriceString>sample string 5</PurchasePriceString>
      <RemainingStock>1</RemainingStock>
      <SalePrice>1</SalePrice>
      <SalePriceString>sample string 4</SalePriceString>
      <TotalStock>1</TotalStock>
      <UpdatedAt>2026-07-28T08:34:04.7987467+02:00</UpdatedAt>
    </StockHistoryModel>
  </StockHistories>
  <SuppierInvoiceNo>sample string 2</SuppierInvoiceNo>
  <Supplier>sample string 3</Supplier>
  <SupplierID>1</SupplierID>
  <UpdatedAt>2026-07-28T08:34:04.7987467+02:00</UpdatedAt>
  <dDiscountPercentage>1</dDiscountPercentage>
  <dDiscountValue>1</dDiscountValue>
  <dDiscountValueFC>1</dDiscountValueFC>
  <dDiscountValueString>sample string 6</dDiscountValueString>
  <dTotalPaidValue>1</dTotalPaidValue>
  <dTotalPaidValueFC>1</dTotalPaidValueFC>
  <dTotalPaidValueString>sample string 7</dTotalPaidValueString>
  <dTotalPurchaseValue>1</dTotalPurchaseValue>
  <dTotalPurchaseValueFC>1</dTotalPurchaseValueFC>
  <dTotalPurchaseValueString>sample string 5</dTotalPurchaseValueString>
  <isReturnVisible>sample string 11</isReturnVisible>
  <sRemarks>sample string 10</sRemarks>
</PurchaseModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PurchaseResponse

Name	Type	Additional information
PurchaseID	integer	None.
ResponseCode	integer	None.
ResponseText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PurchaseID": 1,
  "ResponseCode": 2,
  "ResponseText": "sample string 3"
}

application/xml, text/xml

Sample:

<PurchaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Response">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">2</ResponseCode>
  <ResponseText xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">sample string 3</ResponseText>
  <PurchaseID>1</PurchaseID>
</PurchaseResponse>