GET Reporting/v1/Stock/GetStockPeriodItemsReport?SiteID={SiteID}&StockPeriodID={StockPeriodID}&ItemName={ItemName}&StocktakeCategoryID={StocktakeCategoryID}&ProductTypeID={ProductTypeID}&ProductGroupID={ProductGroupID}&ProductID={ProductID}

Gets the Stock Period Items report data for given Stock Period ID.

Request Information

URI Parameters

Name	Type	Description	Additional information
SiteID	integer	SiteID which the report will be run on	None.
StockPeriodID	integer	StockPeriodID which is t he report will be run on	None.
ItemName	string	Required: StockPeriodID which the report will be run on	None.
StocktakeCategoryID	integer	Optional: Item Name filter on the report	None.
ProductTypeID	integer	Optional: StocktakeCategoryID filter on the report	None.
ProductGroupID	integer	Optional: ProductGroup filter on the report	None.
ProductID	integer	Optional: ProductID filter on the report	None.

Body Parameters

ReportingStockPeriodReportRequestCommand

Name	Type	Description	Additional information
SiteID	integer	SiteID which the report will be run on	None.
StockPeriodID	integer	StockPeriodID which is t he report will be run on	None.
ItemName	string	Required: StockPeriodID which the report will be run on	None.
StocktakeCategoryID	integer	Optional: Item Name filter on the report	None.
ProductTypeID	integer	Optional: StocktakeCategoryID filter on the report	None.
ProductGroupID	integer	Optional: ProductGroup filter on the report	None.
ProductID	integer	Optional: ProductID filter on the report	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteID": 1,
  "StockPeriodID": 2,
  "ItemName": "sample string 3",
  "StocktakeCategoryID": 1,
  "ProductTypeID": 1,
  "ProductGroupID": 1,
  "ProductID": 1
}

application/xml, text/xml

Sample:

<ReportingStockPeriodReportRequestCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.App.Models">
  <ItemName>sample string 3</ItemName>
  <ProductGroupID>1</ProductGroupID>
  <ProductID>1</ProductID>
  <ProductTypeID>1</ProductTypeID>
  <SiteID>1</SiteID>
  <StockPeriodID>2</StockPeriodID>
  <StocktakeCategoryID>1</StocktakeCategoryID>
</ReportingStockPeriodReportRequestCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of StockPeriodItemExportDto

Name	Type	Additional information
Item	string	None.
ProductType	string	None.
ProductGroup	string	None.
StocktakeCategory	string	None.
Unit	string	None.
Allowance	decimal number	None.
TargetGPPercentage	decimal number	None.
OpeningCostPrice	decimal number	None.
ClosingCostPrice	decimal number	None.
OpeningQty	decimal number	None.
ExpClosingQty	decimal number	None.
ClosingQty	decimal number	None.
DaysOfStockRemaining	decimal number	None.
Rebate	decimal number	None.
QtySold	decimal number	None.
QtyUsed	decimal number	None.
QtyAutoUsed	decimal number	None.
QtyProduced	decimal number	None.
QtyShipped	decimal number	None.
QtyDelivered	decimal number	None.
QtyCredited	decimal number	None.
QtyWasted	decimal number	None.
QtyInbound	decimal number	None.
QtyOutbound	decimal number	None.
NetSales	decimal number	None.
ExpNetSales	decimal number	None.
NetCostOfSales	decimal number	None.
NetCostOfWastage	decimal number	None.
NetCostOfAutoUsage	decimal number	None.
NetCreditSubtotal	decimal number	None.
NetStockVarianceValue	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Item": "sample string 1",
    "ProductType": "sample string 2",
    "ProductGroup": "sample string 3",
    "StocktakeCategory": "sample string 4",
    "Unit": "sample string 5",
    "Allowance": 6.0,
    "TargetGPPercentage": 7.0,
    "OpeningCostPrice": 8.0,
    "ClosingCostPrice": 9.0,
    "OpeningQty": 10.0,
    "ExpClosingQty": 11.0,
    "ClosingQty": 12.0,
    "DaysOfStockRemaining": 13.0,
    "Rebate": 14.0,
    "QtySold": 15.0,
    "QtyUsed": 16.0,
    "QtyAutoUsed": 17.0,
    "QtyProduced": 18.0,
    "QtyShipped": 19.0,
    "QtyDelivered": 20.0,
    "QtyCredited": 21.0,
    "QtyWasted": 22.0,
    "QtyInbound": 23.0,
    "QtyOutbound": 24.0,
    "NetSales": 25.0,
    "ExpNetSales": 26.0,
    "NetCostOfSales": 27.0,
    "NetCostOfWastage": 28.0,
    "NetCostOfAutoUsage": 29.0,
    "NetCreditSubtotal": 30.0,
    "NetStockVarianceValue": 31.0
  },
  {
    "Item": "sample string 1",
    "ProductType": "sample string 2",
    "ProductGroup": "sample string 3",
    "StocktakeCategory": "sample string 4",
    "Unit": "sample string 5",
    "Allowance": 6.0,
    "TargetGPPercentage": 7.0,
    "OpeningCostPrice": 8.0,
    "ClosingCostPrice": 9.0,
    "OpeningQty": 10.0,
    "ExpClosingQty": 11.0,
    "ClosingQty": 12.0,
    "DaysOfStockRemaining": 13.0,
    "Rebate": 14.0,
    "QtySold": 15.0,
    "QtyUsed": 16.0,
    "QtyAutoUsed": 17.0,
    "QtyProduced": 18.0,
    "QtyShipped": 19.0,
    "QtyDelivered": 20.0,
    "QtyCredited": 21.0,
    "QtyWasted": 22.0,
    "QtyInbound": 23.0,
    "QtyOutbound": 24.0,
    "NetSales": 25.0,
    "ExpNetSales": 26.0,
    "NetCostOfSales": 27.0,
    "NetCostOfWastage": 28.0,
    "NetCostOfAutoUsage": 29.0,
    "NetCreditSubtotal": 30.0,
    "NetStockVarianceValue": 31.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfStockPeriodItemExportDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.StockPeriods.Dto">
  <StockPeriodItemExportDto>
    <Allowance>6</Allowance>
    <ClosingCostPrice>9</ClosingCostPrice>
    <ClosingQty>12</ClosingQty>
    <DaysOfStockRemaining>13</DaysOfStockRemaining>
    <ExpClosingQty>11</ExpClosingQty>
    <ExpNetSales>26</ExpNetSales>
    <Item>sample string 1</Item>
    <NetCostOfAutoUsage>29</NetCostOfAutoUsage>
    <NetCostOfSales>27</NetCostOfSales>
    <NetCostOfWastage>28</NetCostOfWastage>
    <NetCreditSubtotal>30</NetCreditSubtotal>
    <NetSales>25</NetSales>
    <NetStockVarianceValue>31</NetStockVarianceValue>
    <OpeningCostPrice>8</OpeningCostPrice>
    <OpeningQty>10</OpeningQty>
    <ProductGroup>sample string 3</ProductGroup>
    <ProductType>sample string 2</ProductType>
    <QtyAutoUsed>17</QtyAutoUsed>
    <QtyCredited>21</QtyCredited>
    <QtyDelivered>20</QtyDelivered>
    <QtyInbound>23</QtyInbound>
    <QtyOutbound>24</QtyOutbound>
    <QtyProduced>18</QtyProduced>
    <QtyShipped>19</QtyShipped>
    <QtySold>15</QtySold>
    <QtyUsed>16</QtyUsed>
    <QtyWasted>22</QtyWasted>
    <Rebate>14</Rebate>
    <StocktakeCategory>sample string 4</StocktakeCategory>
    <TargetGPPercentage>7</TargetGPPercentage>
    <Unit>sample string 5</Unit>
  </StockPeriodItemExportDto>
  <StockPeriodItemExportDto>
    <Allowance>6</Allowance>
    <ClosingCostPrice>9</ClosingCostPrice>
    <ClosingQty>12</ClosingQty>
    <DaysOfStockRemaining>13</DaysOfStockRemaining>
    <ExpClosingQty>11</ExpClosingQty>
    <ExpNetSales>26</ExpNetSales>
    <Item>sample string 1</Item>
    <NetCostOfAutoUsage>29</NetCostOfAutoUsage>
    <NetCostOfSales>27</NetCostOfSales>
    <NetCostOfWastage>28</NetCostOfWastage>
    <NetCreditSubtotal>30</NetCreditSubtotal>
    <NetSales>25</NetSales>
    <NetStockVarianceValue>31</NetStockVarianceValue>
    <OpeningCostPrice>8</OpeningCostPrice>
    <OpeningQty>10</OpeningQty>
    <ProductGroup>sample string 3</ProductGroup>
    <ProductType>sample string 2</ProductType>
    <QtyAutoUsed>17</QtyAutoUsed>
    <QtyCredited>21</QtyCredited>
    <QtyDelivered>20</QtyDelivered>
    <QtyInbound>23</QtyInbound>
    <QtyOutbound>24</QtyOutbound>
    <QtyProduced>18</QtyProduced>
    <QtyShipped>19</QtyShipped>
    <QtySold>15</QtySold>
    <QtyUsed>16</QtyUsed>
    <QtyWasted>22</QtyWasted>
    <Rebate>14</Rebate>
    <StocktakeCategory>sample string 4</StocktakeCategory>
    <TargetGPPercentage>7</TargetGPPercentage>
    <Unit>sample string 5</Unit>
  </StockPeriodItemExportDto>
</ArrayOfStockPeriodItemExportDto>