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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Input":{"Base":0,"BillRate":0,"FringeCash":0,"FringePlan":0,"IsNight":false,"HoursPerDay":0,"OnDays":0,"OnDaysExact":0,"HasTravel":false,"PerDiemEligible":false,"PrevailingWage":false,"Jurisdiction":"String","Unit":"String","PriorHours":0,"BurdenClass":"String","WcRateOverride":0},"ContactID":0,"ProjectID":0,"ShiftPatternID":0,"Unit":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Result":{"Rrop":0,"St":0,"Ot":0,"Dt":0,"TotalHours":0,"Straight":0,"DiffPay":0,"OtPremium":0,"DtPremium":0,"CashWages":0,"FringeCashPay":0,"FringePlanPay":0,"BurdenPct":0,"BurdenAmount":0,"PerDiemApplies":false,"PerDiemCost":0,"PerDiemTaxable":0,"PerDiemNonTax":0,"Loaded":0,"Revenue":0,"Margin":0,"MarginPct":0,"OtMultiplier":0,"DtMultiplier":0,"PerDiemDaily":0,"Lines":[{"Label":"String","Detail":"String","Amount":0,"RuleId":"String"}],"Notes":["String"]},"ResolvedInput":{"Base":0,"BillRate":0,"FringeCash":0,"FringePlan":0,"IsNight":false,"HoursPerDay":0,"OnDays":0,"OnDaysExact":0,"HasTravel":false,"PerDiemEligible":false,"PrevailingWage":false,"Jurisdiction":"String","Unit":"String","PriorHours":0,"BurdenClass":"String","WcRateOverride":0},"CanSeePay":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}