TicketUserServices

RefreshmentsOverviewRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin	Required permission:	Sales.Total

The following routes are available for this service:
POST	/sales/refreshments/overview

import java.math.*
import java.util.*
import net.servicestack.client.*


open class RefreshmentsOverviewRequest
{
    var ownerId:Int? = null
    var seriesId:Int? = null
    var fromUtc:Date? = null
    var toUtc:Date? = null
    var compareFromUtc:Date? = null
    var compareToUtc:Date? = null
    var bucket:String? = null
    var topEventsLimit:Int? = null
    var recentOrdersLimit:Int? = null
}

open class RefreshmentsOverviewResult
{
    var current:RefreshmentsKpis? = null
    var previous:RefreshmentsKpis? = null
    var delta:RefreshmentsDeltas? = null
    var trend:ArrayList<SalesTrendBucket> = ArrayList<SalesTrendBucket>()
    var previousTrend:ArrayList<SalesTrendBucket> = ArrayList<SalesTrendBucket>()
    var products:ArrayList<RefreshmentsProduct> = ArrayList<RefreshmentsProduct>()
    var events:ArrayList<RefreshmentsEventRow> = ArrayList<RefreshmentsEventRow>()
    var byHourOfDay:ArrayList<SalesHourBucket> = ArrayList<SalesHourBucket>()
    var byDayOfWeek:ArrayList<SalesDowBucket> = ArrayList<SalesDowBucket>()
    var byPaymentMethod:ArrayList<RefreshmentsPaymentMethodRow> = ArrayList<RefreshmentsPaymentMethodRow>()
    var recentOrders:ArrayList<RefreshmentsRecentOrder> = ArrayList<RefreshmentsRecentOrder>()
    var hasAnyDataEver:Boolean? = null
    var bucket:String? = null
    var freshnessUtc:Date? = null
    var statusCode:Int? = null
    var message:String? = null
}

open class RefreshmentsKpis
{
    var revenue:BigDecimal? = null
    var refunded:BigDecimal? = null
    var units:Int? = null
    var orders:Int? = null
    var aov:BigDecimal? = null
    var unitsPerOrder:BigDecimal? = null
    var attendance:Int? = null
    var perCap:BigDecimal? = null
}

open class RefreshmentsDeltas
{
    var revenue:KpiDelta? = null
    var refunded:KpiDelta? = null
    var units:KpiDelta? = null
    var orders:KpiDelta? = null
    var aov:KpiDelta? = null
    var perCap:KpiDelta? = null
}

open class KpiDelta
{
    var abs:BigDecimal? = null
    var pct:Double? = null
    var dir:String? = null
}

open class SalesTrendBucket
{
    var bucket:Date? = null
    var revenue:BigDecimal? = null
    var tickets:Int? = null
}

open class RefreshmentsProduct
{
    var ticketTypeId:Int? = null
    var name:String? = null
    var units:Int? = null
    var revenue:BigDecimal? = null
    var orders:Int? = null
    var lastSoldAt:Date? = null
}

open class RefreshmentsEventRow
{
    var eventId:Int? = null
    var eventName:String? = null
    var eventDate:Date? = null
    var revenue:BigDecimal? = null
    var units:Int? = null
    var orders:Int? = null
    var attendance:Int? = null
    var perCap:BigDecimal? = null
}

open class SalesHourBucket
{
    var hour:Int? = null
    var revenue:BigDecimal? = null
    var orders:Int? = null
    var tickets:Int? = null
}

open class SalesDowBucket
{
    var dow:Int? = null
    var revenue:BigDecimal? = null
    var orders:Int? = null
    var tickets:Int? = null
}

open class RefreshmentsPaymentMethodRow
{
    var paymentMethodId:String? = null
    var revenue:BigDecimal? = null
    var units:Int? = null
    var orders:Int? = null
}

open class RefreshmentsRecentOrder
{
    var ticketId:Int? = null
    var createdAt:Date? = null
    var eventName:String? = null
    var amount:BigDecimal? = null
    var units:Int? = null
    var paymentMethodId:String? = null
}

Kotlin RefreshmentsOverviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sales/refreshments/overview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ownerId":0,"seriesId":0,"fromUtc":"0001-01-01T00:00:00.0000000","toUtc":"0001-01-01T00:00:00.0000000","compareFromUtc":"0001-01-01T00:00:00.0000000","compareToUtc":"0001-01-01T00:00:00.0000000","bucket":"String","topEventsLimit":0,"recentOrdersLimit":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"current":{"revenue":0,"refunded":0,"units":0,"orders":0,"aov":0,"unitsPerOrder":0,"attendance":0,"perCap":0},"previous":{"revenue":0,"refunded":0,"units":0,"orders":0,"aov":0,"unitsPerOrder":0,"attendance":0,"perCap":0},"delta":{"revenue":{"abs":0,"pct":0,"dir":"String"},"refunded":{"abs":0,"pct":0,"dir":"String"},"units":{"abs":0,"pct":0,"dir":"String"},"orders":{"abs":0,"pct":0,"dir":"String"},"aov":{"abs":0,"pct":0,"dir":"String"},"perCap":{"abs":0,"pct":0,"dir":"String"}},"trend":[{"bucket":"0001-01-01T00:00:00.0000000","revenue":0,"tickets":0}],"previousTrend":[{"bucket":"0001-01-01T00:00:00.0000000","revenue":0,"tickets":0}],"products":[{"ticketTypeId":0,"name":"String","units":0,"revenue":0,"orders":0,"lastSoldAt":"0001-01-01T00:00:00.0000000"}],"events":[{"eventId":0,"eventName":"String","eventDate":"0001-01-01T00:00:00.0000000","revenue":0,"units":0,"orders":0,"attendance":0,"perCap":0}],"byHourOfDay":[{"hour":0,"revenue":0,"orders":0,"tickets":0}],"byDayOfWeek":[{"dow":0,"revenue":0,"orders":0,"tickets":0}],"byPaymentMethod":[{"paymentMethodId":"String","revenue":0,"units":0,"orders":0}],"recentOrders":[{"ticketId":0,"createdAt":"0001-01-01T00:00:00.0000000","eventName":"String","amount":0,"units":0,"paymentMethodId":"String"}],"hasAnyDataEver":false,"bucket":"String","freshnessUtc":"0001-01-01T00:00:00.0000000","statusCode":0,"message":"String"}