GET r/PosStaffDiscounts?start={start}&end={end}&posIdentifier={posIdentifier}

Get discount information for the report period and specified staff member, grouped by discount type.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
start

Report start

date

Required

end

Report end

date

Required

posIdentifier

Staff Member POS identifier

string

Required

Body Parameters

None.

Response Information

Resource Description

Summary of each discount type processed by this staff member

Collection of PosDiscountStaffSummaryDTO
NameDescriptionTypeAdditional information
StaffName

Gets or sets the name of the staff member

string

None.

StaffPosIdentifier

Gets or sets the POS specific identifier of the staff member

string

None.

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:
[
  {
    "staffName": "sample string 1",
    "staffPosIdentifier": "sample string 2",
    "discountTypeIdentifier": "sample string 3",
    "discountType": "sample string 4",
    "discountsAmount": 5.0,
    "discountsCount": 6,
    "discountInvoices": 7.0
  },
  {
    "staffName": "sample string 1",
    "staffPosIdentifier": "sample string 2",
    "discountTypeIdentifier": "sample string 3",
    "discountType": "sample string 4",
    "discountsAmount": 5.0,
    "discountsCount": 6,
    "discountInvoices": 7.0
  }
]

application/xml, text/xml

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