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. |
| order |
The orderby query option allows clients to request resources in a particular order. |
| period |
The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. |
| period |
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
| abort |
The signal which can be used to abort requests. |
| on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
| request |
Options used when creating and sending HTTP requests for this operation. |
| serializer |
Options to override serialization/de-serialization behavior. |
| tracing |
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?: booleanProperty Value
boolean
filter
The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
filter?: stringProperty Value
string
orderBy
The orderby query option allows clients to request resources in a particular order.
orderBy?: stringProperty 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?: DateProperty 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?: DateProperty Value
Date
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.
search?: stringProperty 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?: numberProperty 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?: numberProperty Value
number
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLikeProperty 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?: RawResponseCallbackProperty Value
Inherited From coreClient.OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptionsProperty Value
Inherited From coreClient.OperationOptions.requestOptions
serializerOptions
Options to override serialization/de-serialization behavior.
serializerOptions?: SerializerOptionsProperty Value
Inherited From coreClient.OperationOptions.serializerOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
Inherited From coreClient.OperationOptions.tracingOptions