POST SalesReport/GenerateReportView

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.SalesReport.SalesReport.ReportViewModel

Name	Type	Additional 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.
ExternalDeliveryProviders	Collection of string	None.
ShippingOption	IConnect.Domain.POS.ShippingOptions	None.
GroupBy	IConnect.Domain.Reports.SalesReport.SalesReport.GroupBy	None.
DeviceId	string	None.
ZipCodes	Collection of string	None.
ShippingOptionsList	Collection of IConnect.Core.JsonSimpleViewModel	None.
ExternalDeliveryProvidersList	Collection of string	None.
FilterOrderSourcesTree	Collection of IConnect.Domain.Reports.DropDownTreeItemOfSystem.NullableOfSystem.Int32	None.
SelectedCompanies	Collection of integer	None.
OrderSources	Collection of IConnect.Domain.Orders.OrderSourceEnum	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-12-15T16:13:54.2889606-05:00",
  "SelectedEndTime": "2025-12-15T16:13:54.2889606-05: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"
    }
  ],
  "ExternalDeliveryProviders": [
    "sample string 1",
    "sample string 2"
  ],
  "ShippingOption": 0,
  "GroupBy": 0,
  "DeviceId": "sample string 10",
  "ZipCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "ShippingOptionsList": [
    {
      "id": {},
      "name": "sample string 2"
    },
    {
      "id": {},
      "name": "sample string 2"
    }
  ],
  "ExternalDeliveryProvidersList": [
    "DoorDash",
    "Uber Eats",
    "Grubhub",
    "SkipTheDishes",
    "ChowNow",
    "Ritual",
    "Fantuan",
    "HungryPanda"
  ],
  "FilterOrderSourcesTree": [
    {
      "Id": 1,
      "ParentId": 1,
      "Name": "sample string 1",
      "IsValue": true,
      "DisplayOrder": 3,
      "AllowMultiselect": true,
      "IsDisabled": true,
      "IsInvisible": true
    },
    {
      "Id": 1,
      "ParentId": 1,
      "Name": "sample string 1",
      "IsValue": true,
      "DisplayOrder": 3,
      "AllowMultiselect": true,
      "IsDisabled": true,
      "IsInvisible": true
    }
  ],
  "SelectedCompanies": [
    1,
    2
  ],
  "OrderSources": [
    0,
    0
  ],
  "Start": "2025-12-15T16:13:54.2889606-05:00",
  "End": "2025-12-15T16:13:54.2889606-05:00",
  "StartDateObjectString": "{\"year\":2025,\"month\":12,\"date\":15,\"hours\":16,\"minutes\":13,\"seconds\":54,\"miliseconds\":288}",
  "EndDateObjectString": "{\"year\":2025,\"month\":12,\"date\":15,\"hours\":16,\"minutes\":13,\"seconds\":54,\"miliseconds\":288}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IConnect.Services.ReportingApi.Models.SalesPaymentMethodModel

Name	Type	Additional 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.
SalesReportItems	Collection of IConnect.Domain.Reports.SalesReport.SalesReport.SalesReportItem	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

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>
    <SalesReportItems xmlns:d3p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.SalesReport">
      <d3p1:SalesReportItem>
        <d3p1:Cashier>sample string 10</d3p1:Cashier>
        <d3p1:CashierId>7</d3p1:CashierId>
        <d3p1:CustomReceiptNumber>sample string 2</d3p1:CustomReceiptNumber>
        <d3p1:Customer>sample string 5</d3p1:Customer>
        <d3p1:CustomerId>8</d3p1:CustomerId>
        <d3p1:Date>2025-12-15T16:13:54.3046019-05:00</d3p1:Date>
        <d3p1:DeliveryEmployeeId>1</d3p1:DeliveryEmployeeId>
        <d3p1:DeliveryEmployeeName>sample string 26</d3p1:DeliveryEmployeeName>
        <d3p1:DeliveryProvider>BuiltIn</d3p1:DeliveryProvider>
        <d3p1:ExternalDeliveryProvider>sample string 27</d3p1:ExternalDeliveryProvider>
        <d3p1:IsFirstPayment>true</d3p1:IsFirstPayment>
        <d3p1:IsRestarant>true</d3p1:IsRestarant>
        <d3p1:IsSplitted>sample string 22</d3p1:IsSplitted>
        <d3p1:Location>sample string 11</d3p1:Location>
        <d3p1:OrderSource>POS</d3p1:OrderSource>
        <d3p1:OrderTypeId>1</d3p1:OrderTypeId>
        <d3p1:OrderTypeName>sample string 25</d3p1:OrderTypeName>
        <d3p1:PaymentAmount>12</d3p1:PaymentAmount>
        <d3p1:PaymentDate>2025-12-15T16:13:54.3046019-05:00</d3p1:PaymentDate>
        <d3p1:PaymentId>9</d3p1:PaymentId>
        <d3p1:PaymentMethod>sample string 4</d3p1:PaymentMethod>
        <d3p1:PaymentMethodId>3</d3p1:PaymentMethodId>
        <d3p1:RemainingBalance>21</d3p1:RemainingBalance>
        <d3p1:RewardPointsAmount>13</d3p1:RewardPointsAmount>
        <d3p1:SalesPersonIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d3p1:SalesPersonIds>
        <d3p1:SalesPersons xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:SalesPersons>
        <d3p1:ShippingOption>InStore</d3p1:ShippingOption>
        <d3p1:ShippingStatusId>24</d3p1:ShippingStatusId>
        <d3p1:TicketDiscount>15</d3p1:TicketDiscount>
        <d3p1:TicketId>1</d3p1:TicketId>
        <d3p1:TicketSubtotal>18</d3p1:TicketSubtotal>
        <d3p1:TicketTax>16</d3p1:TicketTax>
        <d3p1:TicketTips>17</d3p1:TicketTips>
        <d3p1:TicketTotal>19</d3p1:TicketTotal>
        <d3p1:TotalPaid>20</d3p1:TotalPaid>
        <d3p1:ZipPostal>sample string 6</d3p1:ZipPostal>
      </d3p1:SalesReportItem>
      <d3p1:SalesReportItem>
        <d3p1:Cashier>sample string 10</d3p1:Cashier>
        <d3p1:CashierId>7</d3p1:CashierId>
        <d3p1:CustomReceiptNumber>sample string 2</d3p1:CustomReceiptNumber>
        <d3p1:Customer>sample string 5</d3p1:Customer>
        <d3p1:CustomerId>8</d3p1:CustomerId>
        <d3p1:Date>2025-12-15T16:13:54.3046019-05:00</d3p1:Date>
        <d3p1:DeliveryEmployeeId>1</d3p1:DeliveryEmployeeId>
        <d3p1:DeliveryEmployeeName>sample string 26</d3p1:DeliveryEmployeeName>
        <d3p1:DeliveryProvider>BuiltIn</d3p1:DeliveryProvider>
        <d3p1:ExternalDeliveryProvider>sample string 27</d3p1:ExternalDeliveryProvider>
        <d3p1:IsFirstPayment>true</d3p1:IsFirstPayment>
        <d3p1:IsRestarant>true</d3p1:IsRestarant>
        <d3p1:IsSplitted>sample string 22</d3p1:IsSplitted>
        <d3p1:Location>sample string 11</d3p1:Location>
        <d3p1:OrderSource>POS</d3p1:OrderSource>
        <d3p1:OrderTypeId>1</d3p1:OrderTypeId>
        <d3p1:OrderTypeName>sample string 25</d3p1:OrderTypeName>
        <d3p1:PaymentAmount>12</d3p1:PaymentAmount>
        <d3p1:PaymentDate>2025-12-15T16:13:54.3046019-05:00</d3p1:PaymentDate>
        <d3p1:PaymentId>9</d3p1:PaymentId>
        <d3p1:PaymentMethod>sample string 4</d3p1:PaymentMethod>
        <d3p1:PaymentMethodId>3</d3p1:PaymentMethodId>
        <d3p1:RemainingBalance>21</d3p1:RemainingBalance>
        <d3p1:RewardPointsAmount>13</d3p1:RewardPointsAmount>
        <d3p1:SalesPersonIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d3p1:SalesPersonIds>
        <d3p1:SalesPersons xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:SalesPersons>
        <d3p1:ShippingOption>InStore</d3p1:ShippingOption>
        <d3p1:ShippingStatusId>24</d3p1:ShippingStatusId>
        <d3p1:TicketDiscount>15</d3p1:TicketDiscount>
        <d3p1:TicketId>1</d3p1:TicketId>
        <d3p1:TicketSubtotal>18</d3p1:TicketSubtotal>
        <d3p1:TicketTax>16</d3p1:TicketTax>
        <d3p1:TicketTips>17</d3p1:TicketTips>
        <d3p1:TicketTotal>19</d3p1:TicketTotal>
        <d3p1:TotalPaid>20</d3p1:TotalPaid>
        <d3p1:ZipPostal>sample string 6</d3p1:ZipPostal>
      </d3p1:SalesReportItem>
    </SalesReportItems>
    <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>
    <SalesReportItems xmlns:d3p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.SalesReport">
      <d3p1:SalesReportItem>
        <d3p1:Cashier>sample string 10</d3p1:Cashier>
        <d3p1:CashierId>7</d3p1:CashierId>
        <d3p1:CustomReceiptNumber>sample string 2</d3p1:CustomReceiptNumber>
        <d3p1:Customer>sample string 5</d3p1:Customer>
        <d3p1:CustomerId>8</d3p1:CustomerId>
        <d3p1:Date>2025-12-15T16:13:54.3046019-05:00</d3p1:Date>
        <d3p1:DeliveryEmployeeId>1</d3p1:DeliveryEmployeeId>
        <d3p1:DeliveryEmployeeName>sample string 26</d3p1:DeliveryEmployeeName>
        <d3p1:DeliveryProvider>BuiltIn</d3p1:DeliveryProvider>
        <d3p1:ExternalDeliveryProvider>sample string 27</d3p1:ExternalDeliveryProvider>
        <d3p1:IsFirstPayment>true</d3p1:IsFirstPayment>
        <d3p1:IsRestarant>true</d3p1:IsRestarant>
        <d3p1:IsSplitted>sample string 22</d3p1:IsSplitted>
        <d3p1:Location>sample string 11</d3p1:Location>
        <d3p1:OrderSource>POS</d3p1:OrderSource>
        <d3p1:OrderTypeId>1</d3p1:OrderTypeId>
        <d3p1:OrderTypeName>sample string 25</d3p1:OrderTypeName>
        <d3p1:PaymentAmount>12</d3p1:PaymentAmount>
        <d3p1:PaymentDate>2025-12-15T16:13:54.3046019-05:00</d3p1:PaymentDate>
        <d3p1:PaymentId>9</d3p1:PaymentId>
        <d3p1:PaymentMethod>sample string 4</d3p1:PaymentMethod>
        <d3p1:PaymentMethodId>3</d3p1:PaymentMethodId>
        <d3p1:RemainingBalance>21</d3p1:RemainingBalance>
        <d3p1:RewardPointsAmount>13</d3p1:RewardPointsAmount>
        <d3p1:SalesPersonIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d3p1:SalesPersonIds>
        <d3p1:SalesPersons xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:SalesPersons>
        <d3p1:ShippingOption>InStore</d3p1:ShippingOption>
        <d3p1:ShippingStatusId>24</d3p1:ShippingStatusId>
        <d3p1:TicketDiscount>15</d3p1:TicketDiscount>
        <d3p1:TicketId>1</d3p1:TicketId>
        <d3p1:TicketSubtotal>18</d3p1:TicketSubtotal>
        <d3p1:TicketTax>16</d3p1:TicketTax>
        <d3p1:TicketTips>17</d3p1:TicketTips>
        <d3p1:TicketTotal>19</d3p1:TicketTotal>
        <d3p1:TotalPaid>20</d3p1:TotalPaid>
        <d3p1:ZipPostal>sample string 6</d3p1:ZipPostal>
      </d3p1:SalesReportItem>
      <d3p1:SalesReportItem>
        <d3p1:Cashier>sample string 10</d3p1:Cashier>
        <d3p1:CashierId>7</d3p1:CashierId>
        <d3p1:CustomReceiptNumber>sample string 2</d3p1:CustomReceiptNumber>
        <d3p1:Customer>sample string 5</d3p1:Customer>
        <d3p1:CustomerId>8</d3p1:CustomerId>
        <d3p1:Date>2025-12-15T16:13:54.3046019-05:00</d3p1:Date>
        <d3p1:DeliveryEmployeeId>1</d3p1:DeliveryEmployeeId>
        <d3p1:DeliveryEmployeeName>sample string 26</d3p1:DeliveryEmployeeName>
        <d3p1:DeliveryProvider>BuiltIn</d3p1:DeliveryProvider>
        <d3p1:ExternalDeliveryProvider>sample string 27</d3p1:ExternalDeliveryProvider>
        <d3p1:IsFirstPayment>true</d3p1:IsFirstPayment>
        <d3p1:IsRestarant>true</d3p1:IsRestarant>
        <d3p1:IsSplitted>sample string 22</d3p1:IsSplitted>
        <d3p1:Location>sample string 11</d3p1:Location>
        <d3p1:OrderSource>POS</d3p1:OrderSource>
        <d3p1:OrderTypeId>1</d3p1:OrderTypeId>
        <d3p1:OrderTypeName>sample string 25</d3p1:OrderTypeName>
        <d3p1:PaymentAmount>12</d3p1:PaymentAmount>
        <d3p1:PaymentDate>2025-12-15T16:13:54.3046019-05:00</d3p1:PaymentDate>
        <d3p1:PaymentId>9</d3p1:PaymentId>
        <d3p1:PaymentMethod>sample string 4</d3p1:PaymentMethod>
        <d3p1:PaymentMethodId>3</d3p1:PaymentMethodId>
        <d3p1:RemainingBalance>21</d3p1:RemainingBalance>
        <d3p1:RewardPointsAmount>13</d3p1:RewardPointsAmount>
        <d3p1:SalesPersonIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d3p1:SalesPersonIds>
        <d3p1:SalesPersons xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:SalesPersons>
        <d3p1:ShippingOption>InStore</d3p1:ShippingOption>
        <d3p1:ShippingStatusId>24</d3p1:ShippingStatusId>
        <d3p1:TicketDiscount>15</d3p1:TicketDiscount>
        <d3p1:TicketId>1</d3p1:TicketId>
        <d3p1:TicketSubtotal>18</d3p1:TicketSubtotal>
        <d3p1:TicketTax>16</d3p1:TicketTax>
        <d3p1:TicketTips>17</d3p1:TicketTips>
        <d3p1:TicketTotal>19</d3p1:TicketTotal>
        <d3p1:TotalPaid>20</d3p1:TotalPaid>
        <d3p1:ZipPostal>sample string 6</d3p1:ZipPostal>
      </d3p1:SalesReportItem>
    </SalesReportItems>
    <SubTotal>5</SubTotal>
    <Tax>3</Tax>
    <Tips>4</Tips>
    <Total>6</Total>
    <TotalPaid>7</TotalPaid>
  </SalesPaymentMethodModel>
</ArrayOfSalesPaymentMethodModel>

URI parameters

Headers | Add header

Body

Status

Headers

Body

POST SalesReport/GenerateReportView

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json

text/json

application/xml, text/xml