Trendsic Platform Service

CostCalcRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CostLine:
    label: Optional[str] = None
    detail: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    rule_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CostBreakdown:
    rrop: Decimal = decimal.Decimal(0)
    st: Decimal = decimal.Decimal(0)
    ot: Decimal = decimal.Decimal(0)
    dt: Decimal = decimal.Decimal(0)
    total_hours: Decimal = decimal.Decimal(0)
    straight: Decimal = decimal.Decimal(0)
    diff_pay: Decimal = decimal.Decimal(0)
    ot_premium: Decimal = decimal.Decimal(0)
    dt_premium: Decimal = decimal.Decimal(0)
    cash_wages: Decimal = decimal.Decimal(0)
    fringe_cash_pay: Decimal = decimal.Decimal(0)
    fringe_plan_pay: Decimal = decimal.Decimal(0)
    burden_pct: Decimal = decimal.Decimal(0)
    burden_amount: Decimal = decimal.Decimal(0)
    per_diem_applies: bool = False
    per_diem_cost: Decimal = decimal.Decimal(0)
    per_diem_taxable: Decimal = decimal.Decimal(0)
    per_diem_non_tax: Decimal = decimal.Decimal(0)
    loaded: Decimal = decimal.Decimal(0)
    revenue: Decimal = decimal.Decimal(0)
    margin: Decimal = decimal.Decimal(0)
    margin_pct: Decimal = decimal.Decimal(0)
    ot_multiplier: Decimal = decimal.Decimal(0)
    dt_multiplier: Decimal = decimal.Decimal(0)
    per_diem_daily: Decimal = decimal.Decimal(0)
    lines: List[CostLine] = field(default_factory=list)
    notes: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CostInput:
    base: Decimal = decimal.Decimal(0)
    bill_rate: Decimal = decimal.Decimal(0)
    fringe_cash: Decimal = decimal.Decimal(0)
    fringe_plan: Decimal = decimal.Decimal(0)
    is_night: bool = False
    hours_per_day: Decimal = decimal.Decimal(0)
    on_days: int = 0
    on_days_exact: Optional[Decimal] = None
    has_travel: bool = False
    per_diem_eligible: bool = False
    prevailing_wage: bool = False
    jurisdiction: Optional[str] = None
    unit: Optional[str] = None
    prior_hours: Decimal = decimal.Decimal(0)
    burden_class: Optional[str] = None
    wc_rate_override: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CostCalcResponse:
    result: Optional[CostBreakdown] = None
    resolved_input: Optional[CostInput] = None
    can_see_pay: bool = False
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CostCalcRequest:
    input: Optional[CostInput] = None
    contact_i_d: Optional[int] = None
    project_i_d: Optional[int] = None
    shift_pattern_i_d: Optional[int] = None
    unit: Optional[str] = None

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