POST BI/GetSalesOverview

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.CommonReport.BusinessIntelligence.ReportViewModel
NameDescriptionTypeAdditional information
SelectedCompanies

Collection of integer

None.
TopOrSlow

boolean

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
  ],
  "TopOrSlow": true,
  "Start": "2024-10-18T04:28:54.0305723-04:00",
  "End": "2024-10-18T04:28:54.0305723-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":28,\"seconds\":54,\"miliseconds\":30}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":28,\"seconds\":54,\"miliseconds\":30}",
  "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.CommonReport.BusinessIntelligence">
  <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2024-10-18T04:28:54.0305723-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">2024-10-18T04:28:54.0305723-04:00</_x003C_Start_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_TopOrSlow_x003E_k__BackingField>true</_x003C_TopOrSlow_x003E_k__BackingField>
</ReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.ReportingApi.Core.ApiResponseOfSystem.Collections.Generic.ListOfIConnect.Domain.Dashboard.PulseDashboardSalesDetail
NameDescriptionTypeAdditional information
StatusCode

IConnect.ReportingApi.Core.ApiStatusCode

None.
Message

string

None.
Data

Collection of IConnect.Domain.Dashboard.PulseDashboardSalesDetail

None.
IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "StatusCode": 0,
  "Message": "sample string 1",
  "Data": [
    {
      "Time": "2024-10-18T04:28:54.0305723-04:00",
      "FormattedTime": "sample string 2",
      "NumberOfTransactions": 3,
      "AverageSalePerTransaction": 4.0,
      "Discounts": 5.0,
      "Tips": 6.0,
      "Commisions": 7.0,
      "Sales": 8.0,
      "ServiceSales": 9.0,
      "ProductSales": 10.0,
      "CostOfGoodsSold": 16.0,
      "TargetLaborCost": 17.0,
      "ActualLaborCost": 18.0,
      "NewCustomers": 19,
      "ProductSalesGoal": 20.0,
      "ServiceSalesGoal": 21.0,
      "RealPayment": 22.0,
      "SalesByOrderSource": [
        {
          "Name": "sample string 2",
          "TotalSales": 3.0,
          "NumberOfTransactions": 4
        },
        {
          "Name": "sample string 2",
          "TotalSales": 3.0,
          "NumberOfTransactions": 4
        }
      ],
      "SalesByShippingOption": [
        {
          "Name": "sample string 2",
          "TotalSales": 3.0,
          "NumberOfTransactions": 4
        },
        {
          "Name": "sample string 2",
          "TotalSales": 3.0,
          "NumberOfTransactions": 4
        }
      ]
    },
    {
      "Time": "2024-10-18T04:28:54.0305723-04:00",
      "FormattedTime": "sample string 2",
      "NumberOfTransactions": 3,
      "AverageSalePerTransaction": 4.0,
      "Discounts": 5.0,
      "Tips": 6.0,
      "Commisions": 7.0,
      "Sales": 8.0,
      "ServiceSales": 9.0,
      "ProductSales": 10.0,
      "CostOfGoodsSold": 16.0,
      "TargetLaborCost": 17.0,
      "ActualLaborCost": 18.0,
      "NewCustomers": 19,
      "ProductSalesGoal": 20.0,
      "ServiceSalesGoal": 21.0,
      "RealPayment": 22.0,
      "SalesByOrderSource": [
        {
          "Name": "sample string 2",
          "TotalSales": 3.0,
          "NumberOfTransactions": 4
        },
        {
          "Name": "sample string 2",
          "TotalSales": 3.0,
          "NumberOfTransactions": 4
        }
      ],
      "SalesByShippingOption": [
        {
          "Name": "sample string 2",
          "TotalSales": 3.0,
          "NumberOfTransactions": 4
        },
        {
          "Name": "sample string 2",
          "TotalSales": 3.0,
          "NumberOfTransactions": 4
        }
      ]
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample: 
<ApiResponseOfArrayOfPulseDashboardSalesDetailaaaYI6zx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.ReportingApi.Core">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
    <d2p1:PulseDashboardSalesDetail>
      <d2p1:ActualLaborCost>18</d2p1:ActualLaborCost>
      <d2p1:AverageSalePerTransaction>4</d2p1:AverageSalePerTransaction>
      <d2p1:Commisions>7</d2p1:Commisions>
      <d2p1:CostOfGoodsSold>16</d2p1:CostOfGoodsSold>
      <d2p1:Discounts>5</d2p1:Discounts>
      <d2p1:FormattedTime>sample string 2</d2p1:FormattedTime>
      <d2p1:GiftCardSales>11</d2p1:GiftCardSales>
      <d2p1:GiftCardTaxes>14</d2p1:GiftCardTaxes>
      <d2p1:NewCustomers>19</d2p1:NewCustomers>
      <d2p1:NumberOfTransactions>3</d2p1:NumberOfTransactions>
      <d2p1:OrderTotal>15</d2p1:OrderTotal>
      <d2p1:ProductSales>10</d2p1:ProductSales>
      <d2p1:ProductSalesGoal>20</d2p1:ProductSalesGoal>
      <d2p1:ProductTaxes>13</d2p1:ProductTaxes>
      <d2p1:RealPayment>22</d2p1:RealPayment>
      <d2p1:Sales>8</d2p1:Sales>
      <d2p1:SalesByOrderSource>
        <d2p1:PulseDashboardSalesGroupedBy>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:NumberOfTransactions>4</d2p1:NumberOfTransactions>
          <d2p1:TotalSales>3</d2p1:TotalSales>
        </d2p1:PulseDashboardSalesGroupedBy>
        <d2p1:PulseDashboardSalesGroupedBy>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:NumberOfTransactions>4</d2p1:NumberOfTransactions>
          <d2p1:TotalSales>3</d2p1:TotalSales>
        </d2p1:PulseDashboardSalesGroupedBy>
      </d2p1:SalesByOrderSource>
      <d2p1:SalesByShippingOption>
        <d2p1:PulseDashboardSalesGroupedBy>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:NumberOfTransactions>4</d2p1:NumberOfTransactions>
          <d2p1:TotalSales>3</d2p1:TotalSales>
        </d2p1:PulseDashboardSalesGroupedBy>
        <d2p1:PulseDashboardSalesGroupedBy>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:NumberOfTransactions>4</d2p1:NumberOfTransactions>
          <d2p1:TotalSales>3</d2p1:TotalSales>
        </d2p1:PulseDashboardSalesGroupedBy>
      </d2p1:SalesByShippingOption>
      <d2p1:ServiceSales>9</d2p1:ServiceSales>
      <d2p1:ServiceSalesGoal>21</d2p1:ServiceSalesGoal>
      <d2p1:ServiceTaxes>12</d2p1:ServiceTaxes>
      <d2p1:TargetLaborCost>17</d2p1:TargetLaborCost>
      <d2p1:Time>2024-10-18T04:28:54.0305723-04:00</d2p1:Time>
      <d2p1:Tips>6</d2p1:Tips>
    </d2p1:PulseDashboardSalesDetail>
    <d2p1:PulseDashboardSalesDetail>
      <d2p1:ActualLaborCost>18</d2p1:ActualLaborCost>
      <d2p1:AverageSalePerTransaction>4</d2p1:AverageSalePerTransaction>
      <d2p1:Commisions>7</d2p1:Commisions>
      <d2p1:CostOfGoodsSold>16</d2p1:CostOfGoodsSold>
      <d2p1:Discounts>5</d2p1:Discounts>
      <d2p1:FormattedTime>sample string 2</d2p1:FormattedTime>
      <d2p1:GiftCardSales>11</d2p1:GiftCardSales>
      <d2p1:GiftCardTaxes>14</d2p1:GiftCardTaxes>
      <d2p1:NewCustomers>19</d2p1:NewCustomers>
      <d2p1:NumberOfTransactions>3</d2p1:NumberOfTransactions>
      <d2p1:OrderTotal>15</d2p1:OrderTotal>
      <d2p1:ProductSales>10</d2p1:ProductSales>
      <d2p1:ProductSalesGoal>20</d2p1:ProductSalesGoal>
      <d2p1:ProductTaxes>13</d2p1:ProductTaxes>
      <d2p1:RealPayment>22</d2p1:RealPayment>
      <d2p1:Sales>8</d2p1:Sales>
      <d2p1:SalesByOrderSource>
        <d2p1:PulseDashboardSalesGroupedBy>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:NumberOfTransactions>4</d2p1:NumberOfTransactions>
          <d2p1:TotalSales>3</d2p1:TotalSales>
        </d2p1:PulseDashboardSalesGroupedBy>
        <d2p1:PulseDashboardSalesGroupedBy>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:NumberOfTransactions>4</d2p1:NumberOfTransactions>
          <d2p1:TotalSales>3</d2p1:TotalSales>
        </d2p1:PulseDashboardSalesGroupedBy>
      </d2p1:SalesByOrderSource>
      <d2p1:SalesByShippingOption>
        <d2p1:PulseDashboardSalesGroupedBy>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:NumberOfTransactions>4</d2p1:NumberOfTransactions>
          <d2p1:TotalSales>3</d2p1:TotalSales>
        </d2p1:PulseDashboardSalesGroupedBy>
        <d2p1:PulseDashboardSalesGroupedBy>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:NumberOfTransactions>4</d2p1:NumberOfTransactions>
          <d2p1:TotalSales>3</d2p1:TotalSales>
        </d2p1:PulseDashboardSalesGroupedBy>
      </d2p1:SalesByShippingOption>
      <d2p1:ServiceSales>9</d2p1:ServiceSales>
      <d2p1:ServiceSalesGoal>21</d2p1:ServiceSalesGoal>
      <d2p1:ServiceTaxes>12</d2p1:ServiceTaxes>
      <d2p1:TargetLaborCost>17</d2p1:TargetLaborCost>
      <d2p1:Time>2024-10-18T04:28:54.0305723-04:00</d2p1:Time>
      <d2p1:Tips>6</d2p1:Tips>
    </d2p1:PulseDashboardSalesDetail>
  </Data>
  <Message>sample string 1</Message>
  <StatusCode>Success</StatusCode>
</ApiResponseOfArrayOfPulseDashboardSalesDetailaaaYI6zx>