GET api/Sale/GetMonthalySale?outletId={outletId}&year={year}&month={month}

Get the given month sale by outlet

Request Information

URI Parameters

NameDescriptionTypeAdditional information
outletId

globally unique identifier

Required

year

integer

Required

month

integer

Required

Body Parameters

None.

Response Information

Resource Description

MonthlyCategorySale
NameDescriptionTypeAdditional information
Description

string

None.

GrandTotal

decimal number

None.

NetTotal

decimal number

None.

Categories

Collection of SaleDetail

None.

DailySales

Collection of SaleDetail

None.

HourlySales

Collection of SaleDetail

None.

OutletSales

Collection of OutletSale

None.

Response Formats

application/json, text/json

Sample:
{
  "Description": "sample string 1",
  "GrandTotal": 2.0,
  "NetTotal": 3.0,
  "Categories": [
    {
      "$id": "2",
      "GroupName": "sample string 1",
      "GrossTotal": 2.0,
      "NetTotal": 3.0,
      "CreationDate": "2024-05-16T18:46:14.1337441+02:00",
      "SaleDay": "2024-05-16T18:46:14.1337441+02:00",
      "SaleHour": 6,
      "DataType": "sample string 7",
      "OutletId": "6f3ca730-b15a-446c-89a0-6b42a8d4c729"
    },
    {
      "$ref": "2"
    }
  ],
  "DailySales": [
    {
      "$ref": "2"
    },
    {
      "$ref": "2"
    }
  ],
  "HourlySales": [
    {
      "$ref": "2"
    },
    {
      "$ref": "2"
    }
  ],
  "OutletSales": [
    {
      "$id": "3",
      "OutletId": "899c0c3a-2ce5-4482-ad90-3d0942ed36b9",
      "SaleDate": "2024-05-16T18:46:14.1347429+02:00",
      "OutletName": "sample string 3",
      "GrossTotal": 4.0,
      "NetTotal": 5.0
    },
    {
      "$ref": "3"
    }
  ]
}