Oracle Cloud Infrastructure
getInvoice
This data source provides details about a specific Invoice resource in Oracle Cloud Infrastructure Osp Gateway service.
Returns an invoice by invoice id
Example Usage
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testInvoice = Output.Create(Oci.OspGateway.GetInvoice.InvokeAsync(new Oci.OspGateway.GetInvoiceArgs
{
CompartmentId = @var.Compartment_id,
InternalInvoiceId = oci_osp_gateway_invoice.Test_invoice.Id,
OspHomeRegion = @var.Invoice_osp_home_region,
}));
}
}
package main
import (
"github.com/pulumi/pulumi-oci/sdk/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: _var.Compartment_id,
InternalInvoiceId: oci_osp_gateway_invoice.Test_invoice.Id,
OspHomeRegion: _var.Invoice_osp_home_region,
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_invoice = oci.OspGateway.get_invoice(compartment_id=var["compartment_id"],
internal_invoice_id=oci_osp_gateway_invoice["test_invoice"]["id"],
osp_home_region=var["invoice_osp_home_region"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testInvoice = oci.OspGateway.getInvoice({
compartmentId: _var.compartment_id,
internalInvoiceId: oci_osp_gateway_invoice.test_invoice.id,
ospHomeRegion: _var.invoice_osp_home_region,
});
Coming soon!
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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: oci:OspGateway/getInvoice:getInvoice
Arguments:
# Arguments dictionary
The following arguments are supported:
- Compartment
Id string The OCID of the compartment.
- Internal
Invoice stringId The identifier of the invoice.
- Osp
Home stringRegion The home region's public name of the logged in user.
- Compartment
Id string The OCID of the compartment.
- Internal
Invoice stringId The identifier of the invoice.
- Osp
Home stringRegion The home region's public name of the logged in user.
- compartment
Id String The OCID of the compartment.
- internal
Invoice StringId The identifier of the invoice.
- osp
Home StringRegion The home region's public name of the logged in user.
- compartment
Id string The OCID of the compartment.
- internal
Invoice stringId The identifier of the invoice.
- osp
Home stringRegion The home region's public name of the logged in user.
- compartment_
id str The OCID of the compartment.
- internal_
invoice_ strid The identifier of the invoice.
- osp_
home_ strregion The home region's public name of the logged in user.
- compartment
Id String The OCID of the compartment.
- internal
Invoice StringId The identifier of the invoice.
- osp
Home StringRegion The home region's public name of the logged in user.
getInvoice Result
The following output properties are available:
- Bill
To List<GetAddresses Invoice Bill To Address> Address details model
- Compartment
Id string - Currencies
List<Get
Invoice Currency> Currency details model
- Id string
The provider-assigned unique ID for this managed resource.
- Internal
Invoice stringId Transaction identifier
- Invoice
Amount double Total amount of invoice
- Invoice
Amount doubleAdjusted Invoice amount adjust
- Invoice
Amount doubleApplied Invoice amount applied
- Invoice
Amount doubleCredited Invoice amount credit
- Invoice
Amount doubleDue Balance of invoice
- Invoice
Id string Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
- Invoice
Number string Invoice external reference
- Invoice
Po stringNumber Invoice PO number
- Invoice
Ref stringNumber Invoice reference number
- Invoice
Status string Invoice status
- Invoice
Type string Type of invoice
- Is
Credit boolCard Payable Is credit card payment eligible
- Is
Display boolDownload Pdf Is pdf download access allowed
- Is
Payable bool Whether invoice can be payed
- Is
Pdf boolEmail Available Is emailing pdf allowed
- Last
Payment List<GetDetails Invoice Last Payment Detail> Payment related details
- Osp
Home stringRegion - Payment
Terms string Payment terms
- Preferred
Email string Preferred Email on the invoice
- Subscription
Ids List<string> List of subscription identifiers
- Tax double
Tax of invoice amount
- Time
Invoice string Date of invoice
- Time
Invoice stringDue Due date of invoice
- Bill
To []GetAddresses Invoice Bill To Address Address details model
- Compartment
Id string - Currencies
[]Get
Invoice Currency Currency details model
- Id string
The provider-assigned unique ID for this managed resource.
- Internal
Invoice stringId Transaction identifier
- Invoice
Amount float64 Total amount of invoice
- Invoice
Amount float64Adjusted Invoice amount adjust
- Invoice
Amount float64Applied Invoice amount applied
- Invoice
Amount float64Credited Invoice amount credit
- Invoice
Amount float64Due Balance of invoice
- Invoice
Id string Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
- Invoice
Number string Invoice external reference
- Invoice
Po stringNumber Invoice PO number
- Invoice
Ref stringNumber Invoice reference number
- Invoice
Status string Invoice status
- Invoice
Type string Type of invoice
- Is
Credit boolCard Payable Is credit card payment eligible
- Is
Display boolDownload Pdf Is pdf download access allowed
- Is
Payable bool Whether invoice can be payed
- Is
Pdf boolEmail Available Is emailing pdf allowed
- Last
Payment []GetDetails Invoice Last Payment Detail Payment related details
- Osp
Home stringRegion - Payment
Terms string Payment terms
- Preferred
Email string Preferred Email on the invoice
- Subscription
Ids []string List of subscription identifiers
- Tax float64
Tax of invoice amount
- Time
Invoice string Date of invoice
- Time
Invoice stringDue Due date of invoice
- bill
To List<GetAddresses Invoice Bill To Address> Address details model
- compartment
Id String - currencies
List<Get
Invoice Currency> Currency details model
- id String
The provider-assigned unique ID for this managed resource.
- internal
Invoice StringId Transaction identifier
- invoice
Amount Double Total amount of invoice
- invoice
Amount DoubleAdjusted Invoice amount adjust
- invoice
Amount DoubleApplied Invoice amount applied
- invoice
Amount DoubleCredited Invoice amount credit
- invoice
Amount DoubleDue Balance of invoice
- invoice
Id String Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
- invoice
Number String Invoice external reference
- invoice
Po StringNumber Invoice PO number
- invoice
Ref StringNumber Invoice reference number
- invoice
Status String Invoice status
- invoice
Type String Type of invoice
- is
Credit BooleanCard Payable Is credit card payment eligible
- is
Display BooleanDownload Pdf Is pdf download access allowed
- is
Payable Boolean Whether invoice can be payed
- is
Pdf BooleanEmail Available Is emailing pdf allowed
- last
Payment List<GetDetails Invoice Last Payment Detail> Payment related details
- osp
Home StringRegion - payment
Terms String Payment terms
- preferred
Email String Preferred Email on the invoice
- subscription
Ids List<String> List of subscription identifiers
- tax Double
Tax of invoice amount
- time
Invoice String Date of invoice
- time
Invoice StringDue Due date of invoice
- bill
To GetAddresses Invoice Bill To Address[] Address details model
- compartment
Id string - currencies
Get
Invoice Currency[] Currency details model
- id string
The provider-assigned unique ID for this managed resource.
- internal
Invoice stringId Transaction identifier
- invoice
Amount number Total amount of invoice
- invoice
Amount numberAdjusted Invoice amount adjust
- invoice
Amount numberApplied Invoice amount applied
- invoice
Amount numberCredited Invoice amount credit
- invoice
Amount numberDue Balance of invoice
- invoice
Id string Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
- invoice
Number string Invoice external reference
- invoice
Po stringNumber Invoice PO number
- invoice
Ref stringNumber Invoice reference number
- invoice
Status string Invoice status
- invoice
Type string Type of invoice
- is
Credit booleanCard Payable Is credit card payment eligible
- is
Display booleanDownload Pdf Is pdf download access allowed
- is
Payable boolean Whether invoice can be payed
- is
Pdf booleanEmail Available Is emailing pdf allowed
- last
Payment GetDetails Invoice Last Payment Detail[] Payment related details
- osp
Home stringRegion - payment
Terms string Payment terms
- preferred
Email string Preferred Email on the invoice
- subscription
Ids string[] List of subscription identifiers
- tax number
Tax of invoice amount
- time
Invoice string Date of invoice
- time
Invoice stringDue Due date of invoice
- bill_
to_ Getaddresses Invoice Bill To Address] Address details model
- compartment_
id str - currencies
Get
Invoice Currency] Currency details model
- id str
The provider-assigned unique ID for this managed resource.
- internal_
invoice_ strid Transaction identifier
- invoice_
amount float Total amount of invoice
- invoice_
amount_ floatadjusted Invoice amount adjust
- invoice_
amount_ floatapplied Invoice amount applied
- invoice_
amount_ floatcredited Invoice amount credit
- invoice_
amount_ floatdue 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_ strnumber Invoice PO number
- invoice_
ref_ strnumber Invoice reference number
- invoice_
status str Invoice status
- invoice_
type str Type of invoice
- is_
credit_ boolcard_ payable Is credit card payment eligible
- is_
display_ booldownload_ pdf Is pdf download access allowed
- is_
payable bool Whether invoice can be payed
- is_
pdf_ boolemail_ available Is emailing pdf allowed
- last_
payment_ Getdetails Invoice Last Payment Detail] Payment related details
- osp_
home_ strregion - 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_ strdue Due date of invoice
- bill
To List<Property Map>Addresses Address details model
- compartment
Id String - currencies List<Property Map>
Currency details model
- id String
The provider-assigned unique ID for this managed resource.
- internal
Invoice StringId Transaction identifier
- invoice
Amount Number Total amount of invoice
- invoice
Amount NumberAdjusted Invoice amount adjust
- invoice
Amount NumberApplied Invoice amount applied
- invoice
Amount NumberCredited Invoice amount credit
- invoice
Amount NumberDue Balance of invoice
- invoice
Id String Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
- invoice
Number String Invoice external reference
- invoice
Po StringNumber Invoice PO number
- invoice
Ref StringNumber Invoice reference number
- invoice
Status String Invoice status
- invoice
Type String Type of invoice
- is
Credit BooleanCard Payable Is credit card payment eligible
- is
Display BooleanDownload Pdf Is pdf download access allowed
- is
Payable Boolean Whether invoice can be payed
- is
Pdf BooleanEmail Available Is emailing pdf allowed
- last
Payment List<Property Map>Details Payment related details
- osp
Home StringRegion - payment
Terms String Payment terms
- preferred
Email String Preferred Email on the invoice
- subscription
Ids List<String> List of subscription identifiers
- tax Number
Tax of invoice amount
- time
Invoice String Date of invoice
- time
Invoice StringDue Due date of invoice
Supporting Types
GetInvoiceBillToAddress
- Address
Line1 string Address line 1
- Address
Line2 string Address line 2
- Address
Line3 string Address line 3
- Address
Line4 string Address line 4
- City string
Name of the city
- Company
Name string Name of the customer company
- Contact
Name string Name of the contact person
- Countries
List<Get
Invoice Bill To Address Country> Country details model
- County string
County name
- Postal
Code string ZIP no
- Province string
Name of the province
- State string
Name of the state
- Street
Name string Street name
- Street
Number string House no
- Address
Line1 string Address line 1
- Address
Line2 string Address line 2
- Address
Line3 string Address line 3
- Address
Line4 string Address line 4
- City string
Name of the city
- Company
Name string Name of the customer company
- Contact
Name string Name of the contact person
- Countries
[]Get
Invoice Bill To Address Country Country details model
- County string
County name
- Postal
Code string ZIP no
- Province string
Name of the province
- State string
Name of the state
- Street
Name string Street name
- Street
Number string House no
- address
Line1 String Address line 1
- address
Line2 String Address line 2
- address
Line3 String Address line 3
- address
Line4 String Address line 4
- city String
Name of the city
- company
Name String Name of the customer company
- contact
Name String Name of the contact person
- countries
List<Get
Invoice Bill To Address Country> Country details model
- county String
County name
- postal
Code String ZIP no
- province String
Name of the province
- state String
Name of the state
- street
Name String Street name
- street
Number String House no
- address
Line1 string Address line 1
- address
Line2 string Address line 2
- address
Line3 string Address line 3
- address
Line4 string Address line 4
- city string
Name of the city
- company
Name string Name of the customer company
- contact
Name string Name of the contact person
- countries
Get
Invoice Bill To Address Country[] Country details model
- county string
County name
- postal
Code string ZIP no
- province string
Name of the province
- state string
Name of the state
- street
Name string Street name
- street
Number 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
Get
Invoice Bill To Address Country] 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
- address
Line1 String Address line 1
- address
Line2 String Address line 2
- address
Line3 String Address line 3
- address
Line4 String Address line 4
- city String
Name of the city
- company
Name String Name of the customer company
- contact
Name String Name of the contact person
- countries List<Property Map>
Country details model
- county String
County name
- postal
Code String ZIP no
- province String
Name of the province
- state String
Name of the state
- street
Name String Street name
- street
Number String House no
GetInvoiceBillToAddressCountry
- Ascii3country
Code string Country code in ISO-3166-1 3-letter format
- Country
Code string Country code in ISO-3166-1 2-letter format
- Country
Id double Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
- Country
Name string Name of the country
- Language
Id double Language identifier
- Ascii3country
Code string Country code in ISO-3166-1 3-letter format
- Country
Code string Country code in ISO-3166-1 2-letter format
- Country
Id float64 Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
- Country
Name string Name of the country
- Language
Id float64 Language identifier
- ascii3country
Code String Country code in ISO-3166-1 3-letter format
- country
Code String Country code in ISO-3166-1 2-letter format
- country
Id Double Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
- country
Name String Name of the country
- language
Id Double Language identifier
- ascii3country
Code string Country code in ISO-3166-1 3-letter format
- country
Code string Country code in ISO-3166-1 2-letter format
- country
Id number Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
- country
Name string Name of the country
- language
Id 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
- ascii3country
Code String Country code in ISO-3166-1 3-letter format
- country
Code String Country code in ISO-3166-1 2-letter format
- country
Id Number Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
- country
Name String Name of the country
- language
Id Number Language identifier
GetInvoiceCurrency
- Currency
Code string Currency code
- Currency
Symbol string Currency symbol
- Name string
Name of the currency
- Round
Decimal doublePoint Round decimal point
- Usd
Conversion double USD conversion rate of the currency
- Currency
Code string Currency code
- Currency
Symbol string Currency symbol
- Name string
Name of the currency
- Round
Decimal float64Point Round decimal point
- Usd
Conversion float64 USD conversion rate of the currency
- currency
Code String Currency code
- currency
Symbol String Currency symbol
- name String
Name of the currency
- round
Decimal DoublePoint Round decimal point
- usd
Conversion Double USD conversion rate of the currency
- currency
Code string Currency code
- currency
Symbol string Currency symbol
- name string
Name of the currency
- round
Decimal numberPoint Round decimal point
- usd
Conversion 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_ floatpoint Round decimal point
- usd_
conversion float USD conversion rate of the currency
- currency
Code String Currency code
- currency
Symbol String Currency symbol
- name String
Name of the currency
- round
Decimal NumberPoint Round decimal point
- usd
Conversion Number USD conversion rate of the currency
GetInvoiceLastPaymentDetail
- Amount
Paid double Amount that paid
- Credit
Card stringType Credit card type
- Echeck
Routing string Last four routing digits of the card
- Last
Digits string Last four digits of the card
- Name
On stringCard Name on the credit card
- Paid
By string example
- Payment
Method string Payment method
- Paypal
Id string The id (email address) of the paypal payment
- Paypal
Reference string paypal payment reference
- Time
Expiration string Expired date of the credit card
- Time
Paid stringOn Paid the invoice on this day
- Amount
Paid float64 Amount that paid
- Credit
Card stringType Credit card type
- Echeck
Routing string Last four routing digits of the card
- Last
Digits string Last four digits of the card
- Name
On stringCard Name on the credit card
- Paid
By string example
- Payment
Method string Payment method
- Paypal
Id string The id (email address) of the paypal payment
- Paypal
Reference string paypal payment reference
- Time
Expiration string Expired date of the credit card
- Time
Paid stringOn Paid the invoice on this day
- amount
Paid Double Amount that paid
- credit
Card StringType Credit card type
- echeck
Routing String Last four routing digits of the card
- last
Digits String Last four digits of the card
- name
On StringCard Name on the credit card
- paid
By String example
- payment
Method String Payment method
- paypal
Id String The id (email address) of the paypal payment
- paypal
Reference String paypal payment reference
- time
Expiration String Expired date of the credit card
- time
Paid StringOn Paid the invoice on this day
- amount
Paid number Amount that paid
- credit
Card stringType Credit card type
- echeck
Routing string Last four routing digits of the card
- last
Digits string Last four digits of the card
- name
On stringCard Name on the credit card
- paid
By string example
- payment
Method string Payment method
- paypal
Id string The id (email address) of the paypal payment
- paypal
Reference string paypal payment reference
- time
Expiration string Expired date of the credit card
- time
Paid stringOn Paid the invoice on this day
- amount_
paid float Amount that paid
- credit_
card_ strtype Credit card type
- echeck_
routing str Last four routing digits of the card
- last_
digits str Last four digits of the card
- name_
on_ strcard 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
- time_
expiration str Expired date of the credit card
- time_
paid_ stron Paid the invoice on this day
- amount
Paid Number Amount that paid
- credit
Card StringType Credit card type
- echeck
Routing String Last four routing digits of the card
- last
Digits String Last four digits of the card
- name
On StringCard Name on the credit card
- paid
By String example
- payment
Method String Payment method
- paypal
Id String The id (email address) of the paypal payment
- paypal
Reference String paypal payment reference
- time
Expiration String Expired date of the credit card
- time
Paid StringOn Paid the invoice on this day
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.