Table of Contents

Class Payment

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

Constructors

Payment()

Instantiates a new Payment and sets the default values.

public Payment()

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 of the payment. Possible values: workCompleted, workCompletedPercentage.

public Payment_aggregateBy? AggregateBy { get; set; }

Property Value

Payment_aggregateBy?

Amount

The work completed of the payment.

public string? Amount { get; set; }

Property Value

string

ApprovedChangeOrders

The total amount of approved change orders in this period.

public string? ApprovedChangeOrders { get; set; }

Property Value

string

ApprovedChangeOrdersForeignCurrency

Foreign currency for approvedChangeOrders.

public string? ApprovedChangeOrdersForeignCurrency { get; set; }

Property Value

string

AssociationId

The object ID of the payment is associated to. For example ID of contract or mainContract.

public Guid? AssociationId { get; set; }

Property Value

Guid?

AssociationType

The type of object that the payment is associated to. For example, Contract and MainContract.

public Payment_associationType? AssociationType { get; set; }

Property Value

Payment_associationType?

BillingPeriodId

Unique identifier of the billing period ID.

public Guid? BillingPeriodId { get; set; }

Property Value

Guid?

BudgetPaymentId

The budget payment ID the cost payment is associated to. This is only valid for cost payments.

public Guid? BudgetPaymentId { get; set; }

Property Value

Guid?

ClaimedAmount

The claimed work completed of the payment.

public string? ClaimedAmount { get; set; }

Property Value

string

CompletedWorkRetention

The retention of work completed of the payment.

public string? CompletedWorkRetention { get; set; }

Property Value

string

CompletedWorkRetentionForeignCurrency

Foreign currency for completedWorkRetention.

public string? CompletedWorkRetentionForeignCurrency { get; set; }

Property Value

string

ContractAmount

The original contract amount of the payment.

public string? ContractAmount { get; set; }

Property Value

string

ContractAmountForeignCurrency

Foreign currency for contractAmount.

public string? ContractAmountForeignCurrency { 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?

Description

The detail description of this payment.

public string? Description { get; set; }

Property Value

string

EndDate

The end date of this payment.

public Date? EndDate { get; set; }

Property Value

Date?

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

ForecastDistributionAt

The date and time determines which distribution period this payment belongs to, after set status to Approved or Paid.

public DateTimeOffset? ForecastDistributionAt { get; }

Property Value

DateTimeOffset?

HasComment

Indicate if this payment has comment.

public bool? HasComment { get; set; }

Property Value

bool?

Id

Unique identifier of the payment.

public Guid? Id { get; }

Property Value

Guid?

IntegrationState

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

public Payment_integrationState? IntegrationState { get; set; }

Property Value

Payment_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

MainContractId

The main contract ID of the payment that is associated to.

public Guid? MainContractId { get; set; }

Property Value

Guid?

MaterialsBilled

The amount of the material currently billed.

public string? MaterialsBilled { get; set; }

Property Value

string

MaterialsOnStore

The amount of the material currently billed.

public string? MaterialsOnStore { get; set; }

Property Value

string

MaterialsOnStoreRetention

The retention of material on site of the payment.

public string? MaterialsOnStoreRetention { get; set; }

Property Value

string

Name

The name of this payment.

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

NetMaterialsOnStore

The net change of materials on store of this period, which equals to materialsOnStore - previousMaterialsOnStore.

public string? NetMaterialsOnStore { get; set; }

Property Value

string

NetRetention

The net retention amount of this period, which equals to completedWorkRetention + materialsOnStoreRetention - previousRetention.

public string? NetRetention { get; set; }

Property Value

string

Note

Draftjs formatted rich text(https://draftjs.org/)

public string? Note { get; set; }

Property Value

string

Number

The number of this payment.

public string? Number { get; set; }

Property Value

string

OriginalAmount

The original amount of the payment, including contract amount and change orders.

public string? OriginalAmount { get; set; }

Property Value

string

OriginalAmountForeignCurrency

Foreign currency for originalAmount.

public string? OriginalAmountForeignCurrency { get; set; }

Property Value

string

PaidAt

The date and time when the expense is paid.

public DateTimeOffset? PaidAt { get; set; }

Property Value

DateTimeOffset?

PreviousAmount

The total of work completed till previous payment.

public string? PreviousAmount { get; set; }

Property Value

string

PreviousAmountForeignCurrency

Foreign currency for previousAmount.

public string? PreviousAmountForeignCurrency { get; set; }

Property Value

string

PreviousApprovedChangeOrders

The total amount of previously approved change orders.

public string? PreviousApprovedChangeOrders { get; set; }

Property Value

string

PreviousApprovedChangeOrdersForeignCurrency

Foreign currency for previousApprovedChangeOrders.

public string? PreviousApprovedChangeOrdersForeignCurrency { get; set; }

Property Value

string

PreviousClaimedAmount

The previous claimed work completed of the payment.

public string? PreviousClaimedAmount { get; set; }

Property Value

string

PreviousClaimedAmountForeignCurrency

Foreign currency for previousClaimedAmount.

public string? PreviousClaimedAmountForeignCurrency { 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

Foreign currency for previousMaterialsBilled.

public string? PreviousMaterialsBilledCurrency { get; set; }

Property Value

string

PreviousMaterialsOnStore

The amount of the material billed in last payment.

public string? PreviousMaterialsOnStore { get; set; }

Property Value

string

PreviousRetention

The total amount previously retained.

public string? PreviousRetention { get; set; }

Property Value

string

PreviousRetentionForeignCurrency

Foreign currency for previousRetention.

public string? PreviousRetentionForeignCurrency { get; set; }

Property Value

string

StartDate

The start date of this payment.

public Date? StartDate { get; set; }

Property Value

Date?

Status

The status of this payment.

public Payment_status? Status { get; set; }

Property Value

Payment_status?

SubmittedAt

The date and time when the payment is submitted.

public DateTimeOffset? SubmittedAt { get; }

Property Value

DateTimeOffset?

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 Payment CreateFromDiscriminatorValue(IParseNode parseNode)

Parameters

parseNode IParseNode

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

Returns

Payment

A Payment

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