POST Dashboard/SalesOverview

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Dashboard.DashboardRequest
NameDescriptionTypeAdditional information
EmployeeId

integer

None.
NoOfDays

integer

None.
IncludeTax

boolean

None.
IncludeGiftCardSales

boolean

None.
IsMobile

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "EmployeeId": 1,
  "NoOfDays": 1,
  "IncludeTax": true,
  "IncludeGiftCardSales": true,
  "IsMobile": true
}

application/xml, text/xml

Sample: 
<DashboardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
  <EmployeeId>1</EmployeeId>
  <IncludeGiftCardSales>true</IncludeGiftCardSales>
  <IncludeTax>true</IncludeTax>
  <IsMobile>true</IsMobile>
  <NoOfDays>1</NoOfDays>
</DashboardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.Domain.Dashboard.SalesOverviewViewModel
NameDescriptionTypeAdditional information
ProductSalesToday

string

None.
ProductSalesWeek

string

None.
ProductSalesMonth

string

None.
ProductSalesYear

string

None.
ProductSalesAllTime

string

None.
ServiceSalesToday

string

None.
ServiceSalesWeek

string

None.
ServiceSalesMonth

string

None.
ServiceSalesYear

string

None.
ServiceSalesAllTime

string

None.
TotalSalesToday

string

None.
TotalSalesWeek

string

None.
TotalSalesMonth

string

None.
TotalSalesYear

string

None.
TotalSalesAllTime

string

None.
TargetSalesToday

string

None.
TargetSalesWeek

string

None.
TargetSalesMonth

string

None.
TargetSalesYear

string

None.
TargetSalesAllTime

string

None.
TargetSalesPercentageToday

string

None.
TargetSalesPercentageWeek

string

None.
TargetSalesPercentageMonth

string

None.
TargetSalesPercentageYear

string

None.
TargetSalesPercentageAllTime

string

None.
TransactionNumberToday

string

None.
TransactionNumberWeek

string

None.
TransactionNumberMonth

string

None.
TransactionNumberYear

string

None.
TransactionNumberAllTime

string

None.
AverageSalesPerTransactionToday

string

None.
AverageSalesPerTransactionWeek

string

None.
AverageSalesPerTransactionMonth

string

None.
AverageSalesPerTransactionYear

string

None.
AverageUnitPerTransactionToday

string

None.
AverageUnitPerTransactionWeek

string

None.
AverageUnitPerTransactionMonth

string

None.
AverageUnitPerTransactionYear

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ProductSalesToday": "sample string 1",
  "ProductSalesWeek": "sample string 2",
  "ProductSalesMonth": "sample string 3",
  "ProductSalesYear": "sample string 4",
  "ProductSalesAllTime": "sample string 5",
  "ServiceSalesToday": "sample string 6",
  "ServiceSalesWeek": "sample string 7",
  "ServiceSalesMonth": "sample string 8",
  "ServiceSalesYear": "sample string 9",
  "ServiceSalesAllTime": "sample string 10",
  "TotalSalesToday": "sample string 11",
  "TotalSalesWeek": "sample string 12",
  "TotalSalesMonth": "sample string 13",
  "TotalSalesYear": "sample string 14",
  "TotalSalesAllTime": "sample string 15",
  "TargetSalesToday": "sample string 16",
  "TargetSalesWeek": "sample string 17",
  "TargetSalesMonth": "sample string 18",
  "TargetSalesYear": "sample string 19",
  "TargetSalesAllTime": "sample string 20",
  "TargetSalesPercentageToday": "sample string 21",
  "TargetSalesPercentageWeek": "sample string 22",
  "TargetSalesPercentageMonth": "sample string 23",
  "TargetSalesPercentageYear": "sample string 24",
  "TargetSalesPercentageAllTime": "sample string 25",
  "TransactionNumberToday": "sample string 26",
  "TransactionNumberWeek": "sample string 27",
  "TransactionNumberMonth": "sample string 28",
  "TransactionNumberYear": "sample string 29",
  "TransactionNumberAllTime": "sample string 30",
  "AverageSalesPerTransactionToday": "sample string 31",
  "AverageSalesPerTransactionWeek": "sample string 32",
  "AverageSalesPerTransactionMonth": "sample string 33",
  "AverageSalesPerTransactionYear": "sample string 34",
  "AverageUnitPerTransactionToday": "sample string 35",
  "AverageUnitPerTransactionWeek": "sample string 36",
  "AverageUnitPerTransactionMonth": "sample string 37",
  "AverageUnitPerTransactionYear": "sample string 38"
}

application/xml, text/xml

Sample: 
<SalesOverviewViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
  <AverageSalesPerTransactionMonth>sample string 33</AverageSalesPerTransactionMonth>
  <AverageSalesPerTransactionToday>sample string 31</AverageSalesPerTransactionToday>
  <AverageSalesPerTransactionWeek>sample string 32</AverageSalesPerTransactionWeek>
  <AverageSalesPerTransactionYear>sample string 34</AverageSalesPerTransactionYear>
  <AverageUnitPerTransactionMonth>sample string 37</AverageUnitPerTransactionMonth>
  <AverageUnitPerTransactionToday>sample string 35</AverageUnitPerTransactionToday>
  <AverageUnitPerTransactionWeek>sample string 36</AverageUnitPerTransactionWeek>
  <AverageUnitPerTransactionYear>sample string 38</AverageUnitPerTransactionYear>
  <ProductSalesAllTime>sample string 5</ProductSalesAllTime>
  <ProductSalesMonth>sample string 3</ProductSalesMonth>
  <ProductSalesToday>sample string 1</ProductSalesToday>
  <ProductSalesWeek>sample string 2</ProductSalesWeek>
  <ProductSalesYear>sample string 4</ProductSalesYear>
  <ServiceSalesAllTime>sample string 10</ServiceSalesAllTime>
  <ServiceSalesMonth>sample string 8</ServiceSalesMonth>
  <ServiceSalesToday>sample string 6</ServiceSalesToday>
  <ServiceSalesWeek>sample string 7</ServiceSalesWeek>
  <ServiceSalesYear>sample string 9</ServiceSalesYear>
  <TargetSalesAllTime>sample string 20</TargetSalesAllTime>
  <TargetSalesMonth>sample string 18</TargetSalesMonth>
  <TargetSalesPercentageAllTime>sample string 25</TargetSalesPercentageAllTime>
  <TargetSalesPercentageMonth>sample string 23</TargetSalesPercentageMonth>
  <TargetSalesPercentageToday>sample string 21</TargetSalesPercentageToday>
  <TargetSalesPercentageWeek>sample string 22</TargetSalesPercentageWeek>
  <TargetSalesPercentageYear>sample string 24</TargetSalesPercentageYear>
  <TargetSalesToday>sample string 16</TargetSalesToday>
  <TargetSalesWeek>sample string 17</TargetSalesWeek>
  <TargetSalesYear>sample string 19</TargetSalesYear>
  <TotalSalesAllTime>sample string 15</TotalSalesAllTime>
  <TotalSalesMonth>sample string 13</TotalSalesMonth>
  <TotalSalesToday>sample string 11</TotalSalesToday>
  <TotalSalesWeek>sample string 12</TotalSalesWeek>
  <TotalSalesYear>sample string 14</TotalSalesYear>
  <TransactionNumberAllTime>sample string 30</TransactionNumberAllTime>
  <TransactionNumberMonth>sample string 28</TransactionNumberMonth>
  <TransactionNumberToday>sample string 26</TransactionNumberToday>
  <TransactionNumberWeek>sample string 27</TransactionNumberWeek>
  <TransactionNumberYear>sample string 29</TransactionNumberYear>
</SalesOverviewViewModel>