oracle.oci.oci_osp_gateway_invoice_actions – Perform actions on an Invoice resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_osp_gateway_invoice_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on an Invoice resource in Oracle Cloud Infrastructure

  • For action=download_pdf_content, returns an invoice in pdf format

  • For action=pay, pay an invoice

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • download_pdf_content
  • pay
The action to perform on the Invoice.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string / required
The OCID of the compartment.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
dest
string
The destination file path to write the output. The file will be created if it does not exist. If the file already exists, the content will be overwritten.
Required for action=download_pdf_content.
email
string
User email
Required for action=pay.
internal_invoice_id
string / required
The identifier of the invoice.

aliases: id
language_code
string
Language code
Applicable only for action=pay.
osp_home_region
string / required
The home region's public name of the logged in user.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
return_url
string
Callback URL
Applicable only for action=pay.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Perform action download_pdf_content on invoice
  oci_osp_gateway_invoice_actions:
    # required
    dest: /tmp/myfile
    osp_home_region: us-phoenix-1
    internal_invoice_id: "ocid1.internalinvoice.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: download_pdf_content

- name: Perform action pay on invoice
  oci_osp_gateway_invoice_actions:
    # required
    osp_home_region: us-phoenix-1
    internal_invoice_id: "ocid1.internalinvoice.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    email: email_example
    action: pay

    # optional
    language_code: language_code_example
    return_url: return_url_example

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
pay_invoice_receipt
complex
on success
Details of the Invoice resource acted upon by the current operation

Sample:
{'header_id': 'ocid1.header.oc1..xxxxxxEXAMPLExxxxxx', 'token': 'token_example', 'url': 'url_example'}
 
header_id
string
on success
Payment header id

Sample:
ocid1.header.oc1..xxxxxxEXAMPLExxxxxx
 
token
string
on success
Token created for Payment Service

Sample:
token_example
 
url
string
on success
Url of the Payment Service

Sample:
url_example


Authors

  • Oracle (@oracle)