Class PaymentItem

Namespace

Autodesk.ACC.CostManagement.Models

Assembly

Autodesk.ACC.CostManagement.dll

public class PaymentItem : IAdditionalDataHolder, IParsable

Inheritance

object

PaymentItem

Implements

IAdditionalDataHolder

IParsable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PaymentItem()

Instantiates a new PaymentItem and sets the default values.

public PaymentItem()

Properties

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>

AggregateBy

The aggregate type to budget Pay.

public PaymentItem_aggregateBy? AggregateBy { get; set; }

Property Value

PaymentItem_aggregateBy?

Amount

The actual quantity of payment item in this payment.

public string? Amount { get; set; }

Property Value

string

AssociationId

The object ID of the payment item is associated to.

public Guid? AssociationId { get; set; }

Property Value

Guid?

AssociationType

The object type of the payment item is associated to.

public PaymentItem_associationType? AssociationType { get; set; }

Property Value

PaymentItem_associationType?

BudgetId

ID of the Budget to which the payment item belongs.

public Guid? BudgetId { get; set; }

Property Value

Guid?

CanDelete

Indicate if this payment item can be deleted.

public bool? CanDelete { get; set; }

Property Value

bool?

ChangedBy

The user who made the change.

public string? ChangedBy { get; set; }

Property Value

string

ClaimedAmount

The claimed work completed amount of the payment item.

public string? ClaimedAmount { get; set; }

Property Value

string

ClaimedQuantity

The claimed work completed qty of the payment item.

public string? ClaimedQuantity { get; set; }

Property Value

string

ClaimedUnitPrice

The claimed work completed unit price of the payment item.

public string? ClaimedUnitPrice { get; set; }

Property Value

string

CompletedWorkReleased

The amount that is released in this payment.

public string? CompletedWorkReleased { get; set; }

Property Value

string

CompletedWorkRetentionPercent

The percentage the total amount of work to be retained.

public double? CompletedWorkRetentionPercent { get; set; }

Property Value

double?

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 payment item. This is the ID of a user managed by BIM 360 Admin.

public string? CreatorId { get; set; }

Property Value

string

Description

The description property

public string? Description { get; set; }

Property Value

string

ExchangeRate

Exchange rate. Default value is 1, if multi-currency is not enabled, it will also be 1.

public string? ExchangeRate { get; set; }

Property Value

string

HasComment

Indicate if this payment item has comment.

public bool? HasComment { get; set; }

Property Value

bool?

Id

Unique identifier of the payment.

public Guid? Id { get; }

Property Value

Guid?

IsPrivate

Indicate if this payment item should be exposed to owner. This is only for budget payment.

public bool? IsPrivate { get; set; }

Property Value

bool?

LastReviewedBy

The last user who made the review.

public string? LastReviewedBy { get; set; }

Property Value

string

MaterialsBilled

The amount of the material currently billed.

public string? MaterialsBilled { get; set; }

Property Value

string

MaterialsBilledQuantity

The quanity of the material currently billed.

public double? MaterialsBilledQuantity { get; set; }

Property Value

double?

MaterialsBilledUnit

The unit of meaure of the material currently billed.

public string? MaterialsBilledUnit { get; set; }

Property Value

string

MaterialsBilledUnitPrice

The unit price of the material currently billed.

public string? MaterialsBilledUnitPrice { get; set; }

Property Value

string

MaterialsOnStore

The amount of the material currently on site.

public string? MaterialsOnStore { get; set; }

Property Value

string

MaterialsOnStoreQuantity

The quanity of the material currently on site.

public double? MaterialsOnStoreQuantity { get; set; }

Property Value

double?

MaterialsOnStoreReleased

The amount the material that is released in this payment.

public string? MaterialsOnStoreReleased { get; set; }

Property Value

string

MaterialsOnStoreRetentionPercent

The percentage the total amount of material to be retained.

public double? MaterialsOnStoreRetentionPercent { get; set; }

Property Value

double?

MaterialsOnStoreUnit

The unit of meaure of the material currently on site.

public string? MaterialsOnStoreUnit { get; set; }

Property Value

string

MaterialsOnStoreUnitPrice

The unit price of the material currently on site.

public string? MaterialsOnStoreUnitPrice { get; set; }

Property Value

string

Name

The name of the payment item.

public string? Name { get; set; }

Property Value

string

NetAmount

The net amount that should be paid in this period, including work completed, material on site, retention and release.

public string? NetAmount { get; set; }

Property Value

string

NetAmountForeignCurrency

Foreign currency for netAmount.

public string? NetAmountForeignCurrency { get; set; }

Property Value

string

OriginalAmount

The original amount of the payment item.

public string? OriginalAmount { get; set; }

Property Value

string

OriginalExchangeRate

If this payment item came from Schedule of Value, the value is equal to Schedule of Value exchange rate; If this payment item came from SCO, the value is equal to SCO exchange rate. Default value is 1, if multi-currency is not enabled, it will also be 1.

public string? OriginalExchangeRate { get; set; }

Property Value

string

OriginalQuantity

The originalQuantity property

public double? OriginalQuantity { get; set; }

Property Value

double?

OriginalUnitPrice

The original unit price of the payment item.

public string? OriginalUnitPrice { get; set; }

Property Value

string

ParentId

The ID of the parent item for sub items.

public Guid? ParentId { get; set; }

Property Value

Guid?

PaymentId

The ID of the payment the items belong to.

public Guid? PaymentId { get; set; }

Property Value

Guid?

PreviousAmount

The total amount that has been paid previously.

public string? PreviousAmount { get; set; }

Property Value

string

PreviousAmountForeignCurrency

Foreign currency for previousAmount.

public string? PreviousAmountForeignCurrency { get; set; }

Property Value

string

PreviousClaimedAmount

The previous claimed work completed amount of the payment item.

public string? PreviousClaimedAmount { get; set; }

Property Value

string

PreviousClaimedAmountForeignCurrency

The foreign currency for the previousClaimedAmount.

public string? PreviousClaimedAmountForeignCurrency { get; set; }

Property Value

string

PreviousClaimedQuantity

The previous claimed work completed qty of the payment item.

public string? PreviousClaimedQuantity { get; set; }

Property Value

string

PreviousClaimedUnitPrice

The previous claimed work completed unit price of the payment item.

public string? PreviousClaimedUnitPrice { get; set; }

Property Value

string

PreviousExchangeRate

Cost Pay Application exchange rate for previous billing period. Default value is 1, if multi-currency is not enabled, it will also be 1.

public string? PreviousExchangeRate { get; set; }

Property Value

string

PreviousMaterialsBilled

The amount of the material billed in last payment.

public string? PreviousMaterialsBilled { get; set; }

Property Value

string

PreviousMaterialsBilledCurrency

The foreign currency for the previousMaterialsBilled.

public string? PreviousMaterialsBilledCurrency { get; set; }

Property Value

string

PreviousMaterialsOnStore

The amount of the material on site in last payment.

public string? PreviousMaterialsOnStore { get; set; }

Property Value

string

PreviousQuantity

The total quantity that has been paid previously.

public double? PreviousQuantity { get; set; }

Property Value

double?

PreviousUnitPrice

The average unit price that has been paid previously.

public string? PreviousUnitPrice { get; set; }

Property Value

string

Quantity

The actual quantity of payment item in this payment.

public double? Quantity { get; set; }

Property Value

double?

RealizedGainOrLoss

netAmountForeignCurrency / originalExchangeRate - netAmount

public string? RealizedGainOrLoss { get; set; }

Property Value

string

Status

The status the item that is reviewed in this payment item.

public string? Status { get; set; }

Property Value

string

Unit

The unit of the payment item.

public string? Unit { get; set; }

Property Value

string

UnitPrice

The actual quantity of payment item in this payment.

public string? UnitPrice { get; set; }

Property Value

string

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?

Methods

CreateFromDiscriminatorValue(IParseNode)

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

public static PaymentItem CreateFromDiscriminatorValue(IParseNode parseNode)

Parameters

parseNode IParseNode

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

Returns

PaymentItem

A PaymentItem

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