POST HourlySalesReportV1/GenerateReport
Request Information
URI Parameters
None.
Body Parameters
IConnect.Domain.Reports.SalesReport.HourlySalesReportV1.ReportViewModelName | Description | Type | Additional information |
---|---|---|---|
SelectedCompanies | Collection of integer |
None. |
|
SelectedEmployees | Collection of integer |
None. |
|
DollarPerTicket | decimal number |
None. |
|
SelectedDollarPerTicketFilter | integer |
None. |
|
ProductPerTicket | decimal number |
None. |
|
SelectedProductPerTicketFilter | integer |
None. |
|
PageIndex | integer |
None. |
|
PageSize | integer |
None. |
|
Start | date |
None. |
|
End | date |
None. |
|
StartDateObjectString | string |
None. |
|
EndDateObjectString | string |
None. |
|
SkipTimeZoneConvertion | boolean |
None. |
|
ForceImmediateExport | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "SelectedCompanies": [ 1, 2 ], "SelectedEmployees": [ 1, 2 ], "DollarPerTicket": 1.0, "SelectedDollarPerTicketFilter": 1, "ProductPerTicket": 1.0, "SelectedProductPerTicketFilter": 2, "PageIndex": 3, "PageSize": 4, "Start": "2025-04-03T22:30:47.2776649-04:00", "End": "2025-04-03T22:30:47.2776649-04:00", "StartDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":30,\"seconds\":47,\"miliseconds\":277}", "EndDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":30,\"seconds\":47,\"miliseconds\":277}", "SkipTimeZoneConvertion": true, "ForceImmediateExport": true }
application/xml, text/xml
Sample:
<ReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.HourlySalesReportV1"> <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2025-04-03T22:30:47.2776649-04:00</_x003C_End_x003E_k__BackingField> <_x003C_ForceImmediateExport_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_ForceImmediateExport_x003E_k__BackingField> <_x003C_SkipTimeZoneConvertion_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_SkipTimeZoneConvertion_x003E_k__BackingField> <_x003C_Start_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2025-04-03T22:30:47.2776649-04:00</_x003C_Start_x003E_k__BackingField> <_x003C_DollarPerTicket_x003E_k__BackingField>1</_x003C_DollarPerTicket_x003E_k__BackingField> <_x003C_PageIndex_x003E_k__BackingField>3</_x003C_PageIndex_x003E_k__BackingField> <_x003C_PageSize_x003E_k__BackingField>4</_x003C_PageSize_x003E_k__BackingField> <_x003C_ProductPerTicket_x003E_k__BackingField>1</_x003C_ProductPerTicket_x003E_k__BackingField> <_x003C_SelectedCompanies_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </_x003C_SelectedCompanies_x003E_k__BackingField> <_x003C_SelectedDollarPerTicketFilter_x003E_k__BackingField>1</_x003C_SelectedDollarPerTicketFilter_x003E_k__BackingField> <_x003C_SelectedEmployees_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </_x003C_SelectedEmployees_x003E_k__BackingField> <_x003C_SelectedProductPerTicketFilter_x003E_k__BackingField>2</_x003C_SelectedProductPerTicketFilter_x003E_k__BackingField> </ReportViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IConnect.Core.PagedListOfIConnect.Domain.Reports.SalesReport.HourlySalesReportV1.ReportItemName | Description | Type | Additional information |
---|---|---|---|
Data | Collection of IConnect.Domain.Reports.SalesReport.HourlySalesReportV1.ReportItem |
None. |
|
Footer | IConnect.Domain.Reports.SalesReport.HourlySalesReportV1.ReportItem |
None. |
|
PageFooter | IConnect.Domain.Reports.SalesReport.HourlySalesReportV1.ReportItem |
None. |
|
PageNumber | integer |
None. |
|
PageSize | integer |
None. |
|
TotalRows | integer |
None. |
|
TotalPages | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "OrderId": 1, "UserOrderDate": "2025-04-03T22:30:47.3089059-04:00", "SubTotal": 3.0, "OrderTotal": 4.0, "OrderPaid": 5.0, "Tax": 6.0, "Discount": 7.0, "Tips": 8.0, "CustomerFullName": "sample string 9 sample string 10", "CustomerFirstName": "sample string 9", "CustomerLastName": "sample string 10", "Location": "sample string 11", "Employee": "sample string 12", "CustomReceiptNumber": "sample string 13", "CompanyOrderNumber": 1, "OrderTypeName": "sample string 14", "OrderTypeCode": "sample string 15" }, { "OrderId": 1, "UserOrderDate": "2025-04-03T22:30:47.3089059-04:00", "SubTotal": 3.0, "OrderTotal": 4.0, "OrderPaid": 5.0, "Tax": 6.0, "Discount": 7.0, "Tips": 8.0, "CustomerFullName": "sample string 9 sample string 10", "CustomerFirstName": "sample string 9", "CustomerLastName": "sample string 10", "Location": "sample string 11", "Employee": "sample string 12", "CustomReceiptNumber": "sample string 13", "CompanyOrderNumber": 1, "OrderTypeName": "sample string 14", "OrderTypeCode": "sample string 15" } ], "Footer": { "OrderId": 1, "UserOrderDate": "2025-04-03T22:30:47.3089059-04:00", "SubTotal": 3.0, "OrderTotal": 4.0, "OrderPaid": 5.0, "Tax": 6.0, "Discount": 7.0, "Tips": 8.0, "CustomerFullName": "sample string 9 sample string 10", "CustomerFirstName": "sample string 9", "CustomerLastName": "sample string 10", "Location": "sample string 11", "Employee": "sample string 12", "CustomReceiptNumber": "sample string 13", "CompanyOrderNumber": 1, "OrderTypeName": "sample string 14", "OrderTypeCode": "sample string 15" }, "PageFooter": { "OrderId": 1, "UserOrderDate": "2025-04-03T22:30:47.3089059-04:00", "SubTotal": 3.0, "OrderTotal": 4.0, "OrderPaid": 5.0, "Tax": 6.0, "Discount": 7.0, "Tips": 8.0, "CustomerFullName": "sample string 9 sample string 10", "CustomerFirstName": "sample string 9", "CustomerLastName": "sample string 10", "Location": "sample string 11", "Employee": "sample string 12", "CustomReceiptNumber": "sample string 13", "CompanyOrderNumber": 1, "OrderTypeName": "sample string 14", "OrderTypeCode": "sample string 15" }, "PageNumber": 1, "PageSize": 2, "TotalRows": 3, "TotalPages": 4 }
application/xml, text/xml
Sample:
<PagedListOfReportItem56FhQLxy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core"> <PageNumber>1</PageNumber> <PageSize>2</PageSize> <TotalPages>4</TotalPages> <TotalRows>3</TotalRows> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.HourlySalesReportV1"> <d2p1:ReportItem> <d2p1:CustomReceiptNumber>sample string 13</d2p1:CustomReceiptNumber> <d2p1:CustomerFirstName>sample string 9</d2p1:CustomerFirstName> <d2p1:CustomerLastName>sample string 10</d2p1:CustomerLastName> <d2p1:Discount>7</d2p1:Discount> <d2p1:Employee>sample string 12</d2p1:Employee> <d2p1:Location>sample string 11</d2p1:Location> <d2p1:OrderId>1</d2p1:OrderId> <d2p1:OrderPaid>5</d2p1:OrderPaid> <d2p1:OrderTotal>4</d2p1:OrderTotal> <d2p1:OrderTypeCode>sample string 15</d2p1:OrderTypeCode> <d2p1:OrderTypeName>sample string 14</d2p1:OrderTypeName> <d2p1:SubTotal>3</d2p1:SubTotal> <d2p1:Tax>6</d2p1:Tax> <d2p1:Tips>8</d2p1:Tips> <d2p1:UserOrderDate>2025-04-03T22:30:47.3089059-04:00</d2p1:UserOrderDate> </d2p1:ReportItem> <d2p1:ReportItem> <d2p1:CustomReceiptNumber>sample string 13</d2p1:CustomReceiptNumber> <d2p1:CustomerFirstName>sample string 9</d2p1:CustomerFirstName> <d2p1:CustomerLastName>sample string 10</d2p1:CustomerLastName> <d2p1:Discount>7</d2p1:Discount> <d2p1:Employee>sample string 12</d2p1:Employee> <d2p1:Location>sample string 11</d2p1:Location> <d2p1:OrderId>1</d2p1:OrderId> <d2p1:OrderPaid>5</d2p1:OrderPaid> <d2p1:OrderTotal>4</d2p1:OrderTotal> <d2p1:OrderTypeCode>sample string 15</d2p1:OrderTypeCode> <d2p1:OrderTypeName>sample string 14</d2p1:OrderTypeName> <d2p1:SubTotal>3</d2p1:SubTotal> <d2p1:Tax>6</d2p1:Tax> <d2p1:Tips>8</d2p1:Tips> <d2p1:UserOrderDate>2025-04-03T22:30:47.3089059-04:00</d2p1:UserOrderDate> </d2p1:ReportItem> </Data> <Footer xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.HourlySalesReportV1"> <d2p1:CustomReceiptNumber>sample string 13</d2p1:CustomReceiptNumber> <d2p1:CustomerFirstName>sample string 9</d2p1:CustomerFirstName> <d2p1:CustomerLastName>sample string 10</d2p1:CustomerLastName> <d2p1:Discount>7</d2p1:Discount> <d2p1:Employee>sample string 12</d2p1:Employee> <d2p1:Location>sample string 11</d2p1:Location> <d2p1:OrderId>1</d2p1:OrderId> <d2p1:OrderPaid>5</d2p1:OrderPaid> <d2p1:OrderTotal>4</d2p1:OrderTotal> <d2p1:OrderTypeCode>sample string 15</d2p1:OrderTypeCode> <d2p1:OrderTypeName>sample string 14</d2p1:OrderTypeName> <d2p1:SubTotal>3</d2p1:SubTotal> <d2p1:Tax>6</d2p1:Tax> <d2p1:Tips>8</d2p1:Tips> <d2p1:UserOrderDate>2025-04-03T22:30:47.3089059-04:00</d2p1:UserOrderDate> </Footer> <PageFooter xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.HourlySalesReportV1"> <d2p1:CustomReceiptNumber>sample string 13</d2p1:CustomReceiptNumber> <d2p1:CustomerFirstName>sample string 9</d2p1:CustomerFirstName> <d2p1:CustomerLastName>sample string 10</d2p1:CustomerLastName> <d2p1:Discount>7</d2p1:Discount> <d2p1:Employee>sample string 12</d2p1:Employee> <d2p1:Location>sample string 11</d2p1:Location> <d2p1:OrderId>1</d2p1:OrderId> <d2p1:OrderPaid>5</d2p1:OrderPaid> <d2p1:OrderTotal>4</d2p1:OrderTotal> <d2p1:OrderTypeCode>sample string 15</d2p1:OrderTypeCode> <d2p1:OrderTypeName>sample string 14</d2p1:OrderTypeName> <d2p1:SubTotal>3</d2p1:SubTotal> <d2p1:Tax>6</d2p1:Tax> <d2p1:Tips>8</d2p1:Tips> <d2p1:UserOrderDate>2025-04-03T22:30:47.3089059-04:00</d2p1:UserOrderDate> </PageFooter> </PagedListOfReportItem56FhQLxy>