Table of Contents

Class Contract

Namespace
Autodesk.ACC.CostManagement.Models
Assembly
Autodesk.ACC.CostManagement.dll
public class Contract : IAdditionalDataHolder, IParsable
Inheritance
Contract
Implements
IAdditionalDataHolder
IParsable
Inherited Members

Constructors

Contract()

Instantiates a new Contract and sets the default values.

public Contract()

Properties

ActualCost

Total amount of actual cost of the contract.

public double? ActualCost { get; set; }

Property Value

double?

AdditionalData

Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

public IDictionary<string, object> AdditionalData { get; set; }

Property Value

IDictionary<string, object>

ApprovedAt

The date and time when the contract is approved.

public DateTimeOffset? ApprovedAt { get; set; }

Property Value

DateTimeOffset?

ApprovedChangeOrders

Total amount of the changes committed to the supplier.

public double? ApprovedChangeOrders { get; set; }

Property Value

double?

ApprovedInScopeChangeOrders

Total amount of in-scope changes committed to the supplier.

public double? ApprovedInScopeChangeOrders { get; set; }

Property Value

double?

ApprovedOwnerChanges

Total amount of the changes approved by the owner.

public double? ApprovedOwnerChanges { get; set; }

Property Value

double?

Awarded

Amount of the original Contract

public double? Awarded { get; set; }

Property Value

double?

AwardedAt

The date and time when the contract is awarded.

public DateTimeOffset? AwardedAt { get; set; }

Property Value

DateTimeOffset?

Budgets

Budgets that are linked to this contract.

public List<Contract_budgets>? Budgets { get; set; }

Property Value

List<Contract_budgets>

ChangedBy

The user who made the last change to the contract. This is the ID of a user managed by BIM 360 Admin.

public string? ChangedBy { get; }

Property Value

string

Code

Code of the contract.

public string? Code { get; set; }

Property Value

string

CompanyId

The ID of a supplier company. This is the ID of a company managed by BIM 360 Admin.

public string? CompanyId { get; set; }

Property Value

string

Compounded

Calculated values based on contract customized columns.

public Contract_compounded? Compounded { get; set; }

Property Value

Contract_compounded

ContactId

Default contact of the supplier. This is the ID of a user managed by BIM 360 Admin.

public string? ContactId { get; set; }

Property Value

string

CreatedAt

The timestamp of the date and time the item was created, in the following format: YYYY-MM-DDThh:mm:ss.sz.

public DateTimeOffset? CreatedAt { get; }

Property Value

DateTimeOffset?

CreatorId

The user who created the contract. This is the ID of a user managed by BIM 360 Admin.

public string? CreatorId { get; }

Property Value

string

Currency

Currency setting of the contract.

public string? Currency { get; set; }

Property Value

string

Description

Detailed description of a contract.

public string? Description { get; set; }

Property Value

string

DocumentGeneratedAt

The date and time when the contract document is generated.

public DateTimeOffset? DocumentGeneratedAt { get; }

Property Value

DateTimeOffset?

ExchangeRate

Exchange rate. For example, 1 base currency = 0.7455 foreign currency.

public string? ExchangeRate { get; set; }

Property Value

string

ExternalId

The ID of the item in its original external system. You can use this ID to track the source of truth or to look up the data in an integrated system.

public string? ExternalId { get; set; }

Property Value

string

ExternalMessage

A description about the integration: success, failure or error message.

public string? ExternalMessage { get; set; }

Property Value

string

ExternalSystem

The name of the external system. You can use this name to track the source of truth or to search in an integrated system.

public string? ExternalSystem { get; set; }

Property Value

string

ForecastCostComplete

Total amount of the forecast cost to complete, equals to forecastFinalCost - actualCost.

public double? ForecastCostComplete { get; set; }

Property Value

double?

ForecastExchanageRate

Forecast exchange rate. Default value is null.

public string? ForecastExchanageRate { get; set; }

Property Value

string

ForecastExchangeRateUpdatedAt

Last time to update forecast exchange rate.

public DateTimeOffset? ForecastExchangeRateUpdatedAt { get; set; }

Property Value

DateTimeOffset?

ForecastFinalCost

Total amount of the project cost including forecast adjustments, equals to projectedCost + adjustmentsTotal.

public double? ForecastFinalCost { get; set; }

Property Value

double?

ForecastVariance

Total amount of the forecast variance, equals to projectedBudget - forecastFinalCost.

public double? ForecastVariance { get; set; }

Property Value

double?

Id

Unique identifier of a contract.

public Guid? Id { get; }

Property Value

Guid?

IntegrationState

Lock state used by ERP integration, default value is null.

public Contract_integrationState? IntegrationState { get; set; }

Property Value

Contract_integrationState?

IntegrationStateChangedAt

The date and time last locked this item.

public DateTimeOffset? IntegrationStateChangedAt { get; set; }

Property Value

DateTimeOffset?

IntegrationStateChangedBy

The user who last locked this item. This is the ID of a user managed by BIM 360 Admin.

public string? IntegrationStateChangedBy { get; set; }

Property Value

string

InternalAdjustment

Total amount of internal transfers of budgets associated to this Contract.

public double? InternalAdjustment { get; set; }

Property Value

double?

LastSyncTime

The date and time when the item was last updated.

public DateTimeOffset? LastSyncTime { get; }

Property Value

DateTimeOffset?

MainContractId

The ID of the main contract the contract belongs to.

public string? MainContractId { get; set; }

Property Value

string

Name

Name of the contract.

public string? Name { get; set; }

Property Value

string

Note

Note to the contract. This is a Draftjs formatted rich text (https://draftjs.org/)

public string? Note { get; set; }

Property Value

string

OffsiteAt

The date and time when the supplier completes the job.

public DateTimeOffset? OffsiteAt { get; set; }

Property Value

DateTimeOffset?

OnsiteAt

The date and time when the Supplier on-site to the job.

public DateTimeOffset? OnsiteAt { get; set; }

Property Value

DateTimeOffset?

OriginalBudget

Total amount of original amount of budgets associated to this Contract.

public double? OriginalBudget { get; set; }

Property Value

double?

OwnerId

The user who is responsible the purchase. This is the ID of a user managed by BIM 360 Admin.

public string? OwnerId { get; set; }

Property Value

string

PaymentDue

The payment due days of the contract.

public int? PaymentDue { get; set; }

Property Value

int?

PaymentDueType

The payment due days relative to date of the contract.

public Contract_paymentDueType? PaymentDueType { get; set; }

Property Value

Contract_paymentDueType?

PendingChangeOrders

Total amount of the changes not committed to the supplier.

public double? PendingChangeOrders { get; set; }

Property Value

double?

PendingOwnerChanges

Total amount of the changes pending approval by the owner.

public double? PendingOwnerChanges { get; set; }

Property Value

double?

ProcuredAt

The date and time of purchased. This is designed for Purchase Order contract.

public string? ProcuredAt { get; set; }

Property Value

string

ProjectedBudget

Total amount of the project budget including pending changes, equals to revised + pendingOwnerChanges.

public double? ProjectedBudget { get; set; }

Property Value

double?

ProjectedCost

Total amount of the project cost. For a budget, it is equal to originalCommitment + approvedChangeOrders + pendingChangeOrders + reserves. For a contract , it is equal to awarded + approvedChangeOrders + pendingChangeOrders + reserves.

public double? ProjectedCost { get; set; }

Property Value

double?

Reserves

Total amount of the changes under estimating.

public double? Reserves { get; set; }

Property Value

double?

RespondedAt

The date and time when the supplier responds.

public DateTimeOffset? RespondedAt { get; set; }

Property Value

DateTimeOffset?

ResponseDue

The date and time when the supplier responds.

public DateTimeOffset? ResponseDue { get; set; }

Property Value

DateTimeOffset?

RetentionCap

Total retention percentage of the contract amount.

public double? RetentionCap { get; set; }

Property Value

double?

ReturnedAt

The date and time when the contract is signed and returned.

public DateTimeOffset? ReturnedAt { get; set; }

Property Value

DateTimeOffset?

Revised

Total amount of the approved budget from the owner, equals to originalAmount + internalAdjustment + approvedOwnerChanges.

public double? Revised { get; set; }

Property Value

double?

ScheduleOfValues

Schedule of values of the contract.

public List<SOV>? ScheduleOfValues { get; set; }

Property Value

List<SOV>

ScopeOfWork

Scope signed by all parties of the contract. This is a Draftjs formatted rich text (https://draftjs.org/).

public string? ScopeOfWork { get; set; }

Property Value

string

SentAt

The date and time when the contract is sent to the supplier.

public DateTimeOffset? SentAt { get; set; }

Property Value

DateTimeOffset?

SignedBy

The user who signed the contract. This is the ID of a user managed by BIM 360 Admin.

public string? SignedBy { get; set; }

Property Value

string

Status

The status of this contract.

public Contract_status? Status { get; set; }

Property Value

Contract_status?

StatusChangedAt

The last time when the status is updated.

public DateTimeOffset? StatusChangedAt { get; }

Property Value

DateTimeOffset?

Type

Type of the contract. For example, consultant or purchase order. Type is customizable by the project admin.

public string? Type { get; set; }

Property Value

string

Uncommitted

The amount that has been approved by owner but not committed to the supplier: equals to approvedOwnerChanges - (approvedChangeOrders - approvedInScopeChangeOrders).

public double? Uncommitted { get; set; }

Property Value

double?

UpdatedAt

The timestamp of the date and time the item was updated, in the following format: YYYY-MM-DDThh:mm:ss.sz.

public DateTimeOffset? UpdatedAt { get; }

Property Value

DateTimeOffset?

VarianceTotal

Total amount of the variance of a budget, equals to projectedBudget - projectedCost.

public double? VarianceTotal { get; set; }

Property Value

double?

Methods

CreateFromDiscriminatorValue(IParseNode)

Creates a new instance of the appropriate class based on discriminator value

public static Contract CreateFromDiscriminatorValue(IParseNode parseNode)

Parameters

parseNode IParseNode

The parse node to use to read the discriminator value and create the object

Returns

Contract

A Contract

GetFieldDeserializers()

The deserialization information for the current model

public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers()

Returns

IDictionary<string, Action<IParseNode>>

A IDictionary<string, Action<IParseNode>>

Serialize(ISerializationWriter)

Serializes information the current object

public virtual void Serialize(ISerializationWriter writer)

Parameters

writer ISerializationWriter

Serialization writer to use to serialize this model

Edit this page