1. APIs
  2. TeamDynamix.Api.Assets.Contract

Contents

Summary

A contract that can cover any number of assets.

Properties

Name Editable? Required? Type Nullable? Summary
ID Int32 The ID of the contract.
AppID Int32 The ID of the asset/CI application containing the contract.
AppName String The name of the asset/CI application containing the contract.
ContractNumber This field is editable through the web API. This field is required. String The contract number.
ContractPrice This field is editable through the web API. Double This field is nullable. The contract's price amount.
Description This field is editable through the web API. String This field is nullable. The description of the contract.
ProviderID This field is editable through the web API. This field is required. Int32 The ID of the contract provider (vendor).
ProviderName String The name of the contract provider (vendor).
IsFixedModel This field is editable through the web API. This field is required. Boolean Whether this contract uses a "fixed" date model. If false, indicates that it uses a sliding date model.
This value is only editable during creation. The date model cannot be changed when editing.
DateModel String The date model of the contract.
StartDate This field is editable through the web API. DateTime The effective start date of the contract.

When this is using a fixed date model, it will be the same for each asset.

When using a sliding date model, this will be the minimum start date across all assets associated with the contract.

If the contract has a Fixed date model, this value is editable and required.

If the contract has a Sliding date model, this value is non-editable. It will instead be a retrieval-only property.

EndDate This field is editable through the web API. DateTime The effective end date of the contract.

When this is using a fixed date model, it will be the same for each asset.

When using a sliding date model, this will be the maximum end date across all assets associated with the contract.

If the contract has a Fixed date model, this value is editable and required.

If the contract has a Sliding date model, this value is non-editable. It will instead be a retrieval-only property.

SlidingDefaultDuration This field is editable through the web API. Int32 The default duration (used in conjunction with the Sliding End Date Unit) to specify the default end date of an asset associated with a sliding contract.

If the contract has a Sliding date model, this value is editable and required.

If the contract has a Fixed date model, this value is neither editable nor applicable.

SlidingDefaultDateUnit This field is editable through the web API. TeamDynamix.Api.Assets.SlidingContractDateUnit The date unit for the default duration to use when assets are associated with the contract for a sliding date model.

If the contract has a Sliding date model, this value is editable and required.

If the contract has a Fixed date model, this value is neither editable nor applicable.

SlidingDefaultDateUnitName String The date unit name for the default duration to use when assets are associated with the contract for a sliding date model.
TypeID This field is editable through the web API. TeamDynamix.Api.Assets.ContractType The ID of the contract type.
TypeName String The name of the contract type.
AccountID This field is editable through the web API. Int32 The ID of the account/department associated with the contract.
AccountName String The name of the account/department associated with the contract.
CreatedDate DateTime The created date of the contract.
CreatedUID String The UID of the person who created the contract.
CreatedFullName String The full name of the person who created the contract.
ModifiedDate DateTime The last modified date of the contract.
ModifiedUID String The UID of the person who last modified the contract.
ModifiedFullName String The full name of the person who last modified the contract.
AssetsCount Int32 The number of assets associated with this contract. This will be -1 if this total has not been loaded.
Attachments TeamDynamix.Api.Attachments.Attachment[] This field is nullable. The attachments associated with the contract.
Attributes This field is editable through the web API. TeamDynamix.Api.CustomAttributes.CustomAttribute[] This field is nullable. The custom attributes associated with the contract.
IsActive This field is editable through the web API. Boolean The active status of the contract.