POST SalesReport/GenerateReportView

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.SalesReport.SalesReport.ReportViewModel
NameDescriptionTypeAdditional information
DateFilterBy

IConnect.Domain.Reports.SalesReport.SalesReport.DateFilterBy

None.
SortByList

Collection of IConnect.Core.JsonSimpleViewModel

None.
EnteredBy

integer

None.
SalesPerson

integer

None.
OrderTypeCode

string

None.
ExcludeGiftCards

boolean

None.
SelectedCustomer

integer

None.
SelectedPaymentMethods

Collection of integer

None.
SortBy

IConnect.Domain.Reports.SalesReport.SalesReport.SortBy

None.
DefaultSortBy

IConnect.Domain.Reports.SalesReport.SalesReport.SortBy

None.
SelectedStartTime

date

None.
SelectedEndTime

date

None.
DollarPerTicket

decimal number

None.
ProductPerTicket

decimal number

None.
SelectedDollarPerTicketFilter

integer

None.
SelectedProductPerTicketFilter

integer

None.
ExcludeSKUs

string

None.
PageIndex

integer

None.
PageSize

integer

None.
ReportFormat

IConnect.Domain.Reports.ExportFormat

None.
PageResult

boolean

None.
DeliveryBy

IConnect.Domain.Companies.DeliveryProvider

None.
DeliveryByList

Collection of IConnect.Core.JsonSimpleViewModel

None.
ShippingOption

IConnect.Domain.POS.ShippingOptions

None.
GroupBy

IConnect.Domain.Reports.SalesReport.SalesReport.GroupBy

None.
DeviceId

string

None.
ZipCode

string

None.
ShippingOptionsList

Collection of IConnect.Core.JsonSimpleViewModel

None.
SelectedCompanies

Collection of integer

None.
OrderSource

IConnect.Domain.Orders.DisplayOrderSource

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: 
{
  "DateFilterBy": 0,
  "SortByList": [
    {
      "id": {},
      "name": "sample string 2"
    },
    {
      "id": {},
      "name": "sample string 2"
    }
  ],
  "EnteredBy": 1,
  "SalesPerson": 1,
  "OrderTypeCode": "sample string 1",
  "ExcludeGiftCards": true,
  "SelectedCustomer": 3,
  "SelectedPaymentMethods": [
    1,
    2
  ],
  "SortBy": 0,
  "DefaultSortBy": 0,
  "SelectedStartTime": "2025-04-03T22:03:31.6319113-04:00",
  "SelectedEndTime": "2025-04-03T22:03:31.6319113-04:00",
  "DollarPerTicket": 1.0,
  "ProductPerTicket": 1.0,
  "SelectedDollarPerTicketFilter": 4,
  "SelectedProductPerTicketFilter": 5,
  "ExcludeSKUs": "sample string 6",
  "PageIndex": 7,
  "PageSize": 8,
  "ReportFormat": 1,
  "PageResult": true,
  "DeliveryBy": 1,
  "DeliveryByList": [
    {
      "id": {},
      "name": "sample string 2"
    },
    {
      "id": {},
      "name": "sample string 2"
    }
  ],
  "ShippingOption": 0,
  "GroupBy": 0,
  "DeviceId": "sample string 10",
  "ZipCode": "sample string 11",
  "ShippingOptionsList": [
    {
      "id": {},
      "name": "sample string 2"
    },
    {
      "id": {},
      "name": "sample string 2"
    }
  ],
  "SelectedCompanies": [
    1,
    2
  ],
  "OrderSource": 1,
  "Start": "2025-04-03T22:03:31.6475506-04:00",
  "End": "2025-04-03T22:03:31.6475506-04:00",
  "StartDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":3,\"seconds\":31,\"miliseconds\":647}",
  "EndDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":3,\"seconds\":31,\"miliseconds\":647}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IConnect.Services.ReportingApi.Models.SalesPaymentMethodModel
NameDescriptionTypeAdditional information
PaymentMethodId

integer

None.
PaymentMethodName

string

None.
DisplayOrderSource

IConnect.Domain.Orders.DisplayOrderSource

None.
GroupBy

IConnect.Domain.Reports.SalesReport.SalesReport.GroupBy

None.
AggregateByName

string

None.
Discount

decimal number

None.
Tax

decimal number

None.
Tips

decimal number

None.
SubTotal

decimal number

None.
Total

decimal number

None.
TotalPaid

decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "PaymentMethodId": 1,
    "PaymentMethodName": "sample string 1",
    "DisplayOrderSource": 1,
    "GroupBy": 0,
    "AggregateByName": "sample string 1",
    "Discount": 2.0,
    "Tax": 3.0,
    "Tips": 4.0,
    "SubTotal": 5.0,
    "Total": 6.0,
    "TotalPaid": 7.0
  },
  {
    "PaymentMethodId": 1,
    "PaymentMethodName": "sample string 1",
    "DisplayOrderSource": 1,
    "GroupBy": 0,
    "AggregateByName": "sample string 1",
    "Discount": 2.0,
    "Tax": 3.0,
    "Tips": 4.0,
    "SubTotal": 5.0,
    "Total": 6.0,
    "TotalPaid": 7.0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfSalesPaymentMethodModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Services.ReportingApi.Models">
  <SalesPaymentMethodModel>
    <Discount>2</Discount>
    <DisplayOrderSource>Instore</DisplayOrderSource>
    <GroupBy>ByPaymentType</GroupBy>
    <PaymentMethodId>1</PaymentMethodId>
    <PaymentMethodName>sample string 1</PaymentMethodName>
    <SubTotal>5</SubTotal>
    <Tax>3</Tax>
    <Tips>4</Tips>
    <Total>6</Total>
    <TotalPaid>7</TotalPaid>
  </SalesPaymentMethodModel>
  <SalesPaymentMethodModel>
    <Discount>2</Discount>
    <DisplayOrderSource>Instore</DisplayOrderSource>
    <GroupBy>ByPaymentType</GroupBy>
    <PaymentMethodId>1</PaymentMethodId>
    <PaymentMethodName>sample string 1</PaymentMethodName>
    <SubTotal>5</SubTotal>
    <Tax>3</Tax>
    <Tips>4</Tips>
    <Total>6</Total>
    <TotalPaid>7</TotalPaid>
  </SalesPaymentMethodModel>
</ArrayOfSalesPaymentMethodModel>