Trendsic Platform Service

<back to all web services

CostCalcRequest

"use strict";
export class CostLine {
    /** @param {{Label?:string,Detail?:string,Amount?:number,RuleId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Label;
    /** @type {string} */
    Detail;
    /** @type {number} */
    Amount;
    /** @type {string} */
    RuleId;
}
export class CostBreakdown {
    /** @param {{Rrop?:number,St?:number,Ot?:number,Dt?:number,TotalHours?:number,Straight?:number,DiffPay?:number,OtPremium?:number,DtPremium?:number,CashWages?:number,FringeCashPay?:number,FringePlanPay?:number,BurdenPct?:number,BurdenAmount?:number,PerDiemApplies?:boolean,PerDiemCost?:number,PerDiemTaxable?:number,PerDiemNonTax?:number,Loaded?:number,Revenue?:number,Margin?:number,MarginPct?:number,OtMultiplier?:number,DtMultiplier?:number,PerDiemDaily?:number,Lines?:CostLine[],Notes?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Rrop;
    /** @type {number} */
    St;
    /** @type {number} */
    Ot;
    /** @type {number} */
    Dt;
    /** @type {number} */
    TotalHours;
    /** @type {number} */
    Straight;
    /** @type {number} */
    DiffPay;
    /** @type {number} */
    OtPremium;
    /** @type {number} */
    DtPremium;
    /** @type {number} */
    CashWages;
    /** @type {number} */
    FringeCashPay;
    /** @type {number} */
    FringePlanPay;
    /** @type {number} */
    BurdenPct;
    /** @type {number} */
    BurdenAmount;
    /** @type {boolean} */
    PerDiemApplies;
    /** @type {number} */
    PerDiemCost;
    /** @type {number} */
    PerDiemTaxable;
    /** @type {number} */
    PerDiemNonTax;
    /** @type {number} */
    Loaded;
    /** @type {number} */
    Revenue;
    /** @type {number} */
    Margin;
    /** @type {number} */
    MarginPct;
    /** @type {number} */
    OtMultiplier;
    /** @type {number} */
    DtMultiplier;
    /** @type {number} */
    PerDiemDaily;
    /** @type {CostLine[]} */
    Lines = [];
    /** @type {string[]} */
    Notes = [];
}
export class CostInput {
    /** @param {{Base?:number,BillRate?:number,FringeCash?:number,FringePlan?:number,IsNight?:boolean,HoursPerDay?:number,OnDays?:number,OnDaysExact?:number,HasTravel?:boolean,PerDiemEligible?:boolean,PrevailingWage?:boolean,Jurisdiction?:string,Unit?:string,PriorHours?:number,BurdenClass?:string,WcRateOverride?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Base;
    /** @type {number} */
    BillRate;
    /** @type {number} */
    FringeCash;
    /** @type {number} */
    FringePlan;
    /** @type {boolean} */
    IsNight;
    /** @type {number} */
    HoursPerDay;
    /** @type {number} */
    OnDays;
    /** @type {?number} */
    OnDaysExact;
    /** @type {boolean} */
    HasTravel;
    /** @type {boolean} */
    PerDiemEligible;
    /** @type {boolean} */
    PrevailingWage;
    /** @type {string} */
    Jurisdiction;
    /** @type {string} */
    Unit;
    /** @type {number} */
    PriorHours;
    /** @type {string} */
    BurdenClass;
    /** @type {?number} */
    WcRateOverride;
}
export class CostCalcResponse {
    /** @param {{Result?:CostBreakdown,ResolvedInput?:CostInput,CanSeePay?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CostBreakdown} */
    Result;
    /** @type {CostInput} */
    ResolvedInput;
    /** @type {boolean} */
    CanSeePay;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CostCalcRequest {
    /** @param {{Input?:CostInput,ContactID?:number,ProjectID?:number,ShiftPatternID?:number,Unit?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CostInput} */
    Input;
    /** @type {?number} */
    ContactID;
    /** @type {?number} */
    ProjectID;
    /** @type {?number} */
    ShiftPatternID;
    /** @type {string} */
    Unit;
}

JavaScript CostCalcRequest DTOs

POST /v1/workforce/calc HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CostCalcRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactID>0</ContactID>
  <Input>
    <Base>0</Base>
    <BillRate>0</BillRate>
    <BurdenClass>String</BurdenClass>
    <FringeCash>0</FringeCash>
    <FringePlan>0</FringePlan>
    <HasTravel>false</HasTravel>
    <HoursPerDay>0</HoursPerDay>
    <IsNight>false</IsNight>
    <Jurisdiction>String</Jurisdiction>
    <OnDays>0</OnDays>
    <OnDaysExact>0</OnDaysExact>
    <PerDiemEligible>false</PerDiemEligible>
    <PrevailingWage>false</PrevailingWage>
    <PriorHours>0</PriorHours>
    <Unit>String</Unit>
    <WcRateOverride>0</WcRateOverride>
  </Input>
  <ProjectID>0</ProjectID>
  <ShiftPatternID>0</ShiftPatternID>
  <Unit>String</Unit>
</CostCalcRequest>

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

<CostCalcResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanSeePay>false</CanSeePay>
  <ResolvedInput>
    <Base>0</Base>
    <BillRate>0</BillRate>
    <BurdenClass>String</BurdenClass>
    <FringeCash>0</FringeCash>
    <FringePlan>0</FringePlan>
    <HasTravel>false</HasTravel>
    <HoursPerDay>0</HoursPerDay>
    <IsNight>false</IsNight>
    <Jurisdiction>String</Jurisdiction>
    <OnDays>0</OnDays>
    <OnDaysExact>0</OnDaysExact>
    <PerDiemEligible>false</PerDiemEligible>
    <PrevailingWage>false</PrevailingWage>
    <PriorHours>0</PriorHours>
    <Unit>String</Unit>
    <WcRateOverride>0</WcRateOverride>
  </ResolvedInput>
  <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>
  <Result>
    <BurdenAmount>0</BurdenAmount>
    <BurdenPct>0</BurdenPct>
    <CashWages>0</CashWages>
    <DiffPay>0</DiffPay>
    <Dt>0</Dt>
    <DtMultiplier>0</DtMultiplier>
    <DtPremium>0</DtPremium>
    <FringeCashPay>0</FringeCashPay>
    <FringePlanPay>0</FringePlanPay>
    <Lines>
      <CostLine>
        <Amount>0</Amount>
        <Detail>String</Detail>
        <Label>String</Label>
        <RuleId>String</RuleId>
      </CostLine>
    </Lines>
    <Loaded>0</Loaded>
    <Margin>0</Margin>
    <MarginPct>0</MarginPct>
    <Notes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Notes>
    <Ot>0</Ot>
    <OtMultiplier>0</OtMultiplier>
    <OtPremium>0</OtPremium>
    <PerDiemApplies>false</PerDiemApplies>
    <PerDiemCost>0</PerDiemCost>
    <PerDiemDaily>0</PerDiemDaily>
    <PerDiemNonTax>0</PerDiemNonTax>
    <PerDiemTaxable>0</PerDiemTaxable>
    <Revenue>0</Revenue>
    <Rrop>0</Rrop>
    <St>0</St>
    <Straight>0</Straight>
    <TotalHours>0</TotalHours>
  </Result>
</CostCalcResponse>