GET StockPeriods/v1/GetStockPeriods?SiteID={SiteID}&StartDateFromUtc={StartDateFromUtc}&EndDateToUtc={EndDateToUtc}

Returns the stock period info for a given site.

Request Information

URI Parameters

Name	Type	Description	Additional information
SiteID	integer	ID of the site you want the stock periods for
StartDateFromUtc	date	Optional: used to refine the search range of the stock peroids	None.
EndDateToUtc	date	Optional: used to refine the search range of the stock peroids	None.

Body Parameters

None.

Response Information

Resource Description

Collection of StockPeriodRowDto

Name	Type	Additional information
StockPeriodID	integer	None.
Name	string	None.
StartDateUtc	date	None.
EndDateUtc	date	None.
Stocktakes	integer	None.
Complete	boolean	None.
LastDateTimeCompletedUtc	date	None.
LastCompletedBy	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "StockPeriodID": 1,
    "Name": "sample string 2",
    "StartDateUtc": "2024-11-21T06:38:33.9483991+00:00",
    "EndDateUtc": "2024-11-21T06:38:33.9483991+00:00",
    "Stocktakes": 5,
    "Complete": true,
    "LastDateTimeCompletedUtc": "2024-11-21T06:38:33.9483991+00:00",
    "LastCompletedBy": "sample string 7"
  },
  {
    "StockPeriodID": 1,
    "Name": "sample string 2",
    "StartDateUtc": "2024-11-21T06:38:33.9483991+00:00",
    "EndDateUtc": "2024-11-21T06:38:33.9483991+00:00",
    "Stocktakes": 5,
    "Complete": true,
    "LastDateTimeCompletedUtc": "2024-11-21T06:38:33.9483991+00:00",
    "LastCompletedBy": "sample string 7"
  }
]

application/xml, text/xml

Sample:

<ArrayOfStockPeriodRowDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.StockPeriods.Dto">
  <StockPeriodRowDto>
    <Complete>true</Complete>
    <EndDateUtc>2024-11-21T06:38:33.9483991+00:00</EndDateUtc>
    <LastCompletedBy>sample string 7</LastCompletedBy>
    <LastDateTimeCompletedUtc>2024-11-21T06:38:33.9483991+00:00</LastDateTimeCompletedUtc>
    <Name>sample string 2</Name>
    <StartDateUtc>2024-11-21T06:38:33.9483991+00:00</StartDateUtc>
    <StockPeriodID>1</StockPeriodID>
    <Stocktakes>5</Stocktakes>
  </StockPeriodRowDto>
  <StockPeriodRowDto>
    <Complete>true</Complete>
    <EndDateUtc>2024-11-21T06:38:33.9483991+00:00</EndDateUtc>
    <LastCompletedBy>sample string 7</LastCompletedBy>
    <LastDateTimeCompletedUtc>2024-11-21T06:38:33.9483991+00:00</LastDateTimeCompletedUtc>
    <Name>sample string 2</Name>
    <StartDateUtc>2024-11-21T06:38:33.9483991+00:00</StartDateUtc>
    <StockPeriodID>1</StockPeriodID>
    <Stocktakes>5</Stocktakes>
  </StockPeriodRowDto>
</ArrayOfStockPeriodRowDto>