Class PaymentsRequestBuilder.PaymentsRequestBuilderGetQueryParameters

Namespace

Autodesk.ACC.CostManagement.V1.Projects.Item.Payments

Assembly

Autodesk.ACC.CostManagement.dll

Gets payment by conditions

public class PaymentsRequestBuilder.PaymentsRequestBuilderGetQueryParameters

Inheritance

object

PaymentsRequestBuilder.PaymentsRequestBuilderGetQueryParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FilterassociationId

The contract or main contract ID of the payment is associated to. Separate multiple IDs with commas. For example, filter[associationId]=id1,id2.

[QueryParameter("filter%5BassociationId%5D")]
public string[]? FilterassociationId { get; set; }

Property Value

string[]

FilterassociationType

The type of item the the payment is associated to. Possible values: Contract for cost payments and MainContract for budget payments. For example, filter[associationType]=Contract.

[Obsolete("This property is deprecated, use FilterassociationTypeAsGetFilterAssociationTypeQueryParameterType instead")]
[QueryParameter("filter%5BassociationType%5D")]
public string? FilterassociationType { get; set; }

Property Value

string

FilterassociationTypeAsGetFilterAssociationTypeQueryParameterType

The type of item the the payment is associated to. Possible values: Contract for cost payments and MainContract for budget payments. For example, filter[associationType]=Contract.

[QueryParameter("filter%5BassociationType%5D")]
public GetFilterAssociationTypeQueryParameterType? FilterassociationTypeAsGetFilterAssociationTypeQueryParameterType { get; set; }

Property Value

GetFilterAssociationTypeQueryParameterType?

FilterbudgetPaymentId

The ID of the budget payment used to query the related cost payments or expenses. Separate multiple IDs with commas. For example, filter[budgetPaymentId]=id1,id2, or filter these that are not linked to any budget payment filter[budgetPaymentId]=blank.

[QueryParameter("filter%5BbudgetPaymentId%5D")]
public string[]? FilterbudgetPaymentId { get; set; }

Property Value

string[]

Filterid

The item's primary identifier. Separate multiple IDs with commas. For example, filter[id]=id1,id2.

[QueryParameter("filter%5Bid%5D")]
public string[]? Filterid { get; set; }

Property Value

string[]

FilterlastModifiedSince

Retrieves items that were modified from the specified date and time, in the following format, YYYY-MM-DDThh:mm:ss.sz. For example, filter[lastModifiedSince]=2020-03-01T13:00:00Z.

[QueryParameter("filter%5BlastModifiedSince%5D")]
public string? FilterlastModifiedSince { get; set; }

Property Value

string

Filternumber

The item's number. For example, filter[number]=0001,0002.

[QueryParameter("filter%5Bnumber%5D")]
public string[]? Filternumber { get; set; }

Property Value

string[]

Include

Include nested resources in the response. For example, include=paymentReferences will return payment references to each payment. include=attributes will return custom attributes which represents the "properties" in the response. Possible values: paymentReferences, attributes.

[QueryParameter("include")]
public string[]? Include { get; set; }

Property Value

string[]

InternalLimit

The maximum number of items to return, this is for internal use, and the default maximum internal limit is 5000.

[QueryParameter("internalLimit")]
public int? InternalLimit { get; set; }

Property Value

int?

Limit

The maximum number of items to return, default maximum limit is 100.

[QueryParameter("limit")]
public int? Limit { get; set; }

Property Value

int?

Offset

The number of items to skip before starting to collect the result set.

[QueryParameter("offset")]
public int? Offset { get; set; }

Property Value

int?

Q

The conditions to query against items, such as id=0 or (id>2 and id<4). This parameter is deprecated in favor of the filter[] based syntax.

[QueryParameter("q")]
public string? Q { get; set; }

Property Value

string

Sort

The sort order for items. Each attribute can be sorted in either asc (default) or desc order. For example, sort=name, updatedAt desc or sort=name + updatedAt desc sorts the results first by name in ascending order, then by date updated in descending order.

[QueryParameter("sort")]
public string? Sort { get; set; }

Property Value

string