Trendsic Platform Service

LaborSalesSummaryRequest

The following routes are available for this service:
GET,OPTIONS	/v1/laborsales/summary

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DayView:
    date_iso: Optional[str] = None
    gross_sales: Decimal = decimal.Decimal(0)
    transaction_count: int = 0
    labor_hours: Decimal = decimal.Decimal(0)
    costed_hours: Decimal = decimal.Decimal(0)
    labor_cost: Decimal = decimal.Decimal(0)
    worker_count: int = 0
    labor_pct: Optional[Decimal] = None
    splh: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LocationView:
    location_id: Optional[str] = None
    location_name: Optional[str] = None
    gross_sales: Decimal = decimal.Decimal(0)
    transaction_count: int = 0
    share_pct: Optional[Decimal] = None
    branch_id: Optional[str] = None
    branch_name: Optional[str] = None
    labor_hours: Optional[Decimal] = None
    costed_hours: Optional[Decimal] = None
    labor_cost: Optional[Decimal] = None
    labor_pct: Optional[Decimal] = None
    splh: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TotalsView:
    gross_sales: Decimal = decimal.Decimal(0)
    transaction_count: int = 0
    labor_hours: Decimal = decimal.Decimal(0)
    costed_hours: Decimal = decimal.Decimal(0)
    labor_cost: Decimal = decimal.Decimal(0)
    labor_pct: Optional[Decimal] = None
    splh: Optional[Decimal] = None
    days_with_sales: int = 0
    days_with_labor: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SummaryView:
    configured: bool = False
    connected: bool = False
    needs_reconnect: bool = False
    currency: Optional[str] = None
    days: List[DayView] = field(default_factory=list)
    locations: List[LocationView] = field(default_factory=list)
    totals: Optional[TotalsView] = None
    prior_totals: Optional[TotalsView] = None
    attribution_note: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LaborSalesSummaryResponse:
    summary: Optional[SummaryView] = None
    from_date: Optional[str] = None
    to_date: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LaborSalesSummaryRequest:
    from_date: Optional[str] = None
    to_date: Optional[str] = None

Python LaborSalesSummaryRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/laborsales/summary HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Summary":{"Configured":false,"Connected":false,"NeedsReconnect":false,"Currency":"String","Days":[{"DateIso":"String","GrossSales":0,"TransactionCount":0,"LaborHours":0,"CostedHours":0,"LaborCost":0,"WorkerCount":0,"LaborPct":0,"Splh":0}],"Locations":[{"LocationId":"String","LocationName":"String","GrossSales":0,"TransactionCount":0,"SharePct":0,"BranchId":"String","BranchName":"String","LaborHours":0,"CostedHours":0,"LaborCost":0,"LaborPct":0,"Splh":0}],"Totals":{"GrossSales":0,"TransactionCount":0,"LaborHours":0,"CostedHours":0,"LaborCost":0,"LaborPct":0,"Splh":0,"DaysWithSales":0,"DaysWithLabor":0},"PriorTotals":{"GrossSales":0,"TransactionCount":0,"LaborHours":0,"CostedHours":0,"LaborCost":0,"LaborPct":0,"Splh":0,"DaysWithSales":0,"DaysWithLabor":0},"AttributionNote":"String"},"FromDate":"String","ToDate":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}