Class ListInvoicesRequest

Inheritance

object

ListInvoicesRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OspgatewayService.Requests

Assembly: OCI.DotNetSDK.Ospgateway.dll

Syntax

public class ListInvoicesRequest : IOciRequest

Examples

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

Properties

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 compartment.

Remarks

Required

InvoiceId

Declaration

[HttpConverter(TargetEnum.Query, "invoiceId")]
public string InvoiceId { get; set; }

Property Value

Type	Description
string	The invoice query param (not unique).

Limit

Declaration

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

Property Value

Type	Description
int?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

OspHomeRegion

Declaration

[Required(ErrorMessage = "OspHomeRegion is required.")]
[HttpConverter(TargetEnum.Query, "ospHomeRegion")]
public string OspHomeRegion { get; set; }

Property Value

Type	Description
string	The home region's public name of the logged in user.

Remarks

Required

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	For list pagination. The value of the opc-next-page response header from the previous "List" call.

SearchText

Declaration

[HttpConverter(TargetEnum.Query, "searchText")]
public string SearchText { get; set; }

Property Value

Type	Description
string	A filter to only return resources that match the given value. Looking for partial matches in the following fileds: Invoice No., Reference No. (plan number), Payment Ref, Total Amount(plan number), Balance Due(plan number) and Party/Customer Name

SortBy

Declaration

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

Property Value

Type	Description
ListInvoicesRequest.SortByEnum?	The field to sort by. Only one field can be selected for sorting.

SortOrder

Declaration

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

Property Value

Type	Description
ListInvoicesRequest.SortOrderEnum?	The sort order to use (ascending or descending).

Status

Declaration

[HttpConverter(TargetEnum.Query, "status", CollectionFormatType.Multi)]
public List<ListInvoicesRequest.StatusEnum> Status { get; set; }

Property Value

Type	Description
List<ListInvoicesRequest.StatusEnum>	A filter to only return resources that match one of the status elements.

TimeInvoiceEnd

Declaration

[HttpConverter(TargetEnum.Query, "timeInvoiceEnd")]
public DateTime? TimeInvoiceEnd { get; set; }

Property Value

Type	Description
DateTime?	description: End time (UTC) of the target invoice date range for which to fetch invoice data (exclusive).

TimeInvoiceStart

Declaration

[HttpConverter(TargetEnum.Query, "timeInvoiceStart")]
public DateTime? TimeInvoiceStart { get; set; }

Property Value

Type	Description
DateTime?	description: Start time (UTC) of the target invoice date range for which to fetch invoice data (inclusive).

TimePaymentEnd

Declaration

[HttpConverter(TargetEnum.Query, "timePaymentEnd")]
public DateTime? TimePaymentEnd { get; set; }

Property Value

Type	Description
DateTime?	description: End time (UTC) of the target payment date range for which to fetch invoice data (exclusive).

TimePaymentStart

Declaration

[HttpConverter(TargetEnum.Query, "timePaymentStart")]
public DateTime? TimePaymentStart { get; set; }

Property Value

Type	Description
DateTime?	description: Start time (UTC) of the target payment date range for which to fetch invoice data (inclusive).

Type

Declaration

[HttpConverter(TargetEnum.Query, "type", CollectionFormatType.Multi)]
public List<ListInvoicesRequest.TypeEnum> Type { get; set; }

Property Value

Type	Description
List<ListInvoicesRequest.TypeEnum>	A filter to only return resources that match the given type exactly.

Implements

IOciRequest