Class ListInvoicesRequest

Inheritance
object
ListInvoicesRequest
Implements
Inherited Members
Namespace: Oci.OnesubscriptionService.Requests
Assembly: OCI.DotNetSDK.Onesubscription.dll
Syntax
public class ListInvoicesRequest : IOciRequest
Examples

Click here to see an example of how to use ListInvoices request.

Properties

ArCustomerTransactionId

Declaration
[Required(ErrorMessage = "ArCustomerTransactionId is required.")]
[HttpConverter(TargetEnum.Query, "arCustomerTransactionId")]
public string ArCustomerTransactionId { get; set; }
Property Value
Type Description
string

AR Unique identifier for an invoice .
Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the root compartment.
Remarks

Required

Fields

Declaration
[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<string> Fields { get; set; }
Property Value
Type Description
List<string>

Partial response refers to an optimization technique offered by the RESTful web APIs to return only the information (fields) required by the client. This parameter is used to control what fields to return.

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

The maximum number of items to return in a paginated "List" call. Default: (50)
Example: '500'

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

The value of the 'opc-next-page' response header from the previous "List" call.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListInvoicesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListInvoicesRequest.SortByEnum?

The field to sort by. You can provide one sort order ('sortOrder').

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListInvoicesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListInvoicesRequest.SortOrderEnum?

The sort order to use, either ascending ('ASC') or descending ('DESC').

TimeFrom

Declaration
[HttpConverter(TargetEnum.Query, "timeFrom")]
public DateTime? TimeFrom { get; set; }
Property Value
Type Description
DateTime?

Initial date to filter Invoice data in SPM.

TimeTo

Declaration
[HttpConverter(TargetEnum.Query, "timeTo")]
public DateTime? TimeTo { get; set; }
Property Value
Type Description
DateTime?

Final date to filter Invoice data in SPM.

Implements