Trendsic Platform Service

<back to all web services

LaborSalesSummaryRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/laborsales/summary
"use strict";
export class DayView {
    /** @param {{DateIso?:string,GrossSales?:number,TransactionCount?:number,LaborHours?:number,CostedHours?:number,LaborCost?:number,WorkerCount?:number,LaborPct?:number,Splh?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DateIso;
    /** @type {number} */
    GrossSales;
    /** @type {number} */
    TransactionCount;
    /** @type {number} */
    LaborHours;
    /** @type {number} */
    CostedHours;
    /** @type {number} */
    LaborCost;
    /** @type {number} */
    WorkerCount;
    /** @type {?number} */
    LaborPct;
    /** @type {?number} */
    Splh;
}
export class LocationView {
    /** @param {{LocationId?:string,LocationName?:string,GrossSales?:number,TransactionCount?:number,SharePct?:number,BranchId?:string,BranchName?:string,LaborHours?:number,CostedHours?:number,LaborCost?:number,LaborPct?:number,Splh?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {string} */
    LocationName;
    /** @type {number} */
    GrossSales;
    /** @type {number} */
    TransactionCount;
    /** @type {?number} */
    SharePct;
    /** @type {string} */
    BranchId;
    /** @type {string} */
    BranchName;
    /** @type {?number} */
    LaborHours;
    /** @type {?number} */
    CostedHours;
    /** @type {?number} */
    LaborCost;
    /** @type {?number} */
    LaborPct;
    /** @type {?number} */
    Splh;
}
export class TotalsView {
    /** @param {{GrossSales?:number,TransactionCount?:number,LaborHours?:number,CostedHours?:number,LaborCost?:number,LaborPct?:number,Splh?:number,DaysWithSales?:number,DaysWithLabor?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    GrossSales;
    /** @type {number} */
    TransactionCount;
    /** @type {number} */
    LaborHours;
    /** @type {number} */
    CostedHours;
    /** @type {number} */
    LaborCost;
    /** @type {?number} */
    LaborPct;
    /** @type {?number} */
    Splh;
    /** @type {number} */
    DaysWithSales;
    /** @type {number} */
    DaysWithLabor;
}
export class SummaryView {
    /** @param {{Configured?:boolean,Connected?:boolean,NeedsReconnect?:boolean,Currency?:string,Days?:DayView[],Locations?:LocationView[],Totals?:TotalsView,PriorTotals?:TotalsView,AttributionNote?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Configured;
    /** @type {boolean} */
    Connected;
    /** @type {boolean} */
    NeedsReconnect;
    /** @type {string} */
    Currency;
    /** @type {DayView[]} */
    Days = [];
    /** @type {LocationView[]} */
    Locations = [];
    /** @type {TotalsView} */
    Totals;
    /** @type {TotalsView} */
    PriorTotals;
    /** @type {string} */
    AttributionNote;
}
export class LaborSalesSummaryResponse {
    /** @param {{Summary?:SummaryView,FromDate?:string,ToDate?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SummaryView} */
    Summary;
    /** @type {string} */
    FromDate;
    /** @type {string} */
    ToDate;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class LaborSalesSummaryRequest {
    /** @param {{FromDate?:string,ToDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FromDate;
    /** @type {string} */
    ToDate;
}

JavaScript 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>