InvoiceServiceClient

class oci.osp_gateway.InvoiceServiceClient(config, **kwargs)

This site describes all the Rest endpoints of OSP Gateway.

Methods

__init__(config, **kwargs) Creates a new service client
download_pdf_content(osp_home_region, …) Returns an invoice in pdf format
get_invoice(osp_home_region, compartment_id, …) Returns an invoice by invoice id
list_invoice_lines(osp_home_region, …) Returns the invoice product list by invoice id
list_invoices(osp_home_region, …) Returns a list of invoices
pay_invoice(osp_home_region, …) Pay an invoice
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
download_pdf_content(osp_home_region, compartment_id, internal_invoice_id, **kwargs)

Returns an invoice in pdf format

Parameters:
  • osp_home_region (str) – (required) The home region’s public name of the logged in user.
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • internal_invoice_id (str) – (required) The identifier of the invoice.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_pdf_content API.

get_invoice(osp_home_region, compartment_id, internal_invoice_id, **kwargs)

Returns an invoice by invoice id

Parameters:
  • osp_home_region (str) – (required) The home region’s public name of the logged in user.
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • internal_invoice_id (str) – (required) The identifier of the invoice.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Invoice

Return type:

Response

Example:

Click here to see an example of how to use get_invoice API.

list_invoice_lines(osp_home_region, compartment_id, internal_invoice_id, **kwargs)

Returns the invoice product list by invoice id

Parameters:
  • osp_home_region (str) – (required) The home region’s public name of the logged in user.
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • internal_invoice_id (str) – (required) The identifier of the invoice.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type InvoiceLineCollection

Return type:

Response

Example:

Click here to see an example of how to use list_invoice_lines API.

list_invoices(osp_home_region, compartment_id, **kwargs)

Returns a list of invoices

Parameters:
  • osp_home_region (str) – (required) The home region’s public name of the logged in user.
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • invoice_id (str) – (optional) The invoice query param (not unique).
  • type (list[str]) –

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

    Allowed values are: “HARDWARE”, “SUBSCRIPTION”, “SUPPORT”, “LICENSE”, “EDUCATION”, “CONSULTING”, “SERVICE”, “USAGE”

  • search_text (str) – (optional) 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
  • time_invoice_start (datetime) – (optional) description: Start time (UTC) of the target invoice date range for which to fetch invoice data (inclusive).
  • time_invoice_end (datetime) – (optional) description: End time (UTC) of the target invoice date range for which to fetch invoice data (exclusive).
  • time_payment_start (datetime) – (optional) description: Start time (UTC) of the target payment date range for which to fetch invoice data (inclusive).
  • time_payment_end (datetime) – (optional) description: End time (UTC) of the target payment date range for which to fetch invoice data (exclusive).
  • status (list[str]) –

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

    Allowed values are: “OPEN”, “PAST_DUE”, “PAYMENT_SUBMITTED”, “CLOSED”

  • page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call.
  • sort_by (str) –

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

    Allowed values are: “INVOICE_NO”, “REF_NO”, “STATUS”, “TYPE”, “INVOICE_DATE”, “DUE_DATE”, “PAYM_REF”, “TOTAL_AMOUNT”, “BALANCE_DUE”

  • sort_order (str) –

    (optional) The sort order to use (ascending or descending).

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type InvoiceCollection

Return type:

Response

Example:

Click here to see an example of how to use list_invoices API.

pay_invoice(osp_home_region, internal_invoice_id, compartment_id, pay_invoice_details, **kwargs)

Pay an invoice

Parameters:
  • osp_home_region (str) – (required) The home region’s public name of the logged in user.
  • internal_invoice_id (str) – (required) The identifier of the invoice.
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • pay_invoice_details (oci.osp_gateway.models.PayInvoiceDetails) – (required) Invoice payment request.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_retry_token (str) – (optional) For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type PayInvoiceReceipt

Return type:

Response

Example:

Click here to see an example of how to use pay_invoice API.