Trendsic Platform Service

<back to all web services

CostCalcRequest

Requires Authentication
The following routes are available for this service:
POST/v1/workforce/calc

export class CostLine
{
    public Label: string;
    public Detail: string;
    public Amount: number;
    public RuleId: string;

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

export class CostBreakdown
{
    public Rrop: number;
    public St: number;
    public Ot: number;
    public Dt: number;
    public TotalHours: number;
    public Straight: number;
    public DiffPay: number;
    public OtPremium: number;
    public DtPremium: number;
    public CashWages: number;
    public FringeCashPay: number;
    public FringePlanPay: number;
    public BurdenPct: number;
    public BurdenAmount: number;
    public PerDiemApplies: boolean;
    public PerDiemCost: number;
    public PerDiemTaxable: number;
    public PerDiemNonTax: number;
    public Loaded: number;
    public Revenue: number;
    public Margin: number;
    public MarginPct: number;
    public OtMultiplier: number;
    public DtMultiplier: number;
    public PerDiemDaily: number;
    public Lines: CostLine[] = [];
    public Notes: string[] = [];

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

export class CostInput
{
    public Base: number;
    public BillRate: number;
    public FringeCash: number;
    public FringePlan: number;
    public IsNight: boolean;
    public HoursPerDay: number;
    public OnDays: number;
    public OnDaysExact?: number;
    public HasTravel: boolean;
    public PerDiemEligible: boolean;
    public PrevailingWage: boolean;
    public Jurisdiction: string;
    public Unit: string;
    public PriorHours: number;
    public BurdenClass: string;
    public WcRateOverride?: number;

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

export class CostCalcResponse
{
    public Result: CostBreakdown;
    public ResolvedInput: CostInput;
    public CanSeePay: boolean;
    public ResponseStatus: ResponseStatus;

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

export class CostCalcRequest
{
    public Input: CostInput;
    public ContactID?: number;
    public ProjectID?: number;
    public ShiftPatternID?: number;
    public Unit: string;

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

TypeScript CostCalcRequest 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.

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>