HomeGuidesAPI ReferenceAnnouncements
HomeGuidesAPI ReferenceChangelogDeveloper Q&A
HomeGuidesAPI ReferenceAnnouncementsLog In
API Reference
  1. Enterprise 9 SOAP API
  2. What's new in 9.24

Changed Entities

WorkOrderCost Entity

AddedDeleted
DefaultNte
NteSourceId
<xs:complexType name="WorkOrderCost">
    <xs:complexContent mixed="false">
        <xs:extension base="tns:CorrigoEntityWithOptimisticLock">
            <xs:sequence>
                <xs:element minOccurs="1" maxOccurs="1" name="WorkOrderId" type="xs:int"/>
                <xs:element minOccurs="1" maxOccurs="1" name="CurrencyTypeId" type="tns:CurrencyType"/>
                <xs:element minOccurs="0" maxOccurs="1" name="BillToOption" type="tns:BillToOption"/>
                <xs:element minOccurs="0" maxOccurs="1" name="CostsTotal" type="tns:MoneyValue"/>
                <xs:element minOccurs="1" maxOccurs="1" name="ApStateId" type="tns:ApState"/>
                <xs:element minOccurs="1" maxOccurs="1" name="ApStatusId" type="xs:int"/>
                <xs:element minOccurs="0" maxOccurs="1" name="JobCode" type="xs:string"/>
                <xs:element minOccurs="0" maxOccurs="1" name="Contract" type="tns:Contract"/>
                <xs:element minOccurs="0" maxOccurs="1" name="AuthorizationCode" type="xs:string"/>
                <xs:element minOccurs="0" maxOccurs="1" name="CheckNumber" type="xs:string"/>
                <xs:element minOccurs="0" maxOccurs="1" name="PaymentAmount" type="tns:MoneyValue"/>
                <xs:element minOccurs="0" maxOccurs="1" name="PaymentNotes" type="xs:string"/>
                <xs:element minOccurs="1" maxOccurs="1" name="CheckCutDate" nillable="true" type="xs:dateTime"/>
                <xs:element minOccurs="1" maxOccurs="1" name="CheckClearDate" nillable="true" type="xs:dateTime"/>
                <xs:element minOccurs="0" maxOccurs="1" name="GlAccount" type="xs:string"/>
                <xs:element minOccurs="0" maxOccurs="1" name="Number" type="xs:string"/>
                <xs:element minOccurs="1" maxOccurs="1" name="VendorInvoiceDate" nillable="true" type="xs:dateTime"/>
                <xs:element minOccurs="1" maxOccurs="1" name="VendorInvoiceReceivedDate" nillable="true" type="xs:dateTime"/>
                <xs:element minOccurs="0" maxOccurs="1" name="VendorInvoiceTotal" type="tns:MoneyValue"/>
                <xs:element minOccurs="1" maxOccurs="1" name="IsPreBilled" type="xs:boolean"/>
                <xs:element minOccurs="0" maxOccurs="1" name="ExpensesTotal" type="tns:MoneyValue"/>
                <xs:element minOccurs="1" maxOccurs="1" name="BillingRule" type="tns:BillingRule"/>
                <xs:element minOccurs="1" maxOccurs="1" name="TaxStatus" type="tns:TaxValidationStatus"/>
                <xs:element minOccurs="0" maxOccurs="1" name="CustomerNte" type="tns:MoneyValue"/>
                <xs:element minOccurs="0" maxOccurs="1" name="Items" type="tns:ArrayOfFinancialItem"/>
                <xs:element minOccurs="0" maxOccurs="1" name="TaxValidationNote" type="tns:Blob"/>
                <xs:element minOccurs="0" maxOccurs="1" name="TaxDetails" type="tns:ArrayOfTaxDetail"/>
                <xs:element minOccurs="0" maxOccurs="1" name="ServiceFeesTotal" type="tns:MoneyValue"/>
                <xs:element minOccurs="1" maxOccurs="1" name="CostStatusId" type="xs:int"/>
                <xs:element minOccurs="1" maxOccurs="1" name="CostState" type="tns:CostState"/>
                <xs:element minOccurs="0" maxOccurs="1" name="ChargeCode" type="tns:ChargeCodeLookup"/>
                <xs:element minOccurs="0" maxOccurs="1" name="BillingAccount" type="tns:BillingAccount"/>
                <xs:element minOccurs="0" maxOccurs="1" name="BillingContact" type="tns:Contact"/>
                <xs:element minOccurs="0" maxOccurs="1" name="ExternalId" type="xs:string"/>
                <xs:element minOccurs="1" maxOccurs="1" name="ServiceDate" nillable="true" type="xs:dateTime"/>
                <xs:element minOccurs="0" maxOccurs="1" name="TaxIdPrimary" type="xs:string"/>
                <xs:element minOccurs="0" maxOccurs="1" name="TaxIdSecondary" type="xs:string"/>
                <xs:element minOccurs="1" maxOccurs="1" name="CanExpedite" type="xs:boolean"/>
                <xs:element minOccurs="1" maxOccurs="1" name="CanEarlyPayment" type="xs:boolean"/>
                <xs:element minOccurs="1" maxOccurs="1" name="IsAvailableExpeditedInvoiceFlags" type="xs:boolean"/>
                <xs:element minOccurs="0" maxOccurs="1" name="DefaultNte" type="tns:MoneyValue"/>
                <xs:element minOccurs="1" maxOccurs="1" name="NteSourceId" type="tns:NteSource"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

ScheduleMetrics Entity

Added
WoPartiallyScheduled
<xs:complexType name="ScheduleMetrics">
  <xs:sequence>
    <xs:element minOccurs="1" maxOccurs="1" name="TotalWOs" type="xs:int"/>
    <xs:element minOccurs="1" maxOccurs="1" name="WoChanged" type="xs:int"/>
    <xs:element minOccurs="1" maxOccurs="1" name="WoAssignedOnly" type="xs:int"/>
    <xs:element minOccurs="1" maxOccurs="1" name="WoScheduledOnly" type="xs:int"/>
    <xs:element minOccurs="1" maxOccurs="1" name="WoAssignedAndScheduled" type="xs:int"/>
    <xs:element minOccurs="1" maxOccurs="1" name="WoUnscheduled" type="xs:int"/>
    <xs:element minOccurs="1" maxOccurs="1" name="WoUnchanged" type="xs:int"/>
    <xs:element minOccurs="1" maxOccurs="1" name="WoPartiallyScheduled" nillable="true" type="xs:int"/>
    <xs:element minOccurs="1" maxOccurs="1" name="UsersWithNewlyAssignedWOs" type="xs:int"/>
    <xs:element minOccurs="1" maxOccurs="1" name="UsersWithNoNewlyAssignedWOs" type="xs:int"/>
    <xs:element minOccurs="0" maxOccurs="1" name="ScheduledMinutes" type="tns:ScheduledMinutes"/>
    <xs:element minOccurs="0" maxOccurs="1" name="TravelTimeMinutes" type="tns:TravelTimeMinutes"/>
    <xs:element minOccurs="0" maxOccurs="1" name="SlaMetPercentage" type="tns:SlaMetPercentage"/>
    <xs:element minOccurs="0" maxOccurs="1" name="OvertimeMinutes" type="tns:OvertimeMinutes"/>
    <xs:element minOccurs="0" maxOccurs="1" name="RescheduledWorkOrders" type="tns:RescheduledWorkOrders"/>
  </xs:sequence>
</xs:complexType>

BaselineComparisonMetrics Entity

Added
MinutesGainedAheadPercentOfOverallBaseline
<xs:complexType name="BaselineComparisonMetrics">
  <xs:sequence>
    <xs:element minOccurs="0" maxOccurs="1" name="ScheduledMinutes" type="tns:BaselineComparisonMetric"/>
    <xs:element minOccurs="0" maxOccurs="1" name="TravelTimeMinutes" type="tns:BaselineComparisonMetric"/>
    <xs:element minOccurs="0" maxOccurs="1" name="OvertimeMinutes" type="tns:BaselineComparisonMetric"/>
    <xs:element minOccurs="0" maxOccurs="1" name="SlaMetPercentage" type="tns:BaselineComparisonMetric"/>
    <xs:element minOccurs="0" maxOccurs="1" name="MinutesGainedAhead" type="tns:BaselineComparisonMetric"/>
    <xs:element minOccurs="1" maxOccurs="1" name="MinutesGainedAheadPercentOfOverallBaseline" nillable="true" type="xs:float"/>
  </xs:sequence>
</xs:complexType>

NarrativeInputs Entity

Added
MinutesGainedAheadPercentOfOverallBaseline
NarrativeCase
MaterialSecondaryDimensions
AdditionalWorkOrderEquivalents
AverageWorkOrderDurationMinutes
DispatcherMinutesSaved
SolutionWorkOrderCountInPeriod
<xs:complexType name="NarrativeInputs">
    <xs:sequence>
        <xs:element minOccurs="1" maxOccurs="1" name="TotalWorkOrders" type="xs:int"/>
        <xs:element minOccurs="1" maxOccurs="1" name="BaselineScheduledCount" type="xs:int"/>
        <xs:element minOccurs="1" maxOccurs="1" name="OptimizedScheduledCount" type="xs:int"/>
        <xs:element minOccurs="1" maxOccurs="1" name="BaselineUnscheduledCount" type="xs:int"/>
        <xs:element minOccurs="1" maxOccurs="1" name="OptimizedUnscheduledCount" type="xs:int"/>
        <xs:element minOccurs="1" maxOccurs="1" name="TotalAssignableUsers" type="xs:int"/>
        <xs:element minOccurs="1" maxOccurs="1" name="SchedulingRangeStart" type="xs:dateTime"/>
        <xs:element minOccurs="1" maxOccurs="1" name="SchedulingRangeEnd" type="xs:dateTime"/>
        <xs:element minOccurs="0" maxOccurs="1" name="ScheduledMinutes" type="tns:BaselineComparisonMetric"/>
        <xs:element minOccurs="0" maxOccurs="1" name="TravelTimeMinutes" type="tns:BaselineComparisonMetric"/>
        <xs:element minOccurs="0" maxOccurs="1" name="OvertimeMinutes" type="tns:BaselineComparisonMetric"/>
        <xs:element minOccurs="0" maxOccurs="1" name="SlaMetPercentage" type="tns:BaselineComparisonMetric"/>
        <xs:element minOccurs="0" maxOccurs="1" name="MinutesGainedAhead" type="tns:BaselineComparisonMetric"/>
        <xs:element minOccurs="1" maxOccurs="1" name="MinutesGainedAheadPercentOfOverallBaseline" nillable="true" type="xs:float"/>
        <xs:element minOccurs="1" maxOccurs="1" name="NarrativeCase" nillable="true" type="tns:NarrativeInputsNarrativeCase"/>
        <xs:element minOccurs="0" maxOccurs="1" name="MaterialSecondaryDimensions" type="tns:ArrayOfMaterialSecondaryDimensions"/>
        <xs:element minOccurs="1" maxOccurs="1" name="AdditionalWorkOrderEquivalents" nillable="true" type="xs:float"/>
        <xs:element minOccurs="1" maxOccurs="1" name="AverageWorkOrderDurationMinutes" nillable="true" type="xs:float"/>
        <xs:element minOccurs="1" maxOccurs="1" name="DispatcherMinutesSaved" nillable="true" type="xs:float"/>
        <xs:element minOccurs="1" maxOccurs="1" name="SolutionWorkOrderCountInPeriod" nillable="true" type="xs:int"/>
    </xs:sequence>
</xs:complexType>

Updated 2 days ago

Did this page help you?

Updated 2 days ago

Did this page help you?