Invoice¶
- class oci.osp_gateway.models.Invoice(**kwargs)¶
Bases:
objectInvoice details
Attributes:
A constant which can be used with the invoice_status property of a Invoice.
A constant which can be used with the invoice_status property of a Invoice.
A constant which can be used with the invoice_status property of a Invoice.
A constant which can be used with the invoice_status property of a Invoice.
A constant which can be used with the invoice_type property of a Invoice.
A constant which can be used with the invoice_type property of a Invoice.
A constant which can be used with the invoice_type property of a Invoice.
A constant which can be used with the invoice_type property of a Invoice.
A constant which can be used with the invoice_type property of a Invoice.
A constant which can be used with the invoice_type property of a Invoice.
A constant which can be used with the invoice_type property of a Invoice.
A constant which can be used with the invoice_type property of a Invoice.
Gets the bill_to_address of this Invoice.
Gets the currency of this Invoice.
Gets the internal_invoice_id of this Invoice.
Gets the invoice_amount of this Invoice.
Gets the invoice_amount_adjusted of this Invoice.
Gets the invoice_amount_applied of this Invoice.
Gets the invoice_amount_credited of this Invoice.
Gets the invoice_amount_due of this Invoice.
[Required] Gets the invoice_id of this Invoice.
Gets the invoice_number of this Invoice.
Gets the invoice_po_number of this Invoice.
Gets the invoice_ref_number of this Invoice.
Gets the invoice_status of this Invoice.
Gets the invoice_type of this Invoice.
Gets the is_credit_card_payable of this Invoice.
Gets the is_display_download_pdf of this Invoice.
Gets the is_payable of this Invoice.
Gets the is_pdf_email_available of this Invoice.
Gets the last_payment_detail of this Invoice.
Gets the payment_terms of this Invoice.
Gets the preferred_email of this Invoice.
Gets the subscription_ids of this Invoice.
Gets the tax of this Invoice.
Gets the time_invoice of this Invoice.
Gets the time_invoice_due of this Invoice.
Methods:
__init__(**kwargs)Initializes a new Invoice object with values from keyword arguments.
- INVOICE_STATUS_CLOSED = 'CLOSED'¶
A constant which can be used with the invoice_status property of a Invoice. This constant has a value of “CLOSED”
- INVOICE_STATUS_OPEN = 'OPEN'¶
A constant which can be used with the invoice_status property of a Invoice. This constant has a value of “OPEN”
- INVOICE_STATUS_PAST_DUE = 'PAST_DUE'¶
A constant which can be used with the invoice_status property of a Invoice. This constant has a value of “PAST_DUE”
- INVOICE_STATUS_PAYMENT_SUBMITTED = 'PAYMENT_SUBMITTED'¶
A constant which can be used with the invoice_status property of a Invoice. This constant has a value of “PAYMENT_SUBMITTED”
- INVOICE_TYPE_CONSULTING = 'CONSULTING'¶
A constant which can be used with the invoice_type property of a Invoice. This constant has a value of “CONSULTING”
- INVOICE_TYPE_EDUCATION = 'EDUCATION'¶
A constant which can be used with the invoice_type property of a Invoice. This constant has a value of “EDUCATION”
- INVOICE_TYPE_HARDWARE = 'HARDWARE'¶
A constant which can be used with the invoice_type property of a Invoice. This constant has a value of “HARDWARE”
- INVOICE_TYPE_LICENSE = 'LICENSE'¶
A constant which can be used with the invoice_type property of a Invoice. This constant has a value of “LICENSE”
- INVOICE_TYPE_SERVICE = 'SERVICE'¶
A constant which can be used with the invoice_type property of a Invoice. This constant has a value of “SERVICE”
- INVOICE_TYPE_SUBSCRIPTION = 'SUBSCRIPTION'¶
A constant which can be used with the invoice_type property of a Invoice. This constant has a value of “SUBSCRIPTION”
- INVOICE_TYPE_SUPPORT = 'SUPPORT'¶
A constant which can be used with the invoice_type property of a Invoice. This constant has a value of “SUPPORT”
- INVOICE_TYPE_USAGE = 'USAGE'¶
A constant which can be used with the invoice_type property of a Invoice. This constant has a value of “USAGE”
- __init__(**kwargs)¶
Initializes a new Invoice object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
invoice_id (str) – The value to assign to the invoice_id property of this Invoice.
invoice_number (str) – The value to assign to the invoice_number property of this Invoice.
internal_invoice_id (str) – The value to assign to the internal_invoice_id property of this Invoice.
is_credit_card_payable (bool) – The value to assign to the is_credit_card_payable property of this Invoice.
time_invoice (datetime) – The value to assign to the time_invoice property of this Invoice.
tax (float) – The value to assign to the tax property of this Invoice.
invoice_amount (float) – The value to assign to the invoice_amount property of this Invoice.
invoice_amount_due (float) – The value to assign to the invoice_amount_due property of this Invoice.
invoice_amount_credited (float) – The value to assign to the invoice_amount_credited property of this Invoice.
invoice_amount_adjusted (float) – The value to assign to the invoice_amount_adjusted property of this Invoice.
invoice_amount_applied (float) – The value to assign to the invoice_amount_applied property of this Invoice.
currency (oci.osp_gateway.models.Currency) – The value to assign to the currency property of this Invoice.
invoice_type (str) – The value to assign to the invoice_type property of this Invoice. Allowed values for this property are: “HARDWARE”, “SUBSCRIPTION”, “SUPPORT”, “LICENSE”, “EDUCATION”, “CONSULTING”, “SERVICE”, “USAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_invoice_due (datetime) – The value to assign to the time_invoice_due property of this Invoice.
invoice_ref_number (str) – The value to assign to the invoice_ref_number property of this Invoice.
invoice_po_number (str) – The value to assign to the invoice_po_number property of this Invoice.
invoice_status (str) – The value to assign to the invoice_status property of this Invoice. Allowed values for this property are: “OPEN”, “PAST_DUE”, “PAYMENT_SUBMITTED”, “CLOSED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
preferred_email (str) – The value to assign to the preferred_email property of this Invoice.
is_pdf_email_available (bool) – The value to assign to the is_pdf_email_available property of this Invoice.
is_display_download_pdf (bool) – The value to assign to the is_display_download_pdf property of this Invoice.
is_payable (bool) – The value to assign to the is_payable property of this Invoice.
payment_terms (str) – The value to assign to the payment_terms property of this Invoice.
last_payment_detail (oci.osp_gateway.models.PaymentDetail) – The value to assign to the last_payment_detail property of this Invoice.
bill_to_address (oci.osp_gateway.models.BillToAddress) – The value to assign to the bill_to_address property of this Invoice.
subscription_ids (list[str]) – The value to assign to the subscription_ids property of this Invoice.
- property bill_to_address¶
Gets the bill_to_address of this Invoice.
- Returns
The bill_to_address of this Invoice.
- Return type
- property currency¶
Gets the currency of this Invoice.
- Returns
The currency of this Invoice.
- Return type
- property internal_invoice_id¶
Gets the internal_invoice_id of this Invoice. Transaction identifier
- Returns
The internal_invoice_id of this Invoice.
- Return type
str
- property invoice_amount¶
Gets the invoice_amount of this Invoice. Total amount of invoice
- Returns
The invoice_amount of this Invoice.
- Return type
float
- property invoice_amount_adjusted¶
Gets the invoice_amount_adjusted of this Invoice. Invoice amount adjust
- Returns
The invoice_amount_adjusted of this Invoice.
- Return type
float
- property invoice_amount_applied¶
Gets the invoice_amount_applied of this Invoice. Invoice amount applied
- Returns
The invoice_amount_applied of this Invoice.
- Return type
float
- property invoice_amount_credited¶
Gets the invoice_amount_credited of this Invoice. Invoice amount credit
- Returns
The invoice_amount_credited of this Invoice.
- Return type
float
- property invoice_amount_due¶
Gets the invoice_amount_due of this Invoice. Balance of invoice
- Returns
The invoice_amount_due of this Invoice.
- Return type
float
- property invoice_id¶
[Required] Gets the invoice_id of this Invoice. Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
- Returns
The invoice_id of this Invoice.
- Return type
str
- property invoice_number¶
Gets the invoice_number of this Invoice. Invoice external reference
- Returns
The invoice_number of this Invoice.
- Return type
str
- property invoice_po_number¶
Gets the invoice_po_number of this Invoice. Invoice PO number
- Returns
The invoice_po_number of this Invoice.
- Return type
str
- property invoice_ref_number¶
Gets the invoice_ref_number of this Invoice. Invoice reference number
- Returns
The invoice_ref_number of this Invoice.
- Return type
str
- property invoice_status¶
Gets the invoice_status of this Invoice. Invoice status
Allowed values for this property are: “OPEN”, “PAST_DUE”, “PAYMENT_SUBMITTED”, “CLOSED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The invoice_status of this Invoice.
- Return type
str
- property invoice_type¶
Gets the invoice_type of this Invoice. Type of invoice
Allowed values for this property are: “HARDWARE”, “SUBSCRIPTION”, “SUPPORT”, “LICENSE”, “EDUCATION”, “CONSULTING”, “SERVICE”, “USAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The invoice_type of this Invoice.
- Return type
str
- property is_credit_card_payable¶
Gets the is_credit_card_payable of this Invoice. Is credit card payment eligible
- Returns
The is_credit_card_payable of this Invoice.
- Return type
bool
- property is_display_download_pdf¶
Gets the is_display_download_pdf of this Invoice. Is pdf download access allowed
- Returns
The is_display_download_pdf of this Invoice.
- Return type
bool
- property is_payable¶
Gets the is_payable of this Invoice. Whether invoice can be payed
- Returns
The is_payable of this Invoice.
- Return type
bool
- property is_pdf_email_available¶
Gets the is_pdf_email_available of this Invoice. Is emailing pdf allowed
- Returns
The is_pdf_email_available of this Invoice.
- Return type
bool
- property last_payment_detail¶
Gets the last_payment_detail of this Invoice.
- Returns
The last_payment_detail of this Invoice.
- Return type
- property payment_terms¶
Gets the payment_terms of this Invoice. Payment terms
- Returns
The payment_terms of this Invoice.
- Return type
str
- property preferred_email¶
Gets the preferred_email of this Invoice. Preferred Email on the invoice
- Returns
The preferred_email of this Invoice.
- Return type
str
- property subscription_ids¶
Gets the subscription_ids of this Invoice. List of subscription identifiers
- Returns
The subscription_ids of this Invoice.
- Return type
list[str]
- property tax¶
Gets the tax of this Invoice. Tax of invoice amount
- Returns
The tax of this Invoice.
- Return type
float
- property time_invoice¶
Gets the time_invoice of this Invoice. Date of invoice
- Returns
The time_invoice of this Invoice.
- Return type
datetime
- property time_invoice_due¶
Gets the time_invoice_due of this Invoice. Due date of invoice
- Returns
The time_invoice_due of this Invoice.
- Return type
datetime