Schedule Cost Breakdown

When requesting an appointment offer, some APIs allow for a "cost breakdown" of the appointment offers to be optionally returned, offering an insight into the various factors that have been taken into account when ServiceScheduling has calculated possible available appointment slots.

The format of this "cost breakdown" structure which will be embedded in API responses is:

Web Service

Type

Description

Req?

Val?

<costBreakDownInformation>

<costNetValue>?</costNetValue> double The sum of all of the (componentCost x componentWeight) values for the appointment offer.

<costBreakDownDetail> There are multiple costBreakDownDetail structures returned in the response - one for each componentId value.

<componentId>?</componentId>

spCostId

The component cost for which the associated componentCost and componentWeight values in the structure are for.

Valid componentId values are as follows:

Value	ServiceScheduling Cost Component
`Travel`	`TRAVEL`
`AOT`	`AUTHORISED_OVERTIME`
`UAOT`	`UNAUTHORISED_OVERTIME`
`TOTA`	`AFTER_SHIFT_TRAVEL`
`TOTB`	`BEFORE_SHIFT_TRAVEL`
`Skill`	`SKILL`
`LK`	`LOCAL_KNOWLEDGE`
`2nd PrefOp`	`SECOND_PREFERRED_OPERATIVE`
`Neither PrefOp`	`NEITHER_PREFERRED_OPERATIVE`
`RU Pref`	`PREFERRED_RU`
`Overdue`	`SLA`
`Dreferred`	`DEFERRED`
`Spares`	`SPARES_DIFFERENCE`
`Work time`	`WORKTIME`
`Travel Home`	`TRAVEL_HOME`
`AOT Travel Home`	`AOT_ON_TRAVEL_HOME`
`UAOT Travel Home`	`UAOT_ON_TRAVEL_HOME`
`HF`	`HARD_FACTOR`
`Sequence`	`SEQUENCE`
`Access Hours`	`ACCESS_HOURS`
`OOSH`	`OUT_OF_SERVICE_HOURS`
`Group ID`	`CUSTOMER_GROUPING`
`Site ID`	`SITE_GROUPING`
`Group Id Sequence`	`CUSTOMER_GROUPING_SEQUENCE`
`Site ID Sequence`	`SITE_GROUPING_SEQUENCE`
`JobDependency Difference`	`JOB_DEPENDENCY_DIFFERENCE`

<componentCost>?</componentCost> double The component cost value for the appointment offer.

<componentWeight>?</componentWeight> double The component weight value for the appointment offer.

</costBreakDownDetail>

</costBreakDownInformation>

Browser not supported