GET r/PosSales?start={start}&end={end}&interval={interval}&posItemIdentifier={posItemIdentifier}

Get sales information for the report period, grouped by report interval.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
start

Start of report

date

Required

end

End of report

date

Required

interval

Interval to divide report

time interval

Required

posItemIdentifier

Optional parameter to only show sales for a single Pos Item.

string

None.

Body Parameters

None.

Response Information

Resource Description

Sales summary grouped by interval

Collection of PosSalesDTO
NameDescriptionTypeAdditional information
StartTime

Start time of the data represented

date

None.

Period

Period of time represented by this summary

time interval

None.

Invoices

Total Invoices for this time period

decimal number

None.

InvoicesTax

Total tax on Invoices for this time period

decimal number

None.

Discounts

Total discounts for the time period

decimal number

None.

Quantity

Gets or sets the total quantity of items sold.

decimal number

None.

Count

Transaction count for this time period

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "startTime": "2026-04-04T22:27:09.0016299+00:00",
    "period": "00:00:00.1234567",
    "invoices": 3.0,
    "invoicesTax": 4.0,
    "discounts": 5.0,
    "quantity": 6.0,
    "count": 7.0
  },
  {
    "startTime": "2026-04-04T22:27:09.0016299+00:00",
    "period": "00:00:00.1234567",
    "invoices": 3.0,
    "invoicesTax": 4.0,
    "discounts": 5.0,
    "quantity": 6.0,
    "count": 7.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfPosSalesDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loaded.WebApi.Models.POS.Sales">
  <PosSalesDTO>
    <Count>7</Count>
    <Discounts>5</Discounts>
    <Invoices>3</Invoices>
    <InvoicesTax>4</InvoicesTax>
    <Period>PT0.1234567S</Period>
    <Quantity>6</Quantity>
    <StartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-04T22:27:09.0016299Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartTime>
  </PosSalesDTO>
  <PosSalesDTO>
    <Count>7</Count>
    <Discounts>5</Discounts>
    <Invoices>3</Invoices>
    <InvoicesTax>4</InvoicesTax>
    <Period>PT0.1234567S</Period>
    <Quantity>6</Quantity>
    <StartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-04T22:27:09.0016299Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartTime>
  </PosSalesDTO>
</ArrayOfPosSalesDTO>