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

Changed Entities

RcsAction Entity

Element Added
RcsExtensionReasonId
LeaksFound
EquipmentDestinationManager
IsALDCalibrationSuccess
EquipmentDestinationId
RemainingCapacity
<xs:complexType name="RcsAction" mixed="false">
	<xs:complexContent>
		<xs:extension base="CorrigoEntityWithOptimisticLock">
			<xs:sequence>
				<xs:element name="TypeId" type="RcsActionType"/>
				<xs:element name="DtWhen" type="xs:dateTime" nillable="true"/>
				<xs:element name="ActorId" type="xs:int" nillable="true"/>
				<xs:element name="ActorTypeId" type="ActorType" nillable="true"/>
				<xs:element name="CertNumber" type="xs:string" minOccurs="0"/>
				<xs:element name="Product" type="Product" minOccurs="0"/>
				<xs:element name="Qty" type="xs:decimal" nillable="true"/>
				<xs:element name="IsMetric" type="xs:boolean"/>
				<xs:element name="CostValue" type="xs:decimal" nillable="true"/>
				<xs:element name="Supplier" type="Employee" minOccurs="0"/>
				<xs:element name="PoNumber" type="xs:string" minOccurs="0"/>
				<xs:element name="WorkOrderId" type="xs:int"/>
				<xs:element name="Comments" type="xs:string" minOccurs="0"/>
				<xs:element name="Circuit" type="RcsCircuit" minOccurs="0"/>
				<xs:element name="CircuitNumber" type="xs:string" minOccurs="0"/>
				<xs:element name="Cylinder" type="RcsCylinder" minOccurs="0"/>
				<xs:element name="CylinderNumber" type="xs:string" minOccurs="0"/>
				<xs:element name="NoLeakRate" type="xs:boolean"/>
				<xs:element name="RcsTestMethodId" type="RcsTestMethod"/>
				<xs:element name="IsTestPassed" type="xs:boolean"/>
				<xs:element name="IsContactNotified" type="xs:boolean"/>
				<xs:element name="CylinderSource" type="RcsCylinder" minOccurs="0"/>
				<xs:element name="MoneyId" type="CurrencyType"/>
				<xs:element name="QtyCylinder" type="xs:decimal" nillable="true"/>
				<xs:element name="QtyCylinderSource" type="xs:decimal" nillable="true"/>
				<xs:element name="RefrigerantEvacuationConfirmed" type="xs:boolean"/>
				<xs:element name="RcsStockTypeId" type="RcsActionStockType"/>
				<xs:element name="ShippedTo" type="xs:string" minOccurs="0"/>
				<xs:element name="DtShipment" type="xs:dateTime" nillable="true"/>
				<xs:element name="ReclamationCompany" type="xs:string" minOccurs="0"/>
				<xs:element name="AmountReclaimed" type="xs:decimal"/>
				<xs:element name="AmountDestroyed" type="xs:decimal"/>
				<xs:element name="RcsLeakCauseId" type="RcsLeakCause"/>
        <xs:element name="IsScheduled" type="xs:boolean"/>
				<xs:element name="DtDue" type="xs:dateTime" nillable="true"/>
				<xs:element name="ParentAction" type="RcsAction" minOccurs="0"/>
				<xs:element name="TechName" type="xs:string" minOccurs="0"/>
				<xs:element name="CertClassId" type="EmpCertificationClass"/>
        <xs:element name="RcsExtensionReasonId" type="RcsExtensionReason" nillable="true"/>
				<xs:element name="LeaksFound" type="xs:boolean"/>
				<xs:element name="IsALDCalibrationSuccess" type="xs:boolean"/>
				<xs:element name="EquipmentDestinationManager" type="Employee" minOccurs="0"/>
				<xs:element name="EquipmentDestinationId" type="xs:int"/>
				<xs:element name="RemainingCapacity" type="xs:decimal"/>
			</xs:sequence>
		</xs:extension>
	</xs:complexContent>
</xs:complexType>

RcsCircuit Entity

Element Added
IsMothball
<xs:complexType name="RcsCircuit" mixed="false">
		<xs:complexContent>
			<xs:extension base="CorrigoEntityWithOptimisticLock">
				<xs:sequence>
					<xs:element name="ObjectId" type="xs:int"/>
					<xs:element name="ObjectTypeId" type="ActorType"/>
					<xs:element name="Asset" type="Location" minOccurs="0"/>
					<xs:element name="AssetSystem" type="AssetSystem" minOccurs="0"/>
					<xs:element name="Number" type="xs:string" minOccurs="0"/>
					<xs:element name="Manufacturer" type="xs:string" minOccurs="0"/>
					<xs:element name="Model" type="xs:string" minOccurs="0"/>
					<xs:element name="IsMetric" type="xs:boolean"/>
					<xs:element name="MhProduct" type="Product" minOccurs="0"/>
					<xs:element name="Capacity" type="xs:decimal"/>
					<xs:element name="LeakRate" type="xs:decimal"/>
					<xs:element name="LeakThreshold" type="xs:decimal"/>
					<xs:element name="Comments" type="xs:string" minOccurs="0"/>
					<xs:element name="StatusId" type="RcsCircuitStatus"/>
					<xs:element name="EquipmentTypeID" type="xs:unsignedByte" nillable="true"/>
					<xs:element name="InstallDate" type="xs:dateTime" nillable="true"/>
					<xs:element name="LocationDescription" type="xs:string" minOccurs="0"/>
					<xs:element name="LeakDetectionCoverID" type="xs:unsignedByte" nillable="true"/>
					<xs:element name="FullChargeCalcMethodID" type="xs:unsignedByte" nillable="true"/>
					<xs:element name="HasLeakInspection" type="xs:boolean"/>
					<xs:element name="LeakInspectionDate" type="xs:dateTime" nillable="true"/>
					<xs:element name="IsLeakDetectionEquipment" type="xs:boolean"/>
					<xs:element name="LeakDetectionDeviceTypeID" type="xs:unsignedByte" nillable="true"/>
					<xs:element name="HasEquipmentCalibration" type="xs:boolean"/>
					<xs:element name="EquipmentCalibrationDate" type="xs:dateTime" nillable="true"/>
					<xs:element name="Actions" type="ArrayOfRcsAction" minOccurs="0"/>
					<xs:element name="LeakRateLogs" type="ArrayOfRcsLeakRateLog" minOccurs="0"/>
					<xs:element name="IsMothball" type="xs:boolean"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>

WorkZone Entity

Element Added
RegulatoryFrameworkID
<xs:complexType name="WorkZone" mixed="false">
		<xs:complexContent>
			<xs:extension base="RemovableCorrigoEntity">
				<xs:sequence>
					<xs:element name="DisplayAs" type="xs:string" minOccurs="0"/>
					<xs:element name="Asset" type="Location" minOccurs="0"/>
					<xs:element name="TimeZone" type="xs:int"/>
					<xs:element name="LanguageId" type="xs:int"/>
					<xs:element name="WoNumberPrefix" type="xs:string" minOccurs="0"/>
					<xs:element name="Entity" type="xs:string" minOccurs="0"/>
					<xs:element name="SchedulingWindow" type="xs:int"/>
					<xs:element name="NoIncompleteProcedure" type="xs:boolean"/>
					<xs:element name="AccessOptionsMask" type="xs:int"/>
					<xs:element name="Number" type="xs:string" minOccurs="0"/>
					<xs:element name="AdvanceNotice" type="xs:int"/>
					<xs:element name="TaxRegion" type="TaxRegion" minOccurs="0"/>
					<xs:element name="WoNumberDigits" type="xs:int"/>
					<xs:element name="RoundApptTimeTo" type="xs:int"/>
					<xs:element name="WorkPlanAutoCancel" type="xs:boolean"/>
					<xs:element name="WorkPlanChildResolution" type="xs:boolean"/>
					<xs:element name="WorkPlanAutoDependency" type="xs:boolean"/>
					<xs:element name="CpThemeId" type="xs:int"/>
					<xs:element name="DefaultAccess" type="PTEType"/>
					<xs:element name="AutoAssignEnabled" type="xs:boolean"/>
					<xs:element name="BackupRoutingId" type="BackupRouting"/>
					<xs:element name="BillingAccount" type="BillingAccount" minOccurs="0"/>
					<xs:element name="Contract" type="Contract" minOccurs="0"/>
					<xs:element name="NoIncompleteItem" type="xs:boolean"/>
					<xs:element name="UiShowProvidersFirst" type="xs:boolean"/>
					<xs:element name="CurrencyTypeId" type="CurrencyType"/>
					<xs:element name="IsOffline" type="xs:boolean"/>
					<xs:element name="ContactAddresses" type="ArrayOfContactInfo" minOccurs="0"/>
					<xs:element name="CustomFields" type="ArrayOfCustomField2" minOccurs="0"/>
					<xs:element name="Portfolios" type="ArrayOfLinkPortfolioAndWorkZone" minOccurs="0"/>
					<xs:element name="SlaValues" type="ArrayOfSlaValuesOverride" minOccurs="0"/>
					<xs:element name="Teams" type="ArrayOfLinkTeamAndWorkZone" minOccurs="0"/>
					<xs:element name="BizHours" type="ArrayOfBusinessHours" minOccurs="0"/>
					<xs:element name="BlackoutDays" type="ArrayOfBlackoutDay" minOccurs="0"/>
					<xs:element name="Holidays" type="ArrayOfHoliday" minOccurs="0"/>
					<xs:element name="EscalationRules" type="ArrayOfEscalationRule" minOccurs="0"/>
					<xs:element name="SpecDispatchRules" type="ArrayOfSpecDispatchRule" minOccurs="0"/>
					<xs:element name="OnCallRules" type="ArrayOfOnCallRule" minOccurs="0"/>
					<xs:element name="Responsibilities" type="ArrayOfResponsibility" minOccurs="0"/>
					<xs:element name="UseBizHours" type="xs:boolean"/>
					<xs:element name="UseHolidays" type="xs:boolean"/>
					<xs:element name="UseBlackoutDays" type="xs:boolean"/>
					<xs:element name="UseOnCall" type="xs:boolean"/>
					<xs:element name="UseEscalation" type="xs:boolean"/>
					<xs:element name="DefaultBillToLogic" type="xs:int"/>
					<xs:element name="TurnKickOffAuto" type="xs:boolean"/>
					<xs:element name="TurnKickOffLagDays" type="xs:short"/>
					<xs:element name="TurnKickOffOnDays" type="xs:unsignedByte"/>
					<xs:element name="EarliestSlot" type="xs:int"/>
					<xs:element name="LatestSlot" type="xs:int"/>
					<xs:element name="SlotsCount" type="xs:int"/>
					<xs:element name="IsPrecalculatedSchedule" type="xs:boolean"/>
					<xs:element name="AllowTimePreference" type="xs:boolean"/>
					<xs:element name="TurnTemplateId" type="xs:int"/>
					<xs:element name="IsmSpecGroupId" type="xs:int"/>
					<xs:element name="IsmUrl" type="xs:string" minOccurs="0"/>
					<xs:element name="ExcludeNonCompliantProviders" type="ExcludeCoi"/>
					<xs:element name="IsNteAuto" type="xs:boolean" nillable="true"/>
					<xs:element name="CriticalFacilities" type="CriticalFacilitiesSettingValues"/>
					<xs:element name="UnitTemplateID" type="xs:int"/>
					<xs:element name="RegulatoryFrameworkID" type="xs:int" nillable="true"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>

Invoice Entity

Element Added
BillingContact

<xs:complexType name="Invoice" mixed="false">
		<xs:complexContent>
			<xs:extension base="CorrigoEntityWithOptimisticLock">
				<xs:sequence>
					<xs:element name="CurrencyTypeId" type="CurrencyType"/>
					<xs:element name="TimeSetId" type="xs:int"/>
					<xs:element name="Period" type="TimePeriod" minOccurs="0"/>
					<xs:element name="Group" type="BillingAccount" minOccurs="0"/>
					<xs:element name="BillingContact" type="Contact" minOccurs="0"/>
					<xs:element name="Number" type="xs:string" minOccurs="0"/>
					<xs:element name="State" type="CiInvoiceState"/>
					<xs:element name="PoNumber" type="xs:string" minOccurs="0"/>
					<xs:element name="DtDue" type="xs:dateTime" nillable="true"/>
					<xs:element name="GlAccount" type="xs:string" minOccurs="0"/>
					<xs:element name="Comments" type="xs:string" minOccurs="0"/>
					<xs:element name="AmtBase" type="MoneyValue" minOccurs="0"/>
					<xs:element name="AmtTax" type="MoneyValue" minOccurs="0"/>
					<xs:element name="AmtTotal" type="MoneyValue" minOccurs="0"/>
					<xs:element name="IsMultiline" type="xs:boolean"/>
					<xs:element name="TaxTransactionId" type="xs:string" minOccurs="0"/>
					<xs:element name="IsTaxDirty" type="xs:boolean"/>
					<xs:element name="LineItems" type="ArrayOfInvoiceLine" minOccurs="0"/>
					<xs:element name="ExtNumber" type="xs:string" minOccurs="0"/>
					<xs:element name="DtPosted" type="xs:dateTime" nillable="true"/>
					<xs:element name="IsManuallySent" type="xs:boolean"/>
					<xs:element name="DraftProcessStepId" type="DraftProcessStep"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>

WorkOrderCost Entity

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

Updated about 1 year ago

Did this page help you?

Updated about 1 year ago

Did this page help you?