POST SalesTipsReport/GenerateReport

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.SalesReport.SalesTipsReport.ReportViewModel
NameDescriptionTypeAdditional information
SelectedCompanies

Collection of integer

None.

SelectedEmployee

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
  ],
  "SelectedEmployee": 1,
  "Start": "2024-10-18T04:28:55.9211871-04:00",
  "End": "2024-10-18T04:28:55.9211871-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":28,\"seconds\":55,\"miliseconds\":921}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":28,\"seconds\":55,\"miliseconds\":921}",
  "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.SalesTipsReport">
  <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2024-10-18T04:28:55.9211871-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:55.9211871-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_SelectedEmployee_x003E_k__BackingField>1</_x003C_SelectedEmployee_x003E_k__BackingField>
</ReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IConnect.Domain.Reports.SalesReport.SalesTipsReport.ReportItem
NameDescriptionTypeAdditional information
Date

date

None.

DateFormatted

string

None.

Location

string

None.

LocationID

integer

None.

Customer

string

None.

Employee

string

None.

EmployeeId

integer

None.

TipAmount

decimal number

None.

OrderId

integer

None.

CustomReceiptNumber

string

None.

CompanyOrderNumber

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Date": "2024-10-18T04:28:55.9368141-04:00",
    "DateFormatted": "sample string 2",
    "Location": "sample string 3",
    "LocationID": 4,
    "Customer": "sample string 5",
    "Employee": "sample string 6",
    "EmployeeId": 7,
    "TipAmount": 8.0,
    "OrderId": 9,
    "CustomReceiptNumber": "sample string 10",
    "CompanyOrderNumber": 1
  },
  {
    "Date": "2024-10-18T04:28:55.9368141-04:00",
    "DateFormatted": "sample string 2",
    "Location": "sample string 3",
    "LocationID": 4,
    "Customer": "sample string 5",
    "Employee": "sample string 6",
    "EmployeeId": 7,
    "TipAmount": 8.0,
    "OrderId": 9,
    "CustomReceiptNumber": "sample string 10",
    "CompanyOrderNumber": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfReportItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.SalesTipsReport">
  <ReportItem>
    <CustomReceiptNumber>sample string 10</CustomReceiptNumber>
    <Customer>sample string 5</Customer>
    <Date>2024-10-18T04:28:55.9368141-04:00</Date>
    <DateFormatted>sample string 2</DateFormatted>
    <Employee>sample string 6</Employee>
    <EmployeeId>7</EmployeeId>
    <Location>sample string 3</Location>
    <LocationID>4</LocationID>
    <OrderId>9</OrderId>
    <TipAmount>8</TipAmount>
  </ReportItem>
  <ReportItem>
    <CustomReceiptNumber>sample string 10</CustomReceiptNumber>
    <Customer>sample string 5</Customer>
    <Date>2024-10-18T04:28:55.9368141-04:00</Date>
    <DateFormatted>sample string 2</DateFormatted>
    <Employee>sample string 6</Employee>
    <EmployeeId>7</EmployeeId>
    <Location>sample string 3</Location>
    <LocationID>4</LocationID>
    <OrderId>9</OrderId>
    <TipAmount>8</TipAmount>
  </ReportItem>
</ArrayOfReportItem>