InvoicesListByBillingProfileOptionalParams interface

Optional parameters.

Extends

Properties

count

The count query option allows clients to request a count of the matching resources included with the resources in the response.

filter

The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy

The orderby query option allows clients to request resources in a particular order.

periodEndDate

The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.

periodStartDate

The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.

search

The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.

skip

The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

top

The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

Inherited Properties

abortSignal

The signal which can be used to abort requests.

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

requestOptions

Options used when creating and sending HTTP requests for this operation.

serializerOptions

Options to override serialization/de-serialization behavior.

tracingOptions

Options used when tracing is enabled.

Property Details

count

The count query option allows clients to request a count of the matching resources included with the resources in the response.

count?: boolean

Property Value

boolean

filter

The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

filter?: string

Property Value

string

orderBy

The orderby query option allows clients to request resources in a particular order.

orderBy?: string

Property Value

string

periodEndDate

The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.

periodEndDate?: Date

Property Value

Date

periodStartDate

The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.

periodStartDate?: Date

Property Value

Date

The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.

search?: string

Property Value

string

skip

The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

skip?: number

Property Value

number

top

The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

top?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

Inherited From coreClient.OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

Inherited From coreClient.OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From coreClient.OperationOptions.tracingOptions