GET a/PosDiscounts/GetDiscounts?start={start}&end={end}

Gets discounts information for the report period, grouped by discount type.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
start

Query start time

date

Required

end

Query end time

date

Required

Body Parameters

None.

Response Information

Resource Description

Discount information for the queried time

Collection of PosDiscountTypesSummaryDTO
NameDescriptionTypeAdditional information
DiscountTypeIdentifier

Gets or sets the POS specific identifier for this discount type

string

None.

DiscountType

Gets or sets the name of the discount type

string

None.

DiscountsAmount

Gets or sets the dollar amount discounted

decimal number

None.

DiscountsCount

Gets or sets the number of discounted transactions

integer

None.

DiscountInvoices

Gets or sets the dollar amount invoiced after the discounts

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "discountTypeIdentifier": "sample string 1",
    "discountType": "sample string 2",
    "discountsAmount": 3.0,
    "discountsCount": 4,
    "discountInvoices": 5.0
  },
  {
    "discountTypeIdentifier": "sample string 1",
    "discountType": "sample string 2",
    "discountsAmount": 3.0,
    "discountsCount": 4,
    "discountInvoices": 5.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfPosDiscountTypesSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loaded.WebApi.Models.POS.Discounts">
  <PosDiscountTypesSummaryDTO>
    <DiscountInvoices>5</DiscountInvoices>
    <DiscountType>sample string 2</DiscountType>
    <DiscountTypeIdentifier>sample string 1</DiscountTypeIdentifier>
    <DiscountsAmount>3</DiscountsAmount>
    <DiscountsCount>4</DiscountsCount>
  </PosDiscountTypesSummaryDTO>
  <PosDiscountTypesSummaryDTO>
    <DiscountInvoices>5</DiscountInvoices>
    <DiscountType>sample string 2</DiscountType>
    <DiscountTypeIdentifier>sample string 1</DiscountTypeIdentifier>
    <DiscountsAmount>3</DiscountsAmount>
    <DiscountsCount>4</DiscountsCount>
  </PosDiscountTypesSummaryDTO>
</ArrayOfPosDiscountTypesSummaryDTO>