GET api/report/x/{subUserId}/{businessDay}

Get X Report for user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subUserId

Id of user

integer

Required

businessDay

Date for which data to fetch

string

Required

Body Parameters

None.

Response Information

Resource Description

XReportDto
NameDescriptionTypeAdditional information
Status

Status of API response

RStatus

None.

Description

Description of Status

string

None.

ReportCalc

Calculation of orders data for x report

Collection of ReportCalculation

None.

Response Formats

application/json

Sample:
{
  "ReportCalc": [
    {
      "Date": "2020-07-20-00-00-00",
      "TotalSales": 42.0,
      "Totaldiscount": 0.0,
      "TotalVoid": 0.0,
      "Netsales": 40.0,
      "Gratuity": 0.0,
      "Tax": 2.0,
      "TotalCash": 10.5,
      "TotalCreditCard": 0.0,
      "TotalLoyaltyOrders": 0.0,
      "TotalCouponOrders": 0.0,
      "TotalGiftcardOrders": 0.0,
      "TotalWalletOrders": 1.0,
      "TotalAggregatorOrders": 2.0,
      "TotalCityLedger": 0.0,
      "TotalOrders": 4,
      "TotalVoidOrders": 0,
      "TotalCashOrders": 1,
      "TotalMultiPayOrders": 0,
      "TotalCardOrders": 0,
      "TotalRefundOrders": 0,
      "Complementory": 0.0,
      "Deliverycharges": 0.0,
      "Giftcards": 0.0,
      "Loyalty": 0.0,
      "Coupon": 0.0,
      "Wallet": 10.5,
      "Aggregator": 21.0,
      "TotalRefund": 0.0,
      "TotalTendered": 40.0,
      "TotalByTransactionType": 42.0
    }
  ],
  "Status": 1,
  "Description": "Report Data Successfully Fetched"
}

text/json

Sample:
{
  "ReportCalc": [
    {
      "Date": "sample string 1",
      "TotalSales": 2.1,
      "Totaldiscount": 3.1,
      "TotalVoid": 4.1,
      "Netsales": 5.1,
      "Gratuity": 6.1,
      "Tax": 7.1,
      "TotalCash": 8.1,
      "TotalCreditCard": 9.1,
      "TotalLoyaltyOrders": 10.1,
      "TotalCouponOrders": 11.1,
      "TotalGiftcardOrders": 12.1,
      "TotalWalletOrders": 13.1,
      "TotalAggregatorOrders": 14.1,
      "TotalCityLedger": 15.1,
      "TotalOrders": 16,
      "TotalVoidOrders": 17,
      "TotalCashOrders": 18,
      "TotalMultiPayOrders": 19,
      "TotalCardOrders": 20,
      "TotalRefundOrders": 21,
      "Complementory": 22.1,
      "Deliverycharges": 23.1,
      "Giftcards": 24.1,
      "Loyalty": 25.1,
      "Coupon": 26.1,
      "Wallet": 27.1,
      "Aggregator": 28.1,
      "TotalRefund": 29.1,
      "TotalTendered": 30.1,
      "TotalByTransactionType": 31.1
    },
    {
      "Date": "sample string 1",
      "TotalSales": 2.1,
      "Totaldiscount": 3.1,
      "TotalVoid": 4.1,
      "Netsales": 5.1,
      "Gratuity": 6.1,
      "Tax": 7.1,
      "TotalCash": 8.1,
      "TotalCreditCard": 9.1,
      "TotalLoyaltyOrders": 10.1,
      "TotalCouponOrders": 11.1,
      "TotalGiftcardOrders": 12.1,
      "TotalWalletOrders": 13.1,
      "TotalAggregatorOrders": 14.1,
      "TotalCityLedger": 15.1,
      "TotalOrders": 16,
      "TotalVoidOrders": 17,
      "TotalCashOrders": 18,
      "TotalMultiPayOrders": 19,
      "TotalCardOrders": 20,
      "TotalRefundOrders": 21,
      "Complementory": 22.1,
      "Deliverycharges": 23.1,
      "Giftcards": 24.1,
      "Loyalty": 25.1,
      "Coupon": 26.1,
      "Wallet": 27.1,
      "Aggregator": 28.1,
      "TotalRefund": 29.1,
      "TotalTendered": 30.1,
      "TotalByTransactionType": 31.1
    }
  ],
  "Status": 1,
  "Description": "sample string 1"
}

text/xml

Sample:
<XReportDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.Response">
  <Description>sample string 1</Description>
  <ReportCalc>
    <ReportCalculation>
      <Date>sample string 1</Date>
      <TotalSales>2.1</TotalSales>
      <Totaldiscount>3.1</Totaldiscount>
      <TotalVoid>4.1</TotalVoid>
      <Netsales>5.1</Netsales>
      <Gratuity>6.1</Gratuity>
      <Tax>7.1</Tax>
      <TotalCash>8.1</TotalCash>
      <TotalCreditCard>9.1</TotalCreditCard>
      <TotalLoyaltyOrders>10.1</TotalLoyaltyOrders>
      <TotalCouponOrders>11.1</TotalCouponOrders>
      <TotalGiftcardOrders>12.1</TotalGiftcardOrders>
      <TotalAggregatorOrders>14.1</TotalAggregatorOrders>
      <TotalWalletOrders>13.1</TotalWalletOrders>
      <TotalCityLedger>15.1</TotalCityLedger>
      <TotalOrders>16</TotalOrders>
      <TotalVoidOrders>17</TotalVoidOrders>
      <TotalCashOrders>18</TotalCashOrders>
      <TotalMultiPayOrders>19</TotalMultiPayOrders>
      <TotalCardOrders>20</TotalCardOrders>
      <TotalRefundOrders>21</TotalRefundOrders>
      <Complementory>22.1</Complementory>
      <Deliverycharges>23.1</Deliverycharges>
      <Giftcards>24.1</Giftcards>
      <Loyalty>25.1</Loyalty>
      <Coupon>26.1</Coupon>
      <Aggregator>28.1</Aggregator>
      <Wallet>27.1</Wallet>
      <TotalRefund>29.1</TotalRefund>
      <TotalTendered>30.1</TotalTendered>
      <TotalByTransactionType>31.1</TotalByTransactionType>
    </ReportCalculation>
    <ReportCalculation>
      <Date>sample string 1</Date>
      <TotalSales>2.1</TotalSales>
      <Totaldiscount>3.1</Totaldiscount>
      <TotalVoid>4.1</TotalVoid>
      <Netsales>5.1</Netsales>
      <Gratuity>6.1</Gratuity>
      <Tax>7.1</Tax>
      <TotalCash>8.1</TotalCash>
      <TotalCreditCard>9.1</TotalCreditCard>
      <TotalLoyaltyOrders>10.1</TotalLoyaltyOrders>
      <TotalCouponOrders>11.1</TotalCouponOrders>
      <TotalGiftcardOrders>12.1</TotalGiftcardOrders>
      <TotalAggregatorOrders>14.1</TotalAggregatorOrders>
      <TotalWalletOrders>13.1</TotalWalletOrders>
      <TotalCityLedger>15.1</TotalCityLedger>
      <TotalOrders>16</TotalOrders>
      <TotalVoidOrders>17</TotalVoidOrders>
      <TotalCashOrders>18</TotalCashOrders>
      <TotalMultiPayOrders>19</TotalMultiPayOrders>
      <TotalCardOrders>20</TotalCardOrders>
      <TotalRefundOrders>21</TotalRefundOrders>
      <Complementory>22.1</Complementory>
      <Deliverycharges>23.1</Deliverycharges>
      <Giftcards>24.1</Giftcards>
      <Loyalty>25.1</Loyalty>
      <Coupon>26.1</Coupon>
      <Aggregator>28.1</Aggregator>
      <Wallet>27.1</Wallet>
      <TotalRefund>29.1</TotalRefund>
      <TotalTendered>30.1</TotalTendered>
      <TotalByTransactionType>31.1</TotalByTransactionType>
    </ReportCalculation>
  </ReportCalc>
  <Status>Success</Status>
</XReportDto>