Trendsic Platform Service

<back to all web services

CostCalcRequest

Requires Authentication
The following routes are available for this service:
POST/v1/workforce/calc
CostCalcRequest Parameters:
NameParameterData TypeRequiredDescription
InputbodyCostInputNo
ContactIDbodyint?No
ProjectIDbodyint?No
ShiftPatternIDbodyint?No
UnitbodystringNo
CostInput Parameters:
NameParameterData TypeRequiredDescription
BaseformdecimalNo
BillRateformdecimalNo
FringeCashformdecimalNo
FringePlanformdecimalNo
IsNightformboolNo
HoursPerDayformdecimalNo
OnDaysformintNo
OnDaysExactformdecimal?No
HasTravelformboolNo
PerDiemEligibleformboolNo
PrevailingWageformboolNo
JurisdictionformstringNo
UnitformstringNo
PriorHoursformdecimalNo
BurdenClassformstringNo
WcRateOverrideformdecimal?No
CostCalcResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformCostBreakdownNo
ResolvedInputformCostInputNo
CanSeePayformboolNo
ResponseStatusformResponseStatusNo
CostBreakdown Parameters:
NameParameterData TypeRequiredDescription
RropformdecimalNo
StformdecimalNo
OtformdecimalNo
DtformdecimalNo
TotalHoursformdecimalNo
StraightformdecimalNo
DiffPayformdecimalNo
OtPremiumformdecimalNo
DtPremiumformdecimalNo
CashWagesformdecimalNo
FringeCashPayformdecimalNo
FringePlanPayformdecimalNo
BurdenPctformdecimalNo
BurdenAmountformdecimalNo
PerDiemAppliesformboolNo
PerDiemCostformdecimalNo
PerDiemTaxableformdecimalNo
PerDiemNonTaxformdecimalNo
LoadedformdecimalNo
RevenueformdecimalNo
MarginformdecimalNo
MarginPctformdecimalNo
OtMultiplierformdecimalNo
DtMultiplierformdecimalNo
PerDiemDailyformdecimalNo
LinesformList<CostLine>No
NotesformList<string>No
CostLine Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
DetailformstringNo
AmountformdecimalNo
RuleIdformstringNo

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