Trendsic Platform Service

<back to all web services

CostCalcRequest

Requires Authentication
The following routes are available for this service:
POST/v1/workforce/calc
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CostLine() = 
        member val Label:String = null with get,set
        member val Detail:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val RuleId:String = null with get,set

    [<AllowNullLiteral>]
    type CostBreakdown() = 
        member val Rrop:Decimal = new Decimal() with get,set
        member val St:Decimal = new Decimal() with get,set
        member val Ot:Decimal = new Decimal() with get,set
        member val Dt:Decimal = new Decimal() with get,set
        member val TotalHours:Decimal = new Decimal() with get,set
        member val Straight:Decimal = new Decimal() with get,set
        member val DiffPay:Decimal = new Decimal() with get,set
        member val OtPremium:Decimal = new Decimal() with get,set
        member val DtPremium:Decimal = new Decimal() with get,set
        member val CashWages:Decimal = new Decimal() with get,set
        member val FringeCashPay:Decimal = new Decimal() with get,set
        member val FringePlanPay:Decimal = new Decimal() with get,set
        member val BurdenPct:Decimal = new Decimal() with get,set
        member val BurdenAmount:Decimal = new Decimal() with get,set
        member val PerDiemApplies:Boolean = new Boolean() with get,set
        member val PerDiemCost:Decimal = new Decimal() with get,set
        member val PerDiemTaxable:Decimal = new Decimal() with get,set
        member val PerDiemNonTax:Decimal = new Decimal() with get,set
        member val Loaded:Decimal = new Decimal() with get,set
        member val Revenue:Decimal = new Decimal() with get,set
        member val Margin:Decimal = new Decimal() with get,set
        member val MarginPct:Decimal = new Decimal() with get,set
        member val OtMultiplier:Decimal = new Decimal() with get,set
        member val DtMultiplier:Decimal = new Decimal() with get,set
        member val PerDiemDaily:Decimal = new Decimal() with get,set
        member val Lines:ResizeArray<CostLine> = new ResizeArray<CostLine>() with get,set
        member val Notes:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type CostInput() = 
        member val Base:Decimal = new Decimal() with get,set
        member val BillRate:Decimal = new Decimal() with get,set
        member val FringeCash:Decimal = new Decimal() with get,set
        member val FringePlan:Decimal = new Decimal() with get,set
        member val IsNight:Boolean = new Boolean() with get,set
        member val HoursPerDay:Decimal = new Decimal() with get,set
        member val OnDays:Int32 = new Int32() with get,set
        member val OnDaysExact:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val HasTravel:Boolean = new Boolean() with get,set
        member val PerDiemEligible:Boolean = new Boolean() with get,set
        member val PrevailingWage:Boolean = new Boolean() with get,set
        member val Jurisdiction:String = null with get,set
        member val Unit:String = null with get,set
        member val PriorHours:Decimal = new Decimal() with get,set
        member val BurdenClass:String = null with get,set
        member val WcRateOverride:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type CostCalcResponse() = 
        member val Result:CostBreakdown = null with get,set
        member val ResolvedInput:CostInput = null with get,set
        member val CanSeePay:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CostCalcRequest() = 
        member val Input:CostInput = null with get,set
        member val ContactID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ProjectID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ShiftPatternID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Unit:String = null with get,set

F# 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>