Class InvoiceServiceClient
Service client instance for InvoiceService.
Implements
Inherited Members
Namespace: Oci.OspgatewayService
Assembly: OCI.DotNetSDK.Ospgateway.dll
Syntax
public class InvoiceServiceClient : RegionalClientBase, IDisposable
Constructors
InvoiceServiceClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public InvoiceServiceClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public InvoiceServicePaginators Paginators { get; }
Property Value
Type | Description |
---|---|
InvoiceServicePaginators |
Methods
DownloadPdfContent(DownloadPdfContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns an invoice in pdf format
Declaration
public Task<DownloadPdfContentResponse> DownloadPdfContent(DownloadPdfContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DownloadPdfContentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DownloadPdfContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DownloadPdfContent API.
GetInvoice(GetInvoiceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns an invoice by invoice id
Declaration
public Task<GetInvoiceResponse> GetInvoice(GetInvoiceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetInvoiceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetInvoiceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetInvoice API.
ListInvoiceLines(ListInvoiceLinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the invoice product list by invoice id
Declaration
public Task<ListInvoiceLinesResponse> ListInvoiceLines(ListInvoiceLinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListInvoiceLinesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListInvoiceLinesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListInvoiceLines API.
ListInvoices(ListInvoicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of invoices
Declaration
public Task<ListInvoicesResponse> ListInvoices(ListInvoicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListInvoicesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListInvoicesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListInvoices API.
PayInvoice(PayInvoiceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Pay an invoice
Declaration
public Task<PayInvoiceResponse> PayInvoice(PayInvoiceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PayInvoiceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PayInvoiceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PayInvoice API.