GET a/CogsProducts/GetCogsSummary?start={start}&end={end}&interval={interval}

Get cogs report

Request Information

URI Parameters

Name	Description	Type	Additional information
start	Start date for the report	date	Required
end	End date for the report	date	Required
interval	Interval for the report	time interval	Required

Body Parameters

None.

Response Information

Resource Description

Cogs report

Collection of CogsSummaryDTO

Name	Description	Type	Additional information
StartTime	Gets or sets the CashupSet start time	date	None.
Period	Period of time represented by this summary	time interval	None.
SalesExcludeTax	Gets or sets the sales exclude tax	decimal number	None.
SalesExcludeTaxLinkedOnly	Gets or sets the sales (excl. gst) of all items that have pos item links.	decimal number	None.
Cost	Gets or sets the cost of goods	decimal number	None.
Discounts	Gets the discounts.	decimal number	None.
Categories	Gets or sets the cogs breakdown by categories	Collection of CogsDTOBreakdown	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "startTime": "2026-04-04T22:27:08.1854142+00:00",
    "period": "00:00:00.1234567",
    "salesExcludeTax": 6.0,
    "salesExcludeTaxLinkedOnly": 8.0,
    "cost": 2.0,
    "discounts": 10.0,
    "categories": [
      {
        "posItemCategoryIdentifier": "sample string 1",
        "posItemCategoryName": "sample string 2",
        "salesExcludeTax": 3.0,
        "salesExcludeTaxLinkedOnly": 4.0,
        "cost": 1.0,
        "discounts": 5.0
      },
      {
        "posItemCategoryIdentifier": "sample string 1",
        "posItemCategoryName": "sample string 2",
        "salesExcludeTax": 3.0,
        "salesExcludeTaxLinkedOnly": 4.0,
        "cost": 1.0,
        "discounts": 5.0
      }
    ]
  },
  {
    "startTime": "2026-04-04T22:27:08.1854142+00:00",
    "period": "00:00:00.1234567",
    "salesExcludeTax": 6.0,
    "salesExcludeTaxLinkedOnly": 8.0,
    "cost": 2.0,
    "discounts": 10.0,
    "categories": [
      {
        "posItemCategoryIdentifier": "sample string 1",
        "posItemCategoryName": "sample string 2",
        "salesExcludeTax": 3.0,
        "salesExcludeTaxLinkedOnly": 4.0,
        "cost": 1.0,
        "discounts": 5.0
      },
      {
        "posItemCategoryIdentifier": "sample string 1",
        "posItemCategoryName": "sample string 2",
        "salesExcludeTax": 3.0,
        "salesExcludeTaxLinkedOnly": 4.0,
        "cost": 1.0,
        "discounts": 5.0
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCogsSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loaded.WebApi.Models.Cogs">
  <CogsSummaryDTO>
    <Categories>
      <CogsDTOBreakdown>
        <Cost>1</Cost>
        <Discounts>5</Discounts>
        <PosItemCategoryIdentifier>sample string 1</PosItemCategoryIdentifier>
        <PosItemCategoryName>sample string 2</PosItemCategoryName>
        <SalesExcludeTax>3</SalesExcludeTax>
        <SalesExcludeTaxLinkedOnly>4</SalesExcludeTaxLinkedOnly>
      </CogsDTOBreakdown>
      <CogsDTOBreakdown>
        <Cost>1</Cost>
        <Discounts>5</Discounts>
        <PosItemCategoryIdentifier>sample string 1</PosItemCategoryIdentifier>
        <PosItemCategoryName>sample string 2</PosItemCategoryName>
        <SalesExcludeTax>3</SalesExcludeTax>
        <SalesExcludeTaxLinkedOnly>4</SalesExcludeTaxLinkedOnly>
      </CogsDTOBreakdown>
    </Categories>
    <Period>PT0.1234567S</Period>
    <StartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-04T22:27:08.1854142Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartTime>
  </CogsSummaryDTO>
  <CogsSummaryDTO>
    <Categories>
      <CogsDTOBreakdown>
        <Cost>1</Cost>
        <Discounts>5</Discounts>
        <PosItemCategoryIdentifier>sample string 1</PosItemCategoryIdentifier>
        <PosItemCategoryName>sample string 2</PosItemCategoryName>
        <SalesExcludeTax>3</SalesExcludeTax>
        <SalesExcludeTaxLinkedOnly>4</SalesExcludeTaxLinkedOnly>
      </CogsDTOBreakdown>
      <CogsDTOBreakdown>
        <Cost>1</Cost>
        <Discounts>5</Discounts>
        <PosItemCategoryIdentifier>sample string 1</PosItemCategoryIdentifier>
        <PosItemCategoryName>sample string 2</PosItemCategoryName>
        <SalesExcludeTax>3</SalesExcludeTax>
        <SalesExcludeTaxLinkedOnly>4</SalesExcludeTaxLinkedOnly>
      </CogsDTOBreakdown>
    </Categories>
    <Period>PT0.1234567S</Period>
    <StartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-04T22:27:08.1854142Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartTime>
  </CogsSummaryDTO>
</ArrayOfCogsSummaryDTO>