Address Address details model
type Address struct { // Name of the contact person ContactName *string `mandatory:"false" json:"contactName"` // Name of the customer company CompanyName *string `mandatory:"false" json:"companyName"` // Address line 1 AddressLine1 *string `mandatory:"false" json:"addressLine1"` // Address line 2 AddressLine2 *string `mandatory:"false" json:"addressLine2"` // Address line 3 AddressLine3 *string `mandatory:"false" json:"addressLine3"` // Address line 4 AddressLine4 *string `mandatory:"false" json:"addressLine4"` // Street name StreetName *string `mandatory:"false" json:"streetName"` // House no StreetNumber *string `mandatory:"false" json:"streetNumber"` // Name of the city City *string `mandatory:"false" json:"city"` Country *Country `mandatory:"false" json:"country"` // County name County *string `mandatory:"false" json:"county"` // Name of the state State *string `mandatory:"false" json:"state"` // ZIP no PostalCode *string `mandatory:"false" json:"postalCode"` // Name of the province Province *string `mandatory:"false" json:"province"` }
func (m Address) String() string
Country Country details model
type Country struct { // Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table CountryId *float32 `mandatory:"false" json:"countryId"` // Country code in ISO-3166-1 2-letter format CountryCode *string `mandatory:"false" json:"countryCode"` // Name of the country CountryName *string `mandatory:"false" json:"countryName"` // Language identifier LanguageId *float32 `mandatory:"false" json:"languageId"` // Country code in ISO-3166-1 3-letter format Ascii3CountryCode *string `mandatory:"false" json:"ascii3CountryCode"` }
func (m Country) String() string
CreditCardPaymentDetail Credit card Payment related details
type CreditCardPaymentDetail struct { // Paid the invoice on this day TimePaidOn *common.SDKTime `mandatory:"false" json:"timePaidOn"` // example PaidBy *string `mandatory:"false" json:"paidBy"` // Amount that paid AmountPaid *float32 `mandatory:"false" json:"amountPaid"` }
func (m CreditCardPaymentDetail) GetAmountPaid() *float32
GetAmountPaid returns AmountPaid
func (m CreditCardPaymentDetail) GetPaidBy() *string
GetPaidBy returns PaidBy
func (m CreditCardPaymentDetail) GetTimePaidOn() *common.SDKTime
GetTimePaidOn returns TimePaidOn
func (m CreditCardPaymentDetail) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreditCardPaymentDetail) String() string
Currency Currency details model
type Currency struct { // Currency code CurrencyCode *string `mandatory:"false" json:"currencyCode"` // Currency symbol CurrencySymbol *string `mandatory:"false" json:"currencySymbol"` // Name of the currency Name *string `mandatory:"false" json:"name"` // USD conversion rate of the currency UsdConversion *float32 `mandatory:"false" json:"usdConversion"` // Round decimal point RoundDecimalPoint *float32 `mandatory:"false" json:"roundDecimalPoint"` }
func (m Currency) String() string
DownloadPdfContentRequest wrapper for the DownloadPdfContent operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/DownloadPdfContent.go.html to see an example of how to use DownloadPdfContentRequest.
type DownloadPdfContentRequest struct { // The home region's public name of the logged in user. OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"` // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The identifier of the invoice. InternalInvoiceId *string `mandatory:"true" contributesTo:"path" name:"internalInvoiceId"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DownloadPdfContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DownloadPdfContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DownloadPdfContentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DownloadPdfContentRequest) String() string
DownloadPdfContentResponse wrapper for the DownloadPdfContent operation
type DownloadPdfContentResponse struct { // The underlying http response RawResponse *http.Response // The io.ReadCloser instance Content io.ReadCloser `presentIn:"body" encoding:"binary"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // Set content to download ContentDisposition *string `presentIn:"header" name:"content-disposition"` }
func (response DownloadPdfContentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DownloadPdfContentResponse) String() string
GetInvoiceRequest wrapper for the GetInvoice operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/GetInvoice.go.html to see an example of how to use GetInvoiceRequest.
type GetInvoiceRequest struct { // The home region's public name of the logged in user. OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"` // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The identifier of the invoice. InternalInvoiceId *string `mandatory:"true" contributesTo:"path" name:"internalInvoiceId"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetInvoiceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetInvoiceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetInvoiceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetInvoiceRequest) String() string
GetInvoiceResponse wrapper for the GetInvoice operation
type GetInvoiceResponse struct { // The underlying http response RawResponse *http.Response // The Invoice instance Invoice `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetInvoiceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetInvoiceResponse) String() string
Invoice Invoice details
type Invoice struct { // Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID InvoiceId *string `mandatory:"true" json:"invoiceId"` // Invoice external reference InvoiceNumber *string `mandatory:"false" json:"invoiceNumber"` // Transaction identifier InternalInvoiceId *string `mandatory:"false" json:"internalInvoiceId"` // Is credit card payment eligible IsCreditCardPayable *bool `mandatory:"false" json:"isCreditCardPayable"` // Date of invoice TimeInvoice *common.SDKTime `mandatory:"false" json:"timeInvoice"` // Tax of invoice amount Tax *float32 `mandatory:"false" json:"tax"` // Total amount of invoice InvoiceAmount *float32 `mandatory:"false" json:"invoiceAmount"` // Balance of invoice InvoiceAmountDue *float32 `mandatory:"false" json:"invoiceAmountDue"` // Invoice amount credit InvoiceAmountCredited *float32 `mandatory:"false" json:"invoiceAmountCredited"` // Invoice amount adjust InvoiceAmountAdjusted *float32 `mandatory:"false" json:"invoiceAmountAdjusted"` // Invoice amount applied InvoiceAmountApplied *float32 `mandatory:"false" json:"invoiceAmountApplied"` Currency *Currency `mandatory:"false" json:"currency"` // Type of invoice InvoiceType InvoiceInvoiceTypeEnum `mandatory:"false" json:"invoiceType,omitempty"` // Due date of invoice TimeInvoiceDue *common.SDKTime `mandatory:"false" json:"timeInvoiceDue"` // Invoice reference number InvoiceRefNumber *string `mandatory:"false" json:"invoiceRefNumber"` // Invoice PO number InvoicePoNumber *string `mandatory:"false" json:"invoicePoNumber"` // Invoice status InvoiceStatus InvoiceInvoiceStatusEnum `mandatory:"false" json:"invoiceStatus,omitempty"` // Preferred Email on the invoice PreferredEmail *string `mandatory:"false" json:"preferredEmail"` // Is emailing pdf allowed IsPdfEmailAvailable *bool `mandatory:"false" json:"isPdfEmailAvailable"` // Is pdf download access allowed IsDisplayDownloadPdf *bool `mandatory:"false" json:"isDisplayDownloadPdf"` // Whether invoice can be payed IsPayable *bool `mandatory:"false" json:"isPayable"` // Payment terms PaymentTerms *string `mandatory:"false" json:"paymentTerms"` LastPaymentDetail PaymentDetail `mandatory:"false" json:"lastPaymentDetail"` BillToAddress *Address `mandatory:"false" json:"billToAddress"` // List of subscription identifiers SubscriptionIds []string `mandatory:"false" json:"subscriptionIds"` }
func (m Invoice) String() string
func (m *Invoice) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
InvoiceCollection Invoice list
type InvoiceCollection struct { // Invoice list elements Items []InvoiceSummary `mandatory:"true" json:"items"` }
func (m InvoiceCollection) String() string
InvoiceInvoiceStatusEnum Enum with underlying type: string
type InvoiceInvoiceStatusEnum string
Set of constants representing the allowable values for InvoiceInvoiceStatusEnum
const ( InvoiceInvoiceStatusOpen InvoiceInvoiceStatusEnum = "OPEN" InvoiceInvoiceStatusPastDue InvoiceInvoiceStatusEnum = "PAST_DUE" InvoiceInvoiceStatusPaymentSubmitted InvoiceInvoiceStatusEnum = "PAYMENT_SUBMITTED" InvoiceInvoiceStatusClosed InvoiceInvoiceStatusEnum = "CLOSED" )
func GetInvoiceInvoiceStatusEnumValues() []InvoiceInvoiceStatusEnum
GetInvoiceInvoiceStatusEnumValues Enumerates the set of values for InvoiceInvoiceStatusEnum
InvoiceInvoiceTypeEnum Enum with underlying type: string
type InvoiceInvoiceTypeEnum string
Set of constants representing the allowable values for InvoiceInvoiceTypeEnum
const ( InvoiceInvoiceTypeHardware InvoiceInvoiceTypeEnum = "HARDWARE" InvoiceInvoiceTypeSubscription InvoiceInvoiceTypeEnum = "SUBSCRIPTION" InvoiceInvoiceTypeSupport InvoiceInvoiceTypeEnum = "SUPPORT" InvoiceInvoiceTypeLicense InvoiceInvoiceTypeEnum = "LICENSE" InvoiceInvoiceTypeEducation InvoiceInvoiceTypeEnum = "EDUCATION" InvoiceInvoiceTypeConsulting InvoiceInvoiceTypeEnum = "CONSULTING" InvoiceInvoiceTypeService InvoiceInvoiceTypeEnum = "SERVICE" InvoiceInvoiceTypeUsage InvoiceInvoiceTypeEnum = "USAGE" )
func GetInvoiceInvoiceTypeEnumValues() []InvoiceInvoiceTypeEnum
GetInvoiceInvoiceTypeEnumValues Enumerates the set of values for InvoiceInvoiceTypeEnum
InvoiceLineCollection Invoice line list
type InvoiceLineCollection struct { // Invoice line list elements Items []InvoiceLineSummary `mandatory:"true" json:"items"` }
func (m InvoiceLineCollection) String() string
InvoiceLineSummary Product items of the invoice
type InvoiceLineSummary struct { // Product of the item Product *string `mandatory:"true" json:"product"` // Product of the item OrderNo *string `mandatory:"false" json:"orderNo"` // Part number PartNumber *string `mandatory:"false" json:"partNumber"` // Start date TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"` // End date TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"` // Quantity of the ordered product Quantity *float32 `mandatory:"false" json:"quantity"` // Unit price of the ordered product NetUnitPrice *float32 `mandatory:"false" json:"netUnitPrice"` // Total price of the ordered product (Net unit price x quantity) TotalPrice *float32 `mandatory:"false" json:"totalPrice"` Currency *Currency `mandatory:"false" json:"currency"` }
func (m InvoiceLineSummary) String() string
InvoiceServiceClient a client for InvoiceService
type InvoiceServiceClient struct { common.BaseClient // contains filtered or unexported fields }
func NewInvoiceServiceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client InvoiceServiceClient, err error)
NewInvoiceServiceClientWithConfigurationProvider Creates a new default InvoiceService client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewInvoiceServiceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client InvoiceServiceClient, err error)
NewInvoiceServiceClientWithOboToken Creates a new default InvoiceService client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *InvoiceServiceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client InvoiceServiceClient) DownloadPdfContent(ctx context.Context, request DownloadPdfContentRequest) (response DownloadPdfContentResponse, err error)
DownloadPdfContent Returns an invoice in pdf format
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/DownloadPdfContent.go.html to see an example of how to use DownloadPdfContent API.
func (client InvoiceServiceClient) GetInvoice(ctx context.Context, request GetInvoiceRequest) (response GetInvoiceResponse, err error)
GetInvoice Returns an invoice by invoice id
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/GetInvoice.go.html to see an example of how to use GetInvoice API.
func (client InvoiceServiceClient) ListInvoiceLines(ctx context.Context, request ListInvoiceLinesRequest) (response ListInvoiceLinesResponse, err error)
ListInvoiceLines Returns the invoice product list by invoice id
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/ListInvoiceLines.go.html to see an example of how to use ListInvoiceLines API.
func (client InvoiceServiceClient) ListInvoices(ctx context.Context, request ListInvoicesRequest) (response ListInvoicesResponse, err error)
ListInvoices Returns a list of invoices
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/ListInvoices.go.html to see an example of how to use ListInvoices API.
func (client InvoiceServiceClient) PayInvoice(ctx context.Context, request PayInvoiceRequest) (response PayInvoiceResponse, err error)
PayInvoice Pay an invoice
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/PayInvoice.go.html to see an example of how to use PayInvoice API.
func (client *InvoiceServiceClient) SetRegion(region string)
SetRegion overrides the region of this client.
InvoiceSummary Invoice list elements
type InvoiceSummary struct { // Invoice identifier InvoiceId *string `mandatory:"true" json:"invoiceId"` // Invoice external reference InvoiceNumber *string `mandatory:"false" json:"invoiceNumber"` // PC invoice identifier InternalInvoiceId *string `mandatory:"false" json:"internalInvoiceId"` // Is credit card payment eligible IsCreditCardPayable *bool `mandatory:"false" json:"isCreditCardPayable"` // Invoice status InvoiceStatus InvoiceSummaryInvoiceStatusEnum `mandatory:"false" json:"invoiceStatus,omitempty"` // Type of invoice InvoiceType InvoiceSummaryInvoiceTypeEnum `mandatory:"false" json:"invoiceType,omitempty"` // Is the invoice has been already payed IsPaid *bool `mandatory:"false" json:"isPaid"` // Whether invoice can be payed IsPayable *bool `mandatory:"false" json:"isPayable"` // Invoice amount InvoiceAmount *float32 `mandatory:"false" json:"invoiceAmount"` // Invoice amount due InvoiceAmountDue *float32 `mandatory:"false" json:"invoiceAmountDue"` // Invoice amount credit InvoiceAmountCredited *float32 `mandatory:"false" json:"invoiceAmountCredited"` // Invoice amount adjust InvoiceAmountAdjusted *float32 `mandatory:"false" json:"invoiceAmountAdjusted"` // Invoice amount applied InvoiceAmountApplied *float32 `mandatory:"false" json:"invoiceAmountApplied"` // Due date of invoice amount TimeInvoiceDue *common.SDKTime `mandatory:"false" json:"timeInvoiceDue"` // Is the last payment failed IsPaymentFailed *bool `mandatory:"false" json:"isPaymentFailed"` // Invoice amount in dispute InvoiceAmountInDispute *float32 `mandatory:"false" json:"invoiceAmountInDispute"` // Invoice reference number InvoiceRefNumber *string `mandatory:"false" json:"invoiceRefNumber"` // Invoice PO number InvoicePoNumber *string `mandatory:"false" json:"invoicePoNumber"` // Date of invoice TimeInvoice *common.SDKTime `mandatory:"false" json:"timeInvoice"` Currency *Currency `mandatory:"false" json:"currency"` // Is emailing pdf allowed IsPdfEmailAvailable *bool `mandatory:"false" json:"isPdfEmailAvailable"` // Is view access allowed IsDisplayViewPdf *bool `mandatory:"false" json:"isDisplayViewPdf"` // Is pdf download access allowed IsDisplayDownloadPdf *bool `mandatory:"false" json:"isDisplayDownloadPdf"` LastPaymentDetail PaymentDetail `mandatory:"false" json:"lastPaymentDetail"` // Name of the bill to customer PartyName *string `mandatory:"false" json:"partyName"` // List of subscription identifiers SubscriptionIds []string `mandatory:"false" json:"subscriptionIds"` }
func (m InvoiceSummary) String() string
func (m *InvoiceSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
InvoiceSummaryInvoiceStatusEnum Enum with underlying type: string
type InvoiceSummaryInvoiceStatusEnum string
Set of constants representing the allowable values for InvoiceSummaryInvoiceStatusEnum
const ( InvoiceSummaryInvoiceStatusOpen InvoiceSummaryInvoiceStatusEnum = "OPEN" InvoiceSummaryInvoiceStatusPastDue InvoiceSummaryInvoiceStatusEnum = "PAST_DUE" InvoiceSummaryInvoiceStatusPaymentSubmitted InvoiceSummaryInvoiceStatusEnum = "PAYMENT_SUBMITTED" InvoiceSummaryInvoiceStatusClosed InvoiceSummaryInvoiceStatusEnum = "CLOSED" )
func GetInvoiceSummaryInvoiceStatusEnumValues() []InvoiceSummaryInvoiceStatusEnum
GetInvoiceSummaryInvoiceStatusEnumValues Enumerates the set of values for InvoiceSummaryInvoiceStatusEnum
InvoiceSummaryInvoiceTypeEnum Enum with underlying type: string
type InvoiceSummaryInvoiceTypeEnum string
Set of constants representing the allowable values for InvoiceSummaryInvoiceTypeEnum
const ( InvoiceSummaryInvoiceTypeHardware InvoiceSummaryInvoiceTypeEnum = "HARDWARE" InvoiceSummaryInvoiceTypeSubscription InvoiceSummaryInvoiceTypeEnum = "SUBSCRIPTION" InvoiceSummaryInvoiceTypeSupport InvoiceSummaryInvoiceTypeEnum = "SUPPORT" InvoiceSummaryInvoiceTypeLicense InvoiceSummaryInvoiceTypeEnum = "LICENSE" InvoiceSummaryInvoiceTypeEducation InvoiceSummaryInvoiceTypeEnum = "EDUCATION" InvoiceSummaryInvoiceTypeConsulting InvoiceSummaryInvoiceTypeEnum = "CONSULTING" InvoiceSummaryInvoiceTypeService InvoiceSummaryInvoiceTypeEnum = "SERVICE" InvoiceSummaryInvoiceTypeUsage InvoiceSummaryInvoiceTypeEnum = "USAGE" )
func GetInvoiceSummaryInvoiceTypeEnumValues() []InvoiceSummaryInvoiceTypeEnum
GetInvoiceSummaryInvoiceTypeEnumValues Enumerates the set of values for InvoiceSummaryInvoiceTypeEnum
ListInvoiceLinesRequest wrapper for the ListInvoiceLines operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/ListInvoiceLines.go.html to see an example of how to use ListInvoiceLinesRequest.
type ListInvoiceLinesRequest struct { // The home region's public name of the logged in user. OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"` // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The identifier of the invoice. InternalInvoiceId *string `mandatory:"true" contributesTo:"path" name:"internalInvoiceId"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // For list pagination. The value of the opc-next-page response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListInvoiceLinesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInvoiceLinesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInvoiceLinesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInvoiceLinesRequest) String() string
ListInvoiceLinesResponse wrapper for the ListInvoiceLines operation
type ListInvoiceLinesResponse struct { // The underlying http response RawResponse *http.Response // A list of InvoiceLineCollection instances InvoiceLineCollection `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For list pagination. If this header appears in the response, then this // is a partial list of invoices. Include this value as the `page` parameter in a subsequent // GET request to get the next batch of invoices. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` }
func (response ListInvoiceLinesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInvoiceLinesResponse) String() string
ListInvoicesRequest wrapper for the ListInvoices operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/ListInvoices.go.html to see an example of how to use ListInvoicesRequest.
type ListInvoicesRequest struct { // The home region's public name of the logged in user. OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"` // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The invoice query param (not unique). InvoiceId *string `mandatory:"false" contributesTo:"query" name:"invoiceId"` // A filter to only return resources that match the given type exactly. Type []ListInvoicesTypeEnum `contributesTo:"query" name:"type" omitEmpty:"true" collectionFormat:"multi"` // 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 SearchText *string `mandatory:"false" contributesTo:"query" name:"searchText"` // description: Start time (UTC) of the target invoice date range for which to fetch invoice data (inclusive). TimeInvoiceStart *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeInvoiceStart"` // description: End time (UTC) of the target invoice date range for which to fetch invoice data (exclusive). TimeInvoiceEnd *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeInvoiceEnd"` // description: Start time (UTC) of the target payment date range for which to fetch invoice data (inclusive). TimePaymentStart *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timePaymentStart"` // description: End time (UTC) of the target payment date range for which to fetch invoice data (exclusive). TimePaymentEnd *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timePaymentEnd"` // A filter to only return resources that match one of the status elements. Status []ListInvoicesStatusEnum `contributesTo:"query" name:"status" omitEmpty:"true" collectionFormat:"multi"` // For list pagination. The value of the opc-next-page response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The field to sort by. Only one field can be selected for sorting. SortBy ListInvoicesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The sort order to use (ascending or descending). SortOrder ListInvoicesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListInvoicesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInvoicesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInvoicesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInvoicesRequest) String() string
ListInvoicesResponse wrapper for the ListInvoices operation
type ListInvoicesResponse struct { // The underlying http response RawResponse *http.Response // A list of InvoiceCollection instances InvoiceCollection `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For list pagination. If this header appears in the response, then this // is a partial list of invoices. Include this value as the `page` parameter in a subsequent // GET request to get the next batch of invoices. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` }
func (response ListInvoicesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInvoicesResponse) String() string
ListInvoicesSortByEnum Enum with underlying type: string
type ListInvoicesSortByEnum string
Set of constants representing the allowable values for ListInvoicesSortByEnum
const ( ListInvoicesSortByInvoiceNo ListInvoicesSortByEnum = "INVOICE_NO" ListInvoicesSortByRefNo ListInvoicesSortByEnum = "REF_NO" ListInvoicesSortByStatus ListInvoicesSortByEnum = "STATUS" ListInvoicesSortByType ListInvoicesSortByEnum = "TYPE" ListInvoicesSortByInvoiceDate ListInvoicesSortByEnum = "INVOICE_DATE" ListInvoicesSortByDueDate ListInvoicesSortByEnum = "DUE_DATE" ListInvoicesSortByPaymRef ListInvoicesSortByEnum = "PAYM_REF" ListInvoicesSortByTotalAmount ListInvoicesSortByEnum = "TOTAL_AMOUNT" ListInvoicesSortByBalanceDue ListInvoicesSortByEnum = "BALANCE_DUE" )
func GetListInvoicesSortByEnumValues() []ListInvoicesSortByEnum
GetListInvoicesSortByEnumValues Enumerates the set of values for ListInvoicesSortByEnum
ListInvoicesSortOrderEnum Enum with underlying type: string
type ListInvoicesSortOrderEnum string
Set of constants representing the allowable values for ListInvoicesSortOrderEnum
const ( ListInvoicesSortOrderAsc ListInvoicesSortOrderEnum = "ASC" ListInvoicesSortOrderDesc ListInvoicesSortOrderEnum = "DESC" )
func GetListInvoicesSortOrderEnumValues() []ListInvoicesSortOrderEnum
GetListInvoicesSortOrderEnumValues Enumerates the set of values for ListInvoicesSortOrderEnum
ListInvoicesStatusEnum Enum with underlying type: string
type ListInvoicesStatusEnum string
Set of constants representing the allowable values for ListInvoicesStatusEnum
const ( ListInvoicesStatusOpen ListInvoicesStatusEnum = "OPEN" ListInvoicesStatusPastDue ListInvoicesStatusEnum = "PAST_DUE" ListInvoicesStatusPaymentSubmitted ListInvoicesStatusEnum = "PAYMENT_SUBMITTED" ListInvoicesStatusClosed ListInvoicesStatusEnum = "CLOSED" )
func GetListInvoicesStatusEnumValues() []ListInvoicesStatusEnum
GetListInvoicesStatusEnumValues Enumerates the set of values for ListInvoicesStatusEnum
ListInvoicesTypeEnum Enum with underlying type: string
type ListInvoicesTypeEnum string
Set of constants representing the allowable values for ListInvoicesTypeEnum
const ( ListInvoicesTypeHardware ListInvoicesTypeEnum = "HARDWARE" ListInvoicesTypeSubscription ListInvoicesTypeEnum = "SUBSCRIPTION" ListInvoicesTypeSupport ListInvoicesTypeEnum = "SUPPORT" ListInvoicesTypeLicense ListInvoicesTypeEnum = "LICENSE" ListInvoicesTypeEducation ListInvoicesTypeEnum = "EDUCATION" ListInvoicesTypeConsulting ListInvoicesTypeEnum = "CONSULTING" ListInvoicesTypeService ListInvoicesTypeEnum = "SERVICE" ListInvoicesTypeUsage ListInvoicesTypeEnum = "USAGE" )
func GetListInvoicesTypeEnumValues() []ListInvoicesTypeEnum
GetListInvoicesTypeEnumValues Enumerates the set of values for ListInvoicesTypeEnum
OtherPaymentDetail Other Payment related details
type OtherPaymentDetail struct { // Paid the invoice on this day TimePaidOn *common.SDKTime `mandatory:"false" json:"timePaidOn"` // example PaidBy *string `mandatory:"false" json:"paidBy"` // Amount that paid AmountPaid *float32 `mandatory:"false" json:"amountPaid"` }
func (m OtherPaymentDetail) GetAmountPaid() *float32
GetAmountPaid returns AmountPaid
func (m OtherPaymentDetail) GetPaidBy() *string
GetPaidBy returns PaidBy
func (m OtherPaymentDetail) GetTimePaidOn() *common.SDKTime
GetTimePaidOn returns TimePaidOn
func (m OtherPaymentDetail) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OtherPaymentDetail) String() string
PayInvoiceDetails Request object for invoice payment
type PayInvoiceDetails struct { // User email Email *string `mandatory:"true" json:"email"` // Language code LanguageCode *string `mandatory:"false" json:"languageCode"` // Callback URL ReturnUrl *string `mandatory:"false" json:"returnUrl"` }
func (m PayInvoiceDetails) String() string
PayInvoiceReceipt Invoice payment action response
type PayInvoiceReceipt struct { // Payment header id HeaderId *string `mandatory:"true" json:"headerId"` // Url of the Payment Service Url *string `mandatory:"false" json:"url"` // Token created for Payment Service Token *string `mandatory:"false" json:"token"` }
func (m PayInvoiceReceipt) String() string
PayInvoiceRequest wrapper for the PayInvoice operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/56.1.0/ospgateway/PayInvoice.go.html to see an example of how to use PayInvoiceRequest.
type PayInvoiceRequest struct { // The home region's public name of the logged in user. OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"` // The identifier of the invoice. InternalInvoiceId *string `mandatory:"true" contributesTo:"path" name:"internalInvoiceId"` // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // Invoice payment request. PayInvoiceDetails `contributesTo:"body"` // 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. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // 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. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request PayInvoiceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PayInvoiceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PayInvoiceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PayInvoiceRequest) String() string
PayInvoiceResponse wrapper for the PayInvoice operation
type PayInvoiceResponse struct { // The underlying http response RawResponse *http.Response // The PayInvoiceReceipt instance PayInvoiceReceipt `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` }
func (response PayInvoiceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PayInvoiceResponse) String() string
PaymentDetail Payment related details
type PaymentDetail interface { // Paid the invoice on this day GetTimePaidOn() *common.SDKTime // example GetPaidBy() *string // Amount that paid GetAmountPaid() *float32 }
PaymentDetailPaymentMethodEnum Enum with underlying type: string
type PaymentDetailPaymentMethodEnum string
Set of constants representing the allowable values for PaymentDetailPaymentMethodEnum
const ( PaymentDetailPaymentMethodCreditCard PaymentDetailPaymentMethodEnum = "CREDIT_CARD" PaymentDetailPaymentMethodPaypal PaymentDetailPaymentMethodEnum = "PAYPAL" PaymentDetailPaymentMethodOther PaymentDetailPaymentMethodEnum = "OTHER" )
func GetPaymentDetailPaymentMethodEnumValues() []PaymentDetailPaymentMethodEnum
GetPaymentDetailPaymentMethodEnumValues Enumerates the set of values for PaymentDetailPaymentMethodEnum
PaypalPaymentDetail PayPal Payment related details
type PaypalPaymentDetail struct { // Paid the invoice on this day TimePaidOn *common.SDKTime `mandatory:"false" json:"timePaidOn"` // example PaidBy *string `mandatory:"false" json:"paidBy"` // Amount that paid AmountPaid *float32 `mandatory:"false" json:"amountPaid"` }
func (m PaypalPaymentDetail) GetAmountPaid() *float32
GetAmountPaid returns AmountPaid
func (m PaypalPaymentDetail) GetPaidBy() *string
GetPaidBy returns PaidBy
func (m PaypalPaymentDetail) GetTimePaidOn() *common.SDKTime
GetTimePaidOn returns TimePaidOn
func (m PaypalPaymentDetail) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PaypalPaymentDetail) String() string