Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListInvoicesRequest

example

Click here to see how to use ListInvoicesRequest.

Properties

compartmentId

compartmentId: string

The OCID of the compartment.

Optional invoiceId

invoiceId: undefined | string

The invoice query param (not unique).

Optional limit

limit: undefined | number

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

Optional opcRequestId

opcRequestId: undefined | 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

ospHomeRegion: string

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

Optional page

page: undefined | string

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

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional searchText

searchText: undefined | 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

Optional sortBy

sortBy: SortBy

The field to sort by. Only one field can be selected for sorting.

Optional sortOrder

sortOrder: SortOrder

The sort order to use (ascending or descending).

Optional status

status: Array<Status>

A filter to only return resources that match one of the status elements.

Optional timeInvoiceEnd

timeInvoiceEnd: Date

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

Optional timeInvoiceStart

timeInvoiceStart: Date

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

Optional timePaymentEnd

timePaymentEnd: Date

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

Optional timePaymentStart

timePaymentStart: Date

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

Optional type

type: Array<Type>

A filter to only return resources that match the given type exactly.