Trendsic Platform Service

<back to all web services

LaborSalesSummaryRequest

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

export class DayView
{
    public DateIso: string;
    public GrossSales: number;
    public TransactionCount: number;
    public LaborHours: number;
    public CostedHours: number;
    public LaborCost: number;
    public WorkerCount: number;
    public LaborPct?: number;
    public Splh?: number;

    public constructor(init?: Partial<DayView>) { (Object as any).assign(this, init); }
}

export class LocationView
{
    public LocationId: string;
    public LocationName: string;
    public GrossSales: number;
    public TransactionCount: number;
    public SharePct?: number;
    public BranchId: string;
    public BranchName: string;
    public LaborHours?: number;
    public CostedHours?: number;
    public LaborCost?: number;
    public LaborPct?: number;
    public Splh?: number;

    public constructor(init?: Partial<LocationView>) { (Object as any).assign(this, init); }
}

export class TotalsView
{
    public GrossSales: number;
    public TransactionCount: number;
    public LaborHours: number;
    public CostedHours: number;
    public LaborCost: number;
    public LaborPct?: number;
    public Splh?: number;
    public DaysWithSales: number;
    public DaysWithLabor: number;

    public constructor(init?: Partial<TotalsView>) { (Object as any).assign(this, init); }
}

export class SummaryView
{
    public Configured: boolean;
    public Connected: boolean;
    public NeedsReconnect: boolean;
    public Currency: string;
    public Days: DayView[] = [];
    public Locations: LocationView[] = [];
    public Totals: TotalsView;
    public PriorTotals: TotalsView;
    public AttributionNote: string;

    public constructor(init?: Partial<SummaryView>) { (Object as any).assign(this, init); }
}

export class LaborSalesSummaryResponse
{
    public Summary: SummaryView;
    public FromDate: string;
    public ToDate: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<LaborSalesSummaryResponse>) { (Object as any).assign(this, init); }
}

export class LaborSalesSummaryRequest
{
    public FromDate: string;
    public ToDate: string;

    public constructor(init?: Partial<LaborSalesSummaryRequest>) { (Object as any).assign(this, init); }
}

TypeScript LaborSalesSummaryRequest DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}