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 .xml suffix or ?format=xml

HTTP + XML

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/xml

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

<LaborSalesSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FromDate>String</FromDate>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Summary>
    <AttributionNote>String</AttributionNote>
    <Configured>false</Configured>
    <Connected>false</Connected>
    <Currency>String</Currency>
    <Days>
      <LaborSalesService.DayView>
        <CostedHours>0</CostedHours>
        <DateIso>String</DateIso>
        <GrossSales>0</GrossSales>
        <LaborCost>0</LaborCost>
        <LaborHours>0</LaborHours>
        <LaborPct>0</LaborPct>
        <Splh>0</Splh>
        <TransactionCount>0</TransactionCount>
        <WorkerCount>0</WorkerCount>
      </LaborSalesService.DayView>
    </Days>
    <Locations>
      <LaborSalesService.LocationView>
        <BranchId>String</BranchId>
        <BranchName>String</BranchName>
        <CostedHours>0</CostedHours>
        <GrossSales>0</GrossSales>
        <LaborCost>0</LaborCost>
        <LaborHours>0</LaborHours>
        <LaborPct>0</LaborPct>
        <LocationId>String</LocationId>
        <LocationName>String</LocationName>
        <SharePct>0</SharePct>
        <Splh>0</Splh>
        <TransactionCount>0</TransactionCount>
      </LaborSalesService.LocationView>
    </Locations>
    <NeedsReconnect>false</NeedsReconnect>
    <PriorTotals>
      <CostedHours>0</CostedHours>
      <DaysWithLabor>0</DaysWithLabor>
      <DaysWithSales>0</DaysWithSales>
      <GrossSales>0</GrossSales>
      <LaborCost>0</LaborCost>
      <LaborHours>0</LaborHours>
      <LaborPct>0</LaborPct>
      <Splh>0</Splh>
      <TransactionCount>0</TransactionCount>
    </PriorTotals>
    <Totals>
      <CostedHours>0</CostedHours>
      <DaysWithLabor>0</DaysWithLabor>
      <DaysWithSales>0</DaysWithSales>
      <GrossSales>0</GrossSales>
      <LaborCost>0</LaborCost>
      <LaborHours>0</LaborHours>
      <LaborPct>0</LaborPct>
      <Splh>0</Splh>
      <TransactionCount>0</TransactionCount>
    </Totals>
  </Summary>
  <ToDate>String</ToDate>
</LaborSalesSummaryResponse>