GET a/GrossProfitOverview/GetOverview?start={start}&end={end}&interval={interval}

Get the data for the gross profit overview report.

Request Information

URI Parameters

Name	Description	Type	Additional information
start	Start timestamp.	date	Required
end	End timestamp.	date	Required
interval	Interval.	time interval	Required

Body Parameters

None.

Response Information

Resource Description

An Enumerable of overview information between the start and end timestamps, partitioned by the spuulied interval.

Collection of GrossProfitOverviewDTO

Name	Description	Type	Additional information
StartTime	Gets the start time.	date	None.
Sales	Gets the sales.	decimal number	None.
Wages	Gets the wages.	decimal number	None.
CostOfGoods	Gets the cost of goods.	decimal number	None.
GrossProfit	Gets the gross profit.	decimal number	None.
GrossProfitPercentage	Gets the gross profit percentage.	decimal number	None.
Categories	Gets the categories.	Collection of GrossProfitOverviewBreakdownDTO	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "startTime": "2026-04-04T22:25:41.2748561+00:00",
    "sales": 2.0,
    "wages": 3.0,
    "costOfGoods": 4.0,
    "grossProfit": -5.0,
    "grossProfitPercentage": -250.0,
    "categories": [
      {
        "categoryIdentifier": "sample string 1",
        "categoryName": "sample string 2",
        "sales": 3.0,
        "wages": 4.0,
        "costOfGoods": 5.0,
        "grossProfit": -6.0,
        "grossProfitPercentage": -200.0
      },
      {
        "categoryIdentifier": "sample string 1",
        "categoryName": "sample string 2",
        "sales": 3.0,
        "wages": 4.0,
        "costOfGoods": 5.0,
        "grossProfit": -6.0,
        "grossProfitPercentage": -200.0
      }
    ]
  },
  {
    "startTime": "2026-04-04T22:25:41.2748561+00:00",
    "sales": 2.0,
    "wages": 3.0,
    "costOfGoods": 4.0,
    "grossProfit": -5.0,
    "grossProfitPercentage": -250.0,
    "categories": [
      {
        "categoryIdentifier": "sample string 1",
        "categoryName": "sample string 2",
        "sales": 3.0,
        "wages": 4.0,
        "costOfGoods": 5.0,
        "grossProfit": -6.0,
        "grossProfitPercentage": -200.0
      },
      {
        "categoryIdentifier": "sample string 1",
        "categoryName": "sample string 2",
        "sales": 3.0,
        "wages": 4.0,
        "costOfGoods": 5.0,
        "grossProfit": -6.0,
        "grossProfitPercentage": -200.0
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfGrossProfitOverviewDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loaded.WebApi.Models.GrossProfit">
  <GrossProfitOverviewDTO>
    <Categories>
      <GrossProfitOverviewBreakdownDTO>
        <CategoryIdentifier>sample string 1</CategoryIdentifier>
        <CategoryName>sample string 2</CategoryName>
        <CostOfGoods>5</CostOfGoods>
        <Sales>3</Sales>
        <Wages>4</Wages>
      </GrossProfitOverviewBreakdownDTO>
      <GrossProfitOverviewBreakdownDTO>
        <CategoryIdentifier>sample string 1</CategoryIdentifier>
        <CategoryName>sample string 2</CategoryName>
        <CostOfGoods>5</CostOfGoods>
        <Sales>3</Sales>
        <Wages>4</Wages>
      </GrossProfitOverviewBreakdownDTO>
    </Categories>
    <CostOfGoods>4</CostOfGoods>
    <Sales>2</Sales>
    <StartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-04T22:25:41.2748561Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartTime>
    <Wages>3</Wages>
  </GrossProfitOverviewDTO>
  <GrossProfitOverviewDTO>
    <Categories>
      <GrossProfitOverviewBreakdownDTO>
        <CategoryIdentifier>sample string 1</CategoryIdentifier>
        <CategoryName>sample string 2</CategoryName>
        <CostOfGoods>5</CostOfGoods>
        <Sales>3</Sales>
        <Wages>4</Wages>
      </GrossProfitOverviewBreakdownDTO>
      <GrossProfitOverviewBreakdownDTO>
        <CategoryIdentifier>sample string 1</CategoryIdentifier>
        <CategoryName>sample string 2</CategoryName>
        <CostOfGoods>5</CostOfGoods>
        <Sales>3</Sales>
        <Wages>4</Wages>
      </GrossProfitOverviewBreakdownDTO>
    </Categories>
    <CostOfGoods>4</CostOfGoods>
    <Sales>2</Sales>
    <StartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-04T22:25:41.2748561Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartTime>
    <Wages>3</Wages>
  </GrossProfitOverviewDTO>
</ArrayOfGrossProfitOverviewDTO>