Oracle Cloud Infrastructure v3.0.0, Jun 5 25

Oracle Cloud Infrastructure v3.0.0 published on Thursday, Jun 5, 2025 by Pulumi

oci.OspGateway.getInvoice

Explore with Pulumi AI

Oracle Cloud Infrastructure v3.0.0 published on Thursday, Jun 5, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testInvoice = oci.OspGateway.getInvoice({
    compartmentId: compartmentId,
    internalInvoiceId: testInvoiceOciOspGatewayInvoice.id,
    ospHomeRegion: invoiceOspHomeRegion,
});

import pulumi
import pulumi_oci as oci

test_invoice = oci.OspGateway.get_invoice(compartment_id=compartment_id,
    internal_invoice_id=test_invoice_oci_osp_gateway_invoice["id"],
    osp_home_region=invoice_osp_home_region)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/ospgateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ospgateway.GetInvoice(ctx, &ospgateway.GetInvoiceArgs{
			CompartmentId:     compartmentId,
			InternalInvoiceId: testInvoiceOciOspGatewayInvoice.Id,
			OspHomeRegion:     invoiceOspHomeRegion,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testInvoice = Oci.OspGateway.GetInvoice.Invoke(new()
    {
        CompartmentId = compartmentId,
        InternalInvoiceId = testInvoiceOciOspGatewayInvoice.Id,
        OspHomeRegion = invoiceOspHomeRegion,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.OspGateway.OspGatewayFunctions;
import com.pulumi.oci.OspGateway.inputs.GetInvoiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testInvoice = OspGatewayFunctions.getInvoice(GetInvoiceArgs.builder()
            .compartmentId(compartmentId)
            .internalInvoiceId(testInvoiceOciOspGatewayInvoice.id())
            .ospHomeRegion(invoiceOspHomeRegion)
            .build());

    }
}

variables:
  testInvoice:
    fn::invoke:
      function: oci:OspGateway:getInvoice
      arguments:
        compartmentId: ${compartmentId}
        internalInvoiceId: ${testInvoiceOciOspGatewayInvoice.id}
        ospHomeRegion: ${invoiceOspHomeRegion}

Using getInvoice

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInvoice(args: GetInvoiceArgs, opts?: InvokeOptions): Promise<GetInvoiceResult>
function getInvoiceOutput(args: GetInvoiceOutputArgs, opts?: InvokeOptions): Output<GetInvoiceResult>

def get_invoice(compartment_id: Optional[str] = None,
                internal_invoice_id: Optional[str] = None,
                osp_home_region: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetInvoiceResult
def get_invoice_output(compartment_id: Optional[pulumi.Input[str]] = None,
                internal_invoice_id: Optional[pulumi.Input[str]] = None,
                osp_home_region: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetInvoiceResult]

func GetInvoice(ctx *Context, args *GetInvoiceArgs, opts ...InvokeOption) (*GetInvoiceResult, error)
func GetInvoiceOutput(ctx *Context, args *GetInvoiceOutputArgs, opts ...InvokeOption) GetInvoiceResultOutput

> Note: This function is named GetInvoice in the Go SDK.

public static class GetInvoice 
{
    public static Task<GetInvoiceResult> InvokeAsync(GetInvoiceArgs args, InvokeOptions? opts = null)
    public static Output<GetInvoiceResult> Invoke(GetInvoiceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInvoiceResult> getInvoice(GetInvoiceArgs args, InvokeOptions options)
public static Output<GetInvoiceResult> getInvoice(GetInvoiceArgs args, InvokeOptions options)

fn::invoke:
  function: oci:OspGateway/getInvoice:getInvoice
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
InternalInvoiceId string: The identifier of the invoice.
OspHomeRegion string: The home region's public name of the logged in user.

CompartmentId string: The OCID of the compartment.
InternalInvoiceId string: The identifier of the invoice.
OspHomeRegion string: The home region's public name of the logged in user.

compartmentId String: The OCID of the compartment.
internalInvoiceId String: The identifier of the invoice.
ospHomeRegion String: The home region's public name of the logged in user.

compartmentId string: The OCID of the compartment.
internalInvoiceId string: The identifier of the invoice.
ospHomeRegion string: The home region's public name of the logged in user.

compartment_id str: The OCID of the compartment.
internal_invoice_id str: The identifier of the invoice.
osp_home_region str: The home region's public name of the logged in user.

compartmentId String: The OCID of the compartment.
internalInvoiceId String: The identifier of the invoice.
ospHomeRegion String: The home region's public name of the logged in user.

getInvoice Result

The following output properties are available:

BillToAddresses List<GetInvoiceBillToAddress>: Address details model
CompartmentId string
Currencies List<GetInvoiceCurrency>: Currency details model
Id string: The provider-assigned unique ID for this managed resource.
InternalInvoiceId string: Transaction identifier
InvoiceAmount double: Total amount of invoice
InvoiceAmountAdjusted double: Invoice amount adjust
InvoiceAmountApplied double: Invoice amount applied
InvoiceAmountCredited double: Invoice amount credit
InvoiceAmountDue double: Balance of invoice
InvoiceId string: Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
InvoiceNumber string: Invoice external reference
InvoicePoNumber string: Invoice PO number
InvoiceRefNumber string: Invoice reference number
InvoiceStatus string: Invoice status
InvoiceType string: Type of invoice
IsCreditCardPayable bool: Is credit card payment eligible
IsDisplayDownloadPdf bool: Is pdf download access allowed
IsPayable bool: Whether invoice can be payed
IsPdfEmailAvailable bool: Is emailing pdf allowed
LastPaymentDetails List<GetInvoiceLastPaymentDetail>: Payment related details
OspHomeRegion string
PaymentTerms string: Payment terms
PreferredEmail string: Preferred Email on the invoice
SubscriptionIds List<string>: List of subscription identifiers
Tax double: Tax of invoice amount
TimeInvoice string: Date of invoice
TimeInvoiceDue string: Due date of invoice

BillToAddresses []GetInvoiceBillToAddress: Address details model
CompartmentId string
Currencies []GetInvoiceCurrency: Currency details model
Id string: The provider-assigned unique ID for this managed resource.
InternalInvoiceId string: Transaction identifier
InvoiceAmount float64: Total amount of invoice
InvoiceAmountAdjusted float64: Invoice amount adjust
InvoiceAmountApplied float64: Invoice amount applied
InvoiceAmountCredited float64: Invoice amount credit
InvoiceAmountDue float64: Balance of invoice
InvoiceId string: Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
InvoiceNumber string: Invoice external reference
InvoicePoNumber string: Invoice PO number
InvoiceRefNumber string: Invoice reference number
InvoiceStatus string: Invoice status
InvoiceType string: Type of invoice
IsCreditCardPayable bool: Is credit card payment eligible
IsDisplayDownloadPdf bool: Is pdf download access allowed
IsPayable bool: Whether invoice can be payed
IsPdfEmailAvailable bool: Is emailing pdf allowed
LastPaymentDetails []GetInvoiceLastPaymentDetail: Payment related details
OspHomeRegion string
PaymentTerms string: Payment terms
PreferredEmail string: Preferred Email on the invoice
SubscriptionIds []string: List of subscription identifiers
Tax float64: Tax of invoice amount
TimeInvoice string: Date of invoice
TimeInvoiceDue string: Due date of invoice

billToAddresses List<GetInvoiceBillToAddress>: Address details model
compartmentId String
currencies List<GetInvoiceCurrency>: Currency details model
id String: The provider-assigned unique ID for this managed resource.
internalInvoiceId String: Transaction identifier
invoiceAmount Double: Total amount of invoice
invoiceAmountAdjusted Double: Invoice amount adjust
invoiceAmountApplied Double: Invoice amount applied
invoiceAmountCredited Double: Invoice amount credit
invoiceAmountDue Double: Balance of invoice
invoiceId String: Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
invoiceNumber String: Invoice external reference
invoicePoNumber String: Invoice PO number
invoiceRefNumber String: Invoice reference number
invoiceStatus String: Invoice status
invoiceType String: Type of invoice
isCreditCardPayable Boolean: Is credit card payment eligible
isDisplayDownloadPdf Boolean: Is pdf download access allowed
isPayable Boolean: Whether invoice can be payed
isPdfEmailAvailable Boolean: Is emailing pdf allowed
lastPaymentDetails List<GetInvoiceLastPaymentDetail>: Payment related details
ospHomeRegion String
paymentTerms String: Payment terms
preferredEmail String: Preferred Email on the invoice
subscriptionIds List<String>: List of subscription identifiers
tax Double: Tax of invoice amount
timeInvoice String: Date of invoice
timeInvoiceDue String: Due date of invoice

billToAddresses GetInvoiceBillToAddress[]: Address details model
compartmentId string
currencies GetInvoiceCurrency[]: Currency details model
id string: The provider-assigned unique ID for this managed resource.
internalInvoiceId string: Transaction identifier
invoiceAmount number: Total amount of invoice
invoiceAmountAdjusted number: Invoice amount adjust
invoiceAmountApplied number: Invoice amount applied
invoiceAmountCredited number: Invoice amount credit
invoiceAmountDue number: Balance of invoice
invoiceId string: Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
invoiceNumber string: Invoice external reference
invoicePoNumber string: Invoice PO number
invoiceRefNumber string: Invoice reference number
invoiceStatus string: Invoice status
invoiceType string: Type of invoice
isCreditCardPayable boolean: Is credit card payment eligible
isDisplayDownloadPdf boolean: Is pdf download access allowed
isPayable boolean: Whether invoice can be payed
isPdfEmailAvailable boolean: Is emailing pdf allowed
lastPaymentDetails GetInvoiceLastPaymentDetail[]: Payment related details
ospHomeRegion string
paymentTerms string: Payment terms
preferredEmail string: Preferred Email on the invoice
subscriptionIds string[]: List of subscription identifiers
tax number: Tax of invoice amount
timeInvoice string: Date of invoice
timeInvoiceDue string: Due date of invoice

bill_to_addresses Sequence[GetInvoiceBillToAddress]: Address details model
compartment_id str
currencies Sequence[GetInvoiceCurrency]: Currency details model
id str: The provider-assigned unique ID for this managed resource.
internal_invoice_id str: Transaction identifier
invoice_amount float: Total amount of invoice
invoice_amount_adjusted float: Invoice amount adjust
invoice_amount_applied float: Invoice amount applied
invoice_amount_credited float: Invoice amount credit
invoice_amount_due float: Balance of invoice
invoice_id str: Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
invoice_number str: Invoice external reference
invoice_po_number str: Invoice PO number
invoice_ref_number str: Invoice reference number
invoice_status str: Invoice status
invoice_type str: Type of invoice
is_credit_card_payable bool: Is credit card payment eligible
is_display_download_pdf bool: Is pdf download access allowed
is_payable bool: Whether invoice can be payed
is_pdf_email_available bool: Is emailing pdf allowed
last_payment_details Sequence[GetInvoiceLastPaymentDetail]: Payment related details
osp_home_region str
payment_terms str: Payment terms
preferred_email str: Preferred Email on the invoice
subscription_ids Sequence[str]: List of subscription identifiers
tax float: Tax of invoice amount
time_invoice str: Date of invoice
time_invoice_due str: Due date of invoice

billToAddresses List<Property Map>: Address details model
compartmentId String
currencies List<Property Map>: Currency details model
id String: The provider-assigned unique ID for this managed resource.
internalInvoiceId String: Transaction identifier
invoiceAmount Number: Total amount of invoice
invoiceAmountAdjusted Number: Invoice amount adjust
invoiceAmountApplied Number: Invoice amount applied
invoiceAmountCredited Number: Invoice amount credit
invoiceAmountDue Number: Balance of invoice
invoiceId String: Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
invoiceNumber String: Invoice external reference
invoicePoNumber String: Invoice PO number
invoiceRefNumber String: Invoice reference number
invoiceStatus String: Invoice status
invoiceType String: Type of invoice
isCreditCardPayable Boolean: Is credit card payment eligible
isDisplayDownloadPdf Boolean: Is pdf download access allowed
isPayable Boolean: Whether invoice can be payed
isPdfEmailAvailable Boolean: Is emailing pdf allowed
lastPaymentDetails List<Property Map>: Payment related details
ospHomeRegion String
paymentTerms String: Payment terms
preferredEmail String: Preferred Email on the invoice
subscriptionIds List<String>: List of subscription identifiers
tax Number: Tax of invoice amount
timeInvoice String: Date of invoice
timeInvoiceDue String: Due date of invoice

Supporting Types

GetInvoiceBillToAddress

AddressLine1 string: Address line 1
AddressLine2 string: Address line 2
AddressLine3 string: Address line 3
AddressLine4 string: Address line 4
City string: Name of the city
CompanyName string: Name of the customer company
ContactName string: Name of the contact person
Countries List<GetInvoiceBillToAddressCountry>: Country details model
County string: County name
PostalCode string: ZIP no
Province string: Name of the province
State string: Name of the state
StreetName string: Street name
StreetNumber string: House no

AddressLine1 string: Address line 1
AddressLine2 string: Address line 2
AddressLine3 string: Address line 3
AddressLine4 string: Address line 4
City string: Name of the city
CompanyName string: Name of the customer company
ContactName string: Name of the contact person
Countries []GetInvoiceBillToAddressCountry: Country details model
County string: County name
PostalCode string: ZIP no
Province string: Name of the province
State string: Name of the state
StreetName string: Street name
StreetNumber string: House no

addressLine1 String: Address line 1
addressLine2 String: Address line 2
addressLine3 String: Address line 3
addressLine4 String: Address line 4
city String: Name of the city
companyName String: Name of the customer company
contactName String: Name of the contact person
countries List<GetInvoiceBillToAddressCountry>: Country details model
county String: County name
postalCode String: ZIP no
province String: Name of the province
state String: Name of the state
streetName String: Street name
streetNumber String: House no

addressLine1 string: Address line 1
addressLine2 string: Address line 2
addressLine3 string: Address line 3
addressLine4 string: Address line 4
city string: Name of the city
companyName string: Name of the customer company
contactName string: Name of the contact person
countries GetInvoiceBillToAddressCountry[]: Country details model
county string: County name
postalCode string: ZIP no
province string: Name of the province
state string: Name of the state
streetName string: Street name
streetNumber string: House no

address_line1 str: Address line 1
address_line2 str: Address line 2
address_line3 str: Address line 3
address_line4 str: Address line 4
city str: Name of the city
company_name str: Name of the customer company
contact_name str: Name of the contact person
countries Sequence[GetInvoiceBillToAddressCountry]: Country details model
county str: County name
postal_code str: ZIP no
province str: Name of the province
state str: Name of the state
street_name str: Street name
street_number str: House no

addressLine1 String: Address line 1
addressLine2 String: Address line 2
addressLine3 String: Address line 3
addressLine4 String: Address line 4
city String: Name of the city
companyName String: Name of the customer company
contactName String: Name of the contact person
countries List<Property Map>: Country details model
county String: County name
postalCode String: ZIP no
province String: Name of the province
state String: Name of the state
streetName String: Street name
streetNumber String: House no

GetInvoiceBillToAddressCountry

Ascii3countryCode string: Country code in ISO-3166-1 3-letter format
CountryCode string: Country code in ISO-3166-1 2-letter format
CountryId double: Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
CountryName string: Name of the country
LanguageId double: Language identifier

Ascii3countryCode string: Country code in ISO-3166-1 3-letter format
CountryCode string: Country code in ISO-3166-1 2-letter format
CountryId float64: Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
CountryName string: Name of the country
LanguageId float64: Language identifier

ascii3countryCode String: Country code in ISO-3166-1 3-letter format
countryCode String: Country code in ISO-3166-1 2-letter format
countryId Double: Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
countryName String: Name of the country
languageId Double: Language identifier

ascii3countryCode string: Country code in ISO-3166-1 3-letter format
countryCode string: Country code in ISO-3166-1 2-letter format
countryId number: Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
countryName string: Name of the country
languageId number: Language identifier

ascii3country_code str: Country code in ISO-3166-1 3-letter format
country_code str: Country code in ISO-3166-1 2-letter format
country_id float: Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
country_name str: Name of the country
language_id float: Language identifier

ascii3countryCode String: Country code in ISO-3166-1 3-letter format
countryCode String: Country code in ISO-3166-1 2-letter format
countryId Number: Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
countryName String: Name of the country
languageId Number: Language identifier

GetInvoiceCurrency

CurrencyCode string: Currency code
CurrencySymbol string: Currency symbol
Name string: Name of the currency
RoundDecimalPoint double: Round decimal point
UsdConversion double: USD conversion rate of the currency

CurrencyCode string: Currency code
CurrencySymbol string: Currency symbol
Name string: Name of the currency
RoundDecimalPoint float64: Round decimal point
UsdConversion float64: USD conversion rate of the currency

currencyCode String: Currency code
currencySymbol String: Currency symbol
name String: Name of the currency
roundDecimalPoint Double: Round decimal point
usdConversion Double: USD conversion rate of the currency

currencyCode string: Currency code
currencySymbol string: Currency symbol
name string: Name of the currency
roundDecimalPoint number: Round decimal point
usdConversion number: USD conversion rate of the currency

currency_code str: Currency code
currency_symbol str: Currency symbol
name str: Name of the currency
round_decimal_point float: Round decimal point
usd_conversion float: USD conversion rate of the currency

currencyCode String: Currency code
currencySymbol String: Currency symbol
name String: Name of the currency
roundDecimalPoint Number: Round decimal point
usdConversion Number: USD conversion rate of the currency

GetInvoiceLastPaymentDetail

AccountNumber string: Account number of the card owner
AmountPaid double: Amount that paid
CardType string: Echeck card type
CreditCardType string: Credit card type
EcheckRouting string: Last four routing digits of the card
LastDigits string: Last four digits of the card
NameOnCard string: Name on the credit card
PaidBy string: example
PaymentMethod string: Payment method
PaypalId string: The id (email address) of the paypal payment
PaypalReference string: paypal payment reference
RoutingNumber string: Routing number of the echeck card
TimeExpiration string: Expired date of the credit card
TimePaidOn string: Paid the invoice on this day

AccountNumber string: Account number of the card owner
AmountPaid float64: Amount that paid
CardType string: Echeck card type
CreditCardType string: Credit card type
EcheckRouting string: Last four routing digits of the card
LastDigits string: Last four digits of the card
NameOnCard string: Name on the credit card
PaidBy string: example
PaymentMethod string: Payment method
PaypalId string: The id (email address) of the paypal payment
PaypalReference string: paypal payment reference
RoutingNumber string: Routing number of the echeck card
TimeExpiration string: Expired date of the credit card
TimePaidOn string: Paid the invoice on this day

accountNumber String: Account number of the card owner
amountPaid Double: Amount that paid
cardType String: Echeck card type
creditCardType String: Credit card type
echeckRouting String: Last four routing digits of the card
lastDigits String: Last four digits of the card
nameOnCard String: Name on the credit card
paidBy String: example
paymentMethod String: Payment method
paypalId String: The id (email address) of the paypal payment
paypalReference String: paypal payment reference
routingNumber String: Routing number of the echeck card
timeExpiration String: Expired date of the credit card
timePaidOn String: Paid the invoice on this day

accountNumber string: Account number of the card owner
amountPaid number: Amount that paid
cardType string: Echeck card type
creditCardType string: Credit card type
echeckRouting string: Last four routing digits of the card
lastDigits string: Last four digits of the card
nameOnCard string: Name on the credit card
paidBy string: example
paymentMethod string: Payment method
paypalId string: The id (email address) of the paypal payment
paypalReference string: paypal payment reference
routingNumber string: Routing number of the echeck card
timeExpiration string: Expired date of the credit card
timePaidOn string: Paid the invoice on this day

account_number str: Account number of the card owner
amount_paid float: Amount that paid
card_type str: Echeck card type
credit_card_type str: Credit card type
echeck_routing str: Last four routing digits of the card
last_digits str: Last four digits of the card
name_on_card str: Name on the credit card
paid_by str: example
payment_method str: Payment method
paypal_id str: The id (email address) of the paypal payment
paypal_reference str: paypal payment reference
routing_number str: Routing number of the echeck card
time_expiration str: Expired date of the credit card
time_paid_on str: Paid the invoice on this day

accountNumber String: Account number of the card owner
amountPaid Number: Amount that paid
cardType String: Echeck card type
creditCardType String: Credit card type
echeckRouting String: Last four routing digits of the card
lastDigits String: Last four digits of the card
nameOnCard String: Name on the credit card
paidBy String: example
paymentMethod String: Payment method
paypalId String: The id (email address) of the paypal payment
paypalReference String: paypal payment reference
routingNumber String: Routing number of the echeck card
timeExpiration String: Expired date of the credit card
timePaidOn String: Paid the invoice on this day

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v3.0.0 published on Thursday, Jun 5, 2025 by Pulumi

pulumi/pulumi-oci

oci.OspGateway.getInvoice

On this page

On this page

Example Usage

Using getInvoice

getInvoice Result

Supporting Types

GetInvoiceBillToAddress

GetInvoiceBillToAddressCountry

GetInvoiceCurrency

GetInvoiceLastPaymentDetail

Package Details

On this page

On this page