POST api/Report/GetInventoryWorthReport

Request Information

URI Parameters

None.

Body Parameters

GetProductStockHistoryRequest
NameDescriptionTypeAdditional information
ProductID

integer

None.

ProductVariantID

integer

None.

OutletID

integer

None.

ToDate

date

None.

FromDate

date

None.

PageSize

integer

None.

PageNo

integer

None.

IsGetAll

boolean

None.

IsAllProduct

boolean

None.

DepartmentID

integer

None.

ClassificationID

integer

None.

Search

string

None.

CategoryID

integer

None.

SubCategoryID

integer

None.

ColumnName

string

None.

IsOrderBySearch

boolean

None.

IsColumnSearch

boolean

None.

IsOrderByAccending

boolean

None.

ResellerID

integer

None.

IsReseller

boolean

None.

RequestedUserID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ProductID": 1,
  "ProductVariantID": 2,
  "OutletID": 3,
  "ToDate": "2025-01-22T20:57:27.7360076-06:00",
  "FromDate": "2025-01-22T20:57:27.7360076-06:00",
  "PageSize": 6,
  "PageNo": 7,
  "IsGetAll": true,
  "IsAllProduct": true,
  "DepartmentID": 10,
  "ClassificationID": 11,
  "Search": "sample string 12",
  "CategoryID": 13,
  "SubCategoryID": 14,
  "ColumnName": "sample string 15",
  "IsOrderBySearch": true,
  "IsColumnSearch": true,
  "IsOrderByAccending": true,
  "ResellerID": 1,
  "IsReseller": true,
  "RequestedUserID": 1
}

application/xml, text/xml

Sample:
<GetProductStockHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Request">
  <RequestedUserID>1</RequestedUserID>
  <CategoryID>13</CategoryID>
  <ClassificationID>11</ClassificationID>
  <ColumnName>sample string 15</ColumnName>
  <DepartmentID>10</DepartmentID>
  <FromDate>2025-01-22T20:57:27.7360076-06:00</FromDate>
  <IsAllProduct>true</IsAllProduct>
  <IsColumnSearch>true</IsColumnSearch>
  <IsGetAll>true</IsGetAll>
  <IsOrderByAccending>true</IsOrderByAccending>
  <IsOrderBySearch>true</IsOrderBySearch>
  <IsReseller>true</IsReseller>
  <OutletID>3</OutletID>
  <PageNo>7</PageNo>
  <PageSize>6</PageSize>
  <ProductID>1</ProductID>
  <ProductVariantID>2</ProductVariantID>
  <ResellerID>1</ResellerID>
  <Search>sample string 12</Search>
  <SubCategoryID>14</SubCategoryID>
  <ToDate>2025-01-22T20:57:27.7360076-06:00</ToDate>
</GetProductStockHistoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InventoryWorthReportResponse
NameDescriptionTypeAdditional information
InventoryTotalCount

integer

None.

TotalInventoryWorth

decimal number

None.

InventoryDetails

Collection of InventoryDetailModel

None.

ResponseCode

integer

None.

ResponseText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "InventoryTotalCount": 1,
  "TotalInventoryWorth": 1.0,
  "InventoryDetails": [
    {
      "Product": "sample string 1",
      "ProductVariant": "sample string 2",
      "ProductImage": "sample string 3",
      "ProductModel": "sample string 4",
      "ReturnedStock": 1,
      "TotalStock": 1,
      "RemainingStock": 1,
      "HoldStock": 1,
      "TotalPurchasePrice": 1.0,
      "AveragePurchasePrice": 1.0,
      "ProductID": 1,
      "ProductVariantID": 1,
      "NetWorth": 1.0
    },
    {
      "Product": "sample string 1",
      "ProductVariant": "sample string 2",
      "ProductImage": "sample string 3",
      "ProductModel": "sample string 4",
      "ReturnedStock": 1,
      "TotalStock": 1,
      "RemainingStock": 1,
      "HoldStock": 1,
      "TotalPurchasePrice": 1.0,
      "AveragePurchasePrice": 1.0,
      "ProductID": 1,
      "ProductVariantID": 1,
      "NetWorth": 1.0
    }
  ],
  "ResponseCode": 2,
  "ResponseText": "sample string 3"
}

application/xml, text/xml

Sample:
<InventoryWorthReportResponse 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>
  <InventoryDetails>
    <InventoryDetailModel>
      <AveragePurchasePrice>1</AveragePurchasePrice>
      <HoldStock>1</HoldStock>
      <NetWorth>1</NetWorth>
      <Product>sample string 1</Product>
      <ProductID>1</ProductID>
      <ProductImage>sample string 3</ProductImage>
      <ProductModel>sample string 4</ProductModel>
      <ProductVariant>sample string 2</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <RemainingStock>1</RemainingStock>
      <ReturnedStock>1</ReturnedStock>
      <TotalPurchasePrice>1</TotalPurchasePrice>
      <TotalStock>1</TotalStock>
    </InventoryDetailModel>
    <InventoryDetailModel>
      <AveragePurchasePrice>1</AveragePurchasePrice>
      <HoldStock>1</HoldStock>
      <NetWorth>1</NetWorth>
      <Product>sample string 1</Product>
      <ProductID>1</ProductID>
      <ProductImage>sample string 3</ProductImage>
      <ProductModel>sample string 4</ProductModel>
      <ProductVariant>sample string 2</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <RemainingStock>1</RemainingStock>
      <ReturnedStock>1</ReturnedStock>
      <TotalPurchasePrice>1</TotalPurchasePrice>
      <TotalStock>1</TotalStock>
    </InventoryDetailModel>
  </InventoryDetails>
  <InventoryTotalCount>1</InventoryTotalCount>
  <TotalInventoryWorth>1</TotalInventoryWorth>
</InventoryWorthReportResponse>