Warranty

Property NameProperty ValueProperty Description
DisplayAsStringGets or sets DisplayAs field value.
AdditionalInfoStringAdditional coverage details, terms and conditions. Max. length is 6144 characters; zero length values are allowed.
IsTemplateBooleanTrue indicates template; False indicates warranty.
Organization{Organization entity reference}Organization ID, references OrgObject.ID. This field is required for Template; otherwise irrelevant.
StatusIdWarrantyStatus enumeration memberWarranty status matching enumeration WarrantyStatus and dictionary vlangWarrantyStatus. Used by warranties only; for templates always WarrantyStatus.None.
PrimaryContactStringName of the primary contact person (used by both warranties and templates).
TemplateIdInteger
WorkOrder{WorkOrder entity reference}Work Order from which Warranty was created, references WorkOrder2Object.ID. Used by warranties only; for templates always NULL.
StartDateDateTime or NULLStart of the coverage interval; date without time. Required by warranties; for templates always NULL.
EndDateDateTime or NULLEnd of the coverage interval; date without time. Required by warranties; for templates always NULL.
AutoCoverageIntegerA bitmask defining asset categories automatically covered by Warranty Template; used by templates; otherwise irrelevant. Bit number X matches asset category X; i.e. 0x01 matches asset category #1 (AssetType.Regular).
LaborCoverageTypeIdSchedInterval enumeration memberInterval type for Labor/Services coverage. Warranty status matching enumeration SchedInterval and dictionary vlangSchedIntervalLookup. Used by both warranties and templates. Supported values are SchedInterval.Day and SchedInterval.Year.
LaborCoverageLengthIntegerInterval length for Labor/Services coverage. Used by both warranties and templates. Supported values are 0 - 999.
PartsCoverageTypeIdSchedInterval enumeration memberInterval type for Parts/Materials coverage. Warranty status matching enumeration SchedInterval and dictionary vlangSchedIntervalLookup. Used by both warranties and templates. Supported values are SchedInterval.Day and SchedInterval.Year.
PartsCoverageLengthIntegerInterval length for Parts/Materials coverage. Used by both warranties and templates. Supported values are 0 - 999.
OtherCoverageTypeIdSchedInterval enumeration memberInterval type for Other coverage. Warranty status matching enumeration SchedInterval and dictionary vlangSchedIntervalLookup. Used by both warranties and templates. Supported values are SchedInterval.Day and SchedInterval.Year.
OtherCoveragerLengthIntegerInterval length for Other coverage. Used by both warranties and templates. Supported values are 0 - 999.
WarrantorTypeIdActorType enumeration memberStandard link to actor representing the Warrantor. Supported values for WarrantorTypeID are ActorType.CorrigoNet and ActorType.Provider.
WarrantorIdIntegerStandard link to actor representing the Warrantor.
CommentStringAdditional comments provided by users. Used by warranties; otherwise irrelevant.
Asset{Location entity reference}Asset to which Warranty is linked, references InvItemObject.ID. This field is required for warranties; otherwise NULL.
TimeZoneIntegerTime Zone (typically derived from work order or asset) used to compute Warranty status. Used by warranties; otherwise irrelevant.
WorkZone{WorkZone entity reference}Auto-computed field containing parent work zone ID of Warranty's asset; references CommunityObject.ID. Used by warranties only; for templates always NULL.
ContactAddresses[{ContactInfo entity reference}, ...]Warranty support only one Contact Address type: ContactAddrType.Contact. There is no standard validation for it; all values are accepted
IsManufacturerBooleanBoolean flag. Used only by templates. True means this is a template for manufacturer warranty (there is 0 or 1 such template for each Organization).
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.
Properties[{PropertyTreeNode object reference}, ...]List of filled properties
LimitMultipleEntitiesNumberBehaviourBooleanReturn exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API