Trendsic Platform Service

<back to all web services

CostCalcRequest

Requires Authentication
The following routes are available for this service:
POST/v1/workforce/calc
"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

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.

POST /v1/workforce/calc HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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
		}
	}
}