Class SubscribedServiceSummary


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20190111")
    public final class SubscribedServiceSummary
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Subscribed service contract details.
    Note: Objects should always be created or deserialized using the SubscribedServiceSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SubscribedServiceSummary.Builder, which maintain a set of all explicitly set fields called SubscribedServiceSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
    • Constructor Detail

      • SubscribedServiceSummary

        @Deprecated
        @ConstructorProperties({"id","type","serialNumber","subscriptionId","product","timeStart","timeEnd","quantity","status","operationType","netUnitPrice","pricePeriod","lineNetAmount","isVariableCommitment","isAllowance","usedAmount","availableAmount","fundedAllocationValue","isHavingUsage","isCapToPriceList","creditPercentage","partnerTransactionType","isCreditEnabled","overagePolicy","overageBillTo","paygPolicy","promoOrderLineId","promotionPricingType","rateCardDiscountPercentage","overageDiscountPercentage","billToCustomer","billToContact","billToAddress","paymentNumber","timePaymentExpiry","paymentTerm","paymentMethod","transactionExtensionId","salesChannel","eligibleToRenew","renewedSubscribedServiceId","termValue","termValueUom","renewalOptyId","renewalOptyNumber","renewalOptyType","bookingOptyNumber","revenueLineId","revenueLineNumber","majorSet","timeMajorsetStart","timeMajorsetEnd","systemArrInLc","systemArrInSc","systemAtrArrInLc","systemAtrArrInSc","revisedArrInLc","revisedArrInSc","totalValue","originalPromoAmount","orderHeaderId","orderNumber","orderType","orderLineId","orderLineNumber","commitmentScheduleId","salesAccountPartyId","dataCenter","dataCenterRegion","adminEmail","buyerEmail","subscriptionSource","provisioningSource","fulfillmentSet","isIntentToPay","isPayg","pricingModel","programType","startDateType","timeProvisioned","promoType","serviceToCustomer","serviceToContact","serviceToAddress","soldToCustomer","soldToContact","endUserCustomer","endUserContact","endUserAddress","resellerCustomer","resellerContact","resellerAddress","csi","customerTransactionReference","partnerCreditAmount","isSingleRateCard","agreementId","agreementName","agreementType","billingFrequency","timeWelcomeEmailSent","timeServiceConfigurationEmailSent","timeCustomerConfig","timeAgreementEnd","timeCreated","createdBy","timeUpdated","updatedBy","ratecardType"})
        public SubscribedServiceSummary​(String id,
                                        String type,
                                        String serialNumber,
                                        String subscriptionId,
                                        RateCardProduct product,
                                        Date timeStart,
                                        Date timeEnd,
                                        String quantity,
                                        String status,
                                        String operationType,
                                        String netUnitPrice,
                                        String pricePeriod,
                                        String lineNetAmount,
                                        Boolean isVariableCommitment,
                                        Boolean isAllowance,
                                        String usedAmount,
                                        String availableAmount,
                                        String fundedAllocationValue,
                                        Boolean isHavingUsage,
                                        Boolean isCapToPriceList,
                                        String creditPercentage,
                                        String partnerTransactionType,
                                        Boolean isCreditEnabled,
                                        String overagePolicy,
                                        String overageBillTo,
                                        String paygPolicy,
                                        Long promoOrderLineId,
                                        String promotionPricingType,
                                        String rateCardDiscountPercentage,
                                        String overageDiscountPercentage,
                                        SubscribedServiceBusinessPartner billToCustomer,
                                        SubscribedServiceUser billToContact,
                                        SubscribedServiceAddress billToAddress,
                                        String paymentNumber,
                                        Date timePaymentExpiry,
                                        SubscribedServicePaymentTerm paymentTerm,
                                        String paymentMethod,
                                        Long transactionExtensionId,
                                        String salesChannel,
                                        String eligibleToRenew,
                                        String renewedSubscribedServiceId,
                                        Long termValue,
                                        String termValueUom,
                                        Long renewalOptyId,
                                        String renewalOptyNumber,
                                        String renewalOptyType,
                                        String bookingOptyNumber,
                                        Long revenueLineId,
                                        String revenueLineNumber,
                                        Long majorSet,
                                        Date timeMajorsetStart,
                                        Date timeMajorsetEnd,
                                        String systemArrInLc,
                                        String systemArrInSc,
                                        String systemAtrArrInLc,
                                        String systemAtrArrInSc,
                                        String revisedArrInLc,
                                        String revisedArrInSc,
                                        String totalValue,
                                        String originalPromoAmount,
                                        Long orderHeaderId,
                                        Long orderNumber,
                                        String orderType,
                                        Long orderLineId,
                                        Integer orderLineNumber,
                                        String commitmentScheduleId,
                                        Long salesAccountPartyId,
                                        String dataCenter,
                                        String dataCenterRegion,
                                        String adminEmail,
                                        String buyerEmail,
                                        String subscriptionSource,
                                        String provisioningSource,
                                        String fulfillmentSet,
                                        Boolean isIntentToPay,
                                        Boolean isPayg,
                                        String pricingModel,
                                        String programType,
                                        String startDateType,
                                        Date timeProvisioned,
                                        String promoType,
                                        SubscribedServiceBusinessPartner serviceToCustomer,
                                        SubscribedServiceUser serviceToContact,
                                        SubscribedServiceAddress serviceToAddress,
                                        SubscribedServiceBusinessPartner soldToCustomer,
                                        SubscribedServiceUser soldToContact,
                                        SubscribedServiceBusinessPartner endUserCustomer,
                                        SubscribedServiceUser endUserContact,
                                        SubscribedServiceAddress endUserAddress,
                                        SubscribedServiceBusinessPartner resellerCustomer,
                                        SubscribedServiceUser resellerContact,
                                        SubscribedServiceAddress resellerAddress,
                                        Long csi,
                                        String customerTransactionReference,
                                        String partnerCreditAmount,
                                        Boolean isSingleRateCard,
                                        Long agreementId,
                                        String agreementName,
                                        String agreementType,
                                        String billingFrequency,
                                        Date timeWelcomeEmailSent,
                                        Date timeServiceConfigurationEmailSent,
                                        Date timeCustomerConfig,
                                        Date timeAgreementEnd,
                                        Date timeCreated,
                                        String createdBy,
                                        Date timeUpdated,
                                        String updatedBy,
                                        String ratecardType)
        Deprecated.
    • Method Detail

      • getId

        public String getId()
        SPM (Subscription Plan Management) internal subscribed service ID.
        Returns:
        the value
      • getType

        public String getType()
        Subscribed service line type.
        Returns:
        the value
      • getSerialNumber

        public String getSerialNumber()
        Subscribed service line number.
        Returns:
        the value
      • getSubscriptionId

        public String getSubscriptionId()
        Subscription ID associated with the subscribed service.
        Returns:
        the value
      • getTimeStart

        public Date getTimeStart()
        Subscribed service start date.
        Returns:
        the value
      • getTimeEnd

        public Date getTimeEnd()
        Subscribed service end date.
        Returns:
        the value
      • getQuantity

        public String getQuantity()
        Subscribed service quantity.
        Returns:
        the value
      • getStatus

        public String getStatus()
        Subscribed service status.
        Returns:
        the value
      • getOperationType

        public String getOperationType()
        Subscribed service operation type.
        Returns:
        the value
      • getNetUnitPrice

        public String getNetUnitPrice()
        Subscribed service net unit price.
        Returns:
        the value
      • getPricePeriod

        public String getPricePeriod()
        Indicates the period for which the commitment amount can be utilized, exceeding which, the amount lapses.

        Also used in calculation of total contract line value.

        Returns:
        the value
      • getLineNetAmount

        public String getLineNetAmount()
        Subscribed service line net amount.
        Returns:
        the value
      • getIsVariableCommitment

        public Boolean getIsVariableCommitment()
        Indicates if the commitment lines can have different quantities.
        Returns:
        the value
      • getIsAllowance

        public Boolean getIsAllowance()
        Indicates if a service can recieve usages and consequently have available amounts computed.
        Returns:
        the value
      • getUsedAmount

        public String getUsedAmount()
        Subscribed service used amount.
        Returns:
        the value
      • getAvailableAmount

        public String getAvailableAmount()
        Subscribed sercice available or remaining amount.
        Returns:
        the value
      • getFundedAllocationValue

        public String getFundedAllocationValue()
        Funded allocation line value.

        Example: 12000.00

        Returns:
        the value
      • getIsHavingUsage

        public Boolean getIsHavingUsage()
        Indicates whether or not there has been usage for the subscribed service.
        Returns:
        the value
      • getIsCapToPriceList

        public Boolean getIsCapToPriceList()
        If true compares the rate between the rate card and the active price list, and the minimum rate would be fetched.
        Returns:
        the value
      • getCreditPercentage

        public String getCreditPercentage()
        Subscribed service credit percentage.
        Returns:
        the value
      • getPartnerTransactionType

        public String getPartnerTransactionType()
        Contains the name of the partner to which the subscription belongs, however depending on which subscription, the invoicing can differ.
        Returns:
        the value
      • getIsCreditEnabled

        public Boolean getIsCreditEnabled()
        Used in context of service credit lines.
        Returns:
        the value
      • getOveragePolicy

        public String getOveragePolicy()
        Overage policy of subscribed service.
        Returns:
        the value
      • getOverageBillTo

        public String getOverageBillTo()
        Overage bill to of subscribed service.
        Returns:
        the value
      • getPaygPolicy

        public String getPaygPolicy()
        Pay As You Go policy of subscribed service.

        Can be null, indicating no PAYG policy.

        Returns:
        the value
      • getPromoOrderLineId

        public Long getPromoOrderLineId()
        Not null if this service has an associated promotion line in SPM (Subscription Plan Management).

        Contains the line identifier from order management of the associated promo line.

        Returns:
        the value
      • getPromotionPricingType

        public String getPromotionPricingType()
        Promotion pricing type of subscribed service.

        Can be null, indicating no promotional pricing.

        Returns:
        the value
      • getRateCardDiscountPercentage

        public String getRateCardDiscountPercentage()
        Subscribed service rate card ciscount percentage.
        Returns:
        the value
      • getOverageDiscountPercentage

        public String getOverageDiscountPercentage()
        Subscribed service overage discount percentage.
        Returns:
        the value
      • getPaymentNumber

        public String getPaymentNumber()
        Payment number of subscribed service.
        Returns:
        the value
      • getTimePaymentExpiry

        public Date getTimePaymentExpiry()
        Subscribed service payment expiration date.
        Returns:
        the value
      • getPaymentMethod

        public String getPaymentMethod()
        Payment method of subscribed service.
        Returns:
        the value
      • getTransactionExtensionId

        public Long getTransactionExtensionId()
        Subscribed service transaction extension ID.
        Returns:
        the value
      • getSalesChannel

        public String getSalesChannel()
        Sales channel of subscribed service.
        Returns:
        the value
      • getEligibleToRenew

        public String getEligibleToRenew()
        Subscribed service eligible to renew field.
        Returns:
        the value
      • getRenewedSubscribedServiceId

        public String getRenewedSubscribedServiceId()
        SPM (Subscription Plan Management) renewed subscription ID.
        Returns:
        the value
      • getTermValue

        public Long getTermValue()
        Term value in months.
        Returns:
        the value
      • getTermValueUom

        public String getTermValueUom()
        Term value UOM (Unit of Measure).
        Returns:
        the value
      • getRenewalOptyId

        public Long getRenewalOptyId()
        Subscribed service opportunity ID.
        Returns:
        the value
      • getRenewalOptyNumber

        public String getRenewalOptyNumber()
        Renewal opportunity number of subscribed service.
        Returns:
        the value
      • getRenewalOptyType

        public String getRenewalOptyType()
        Renewal opportunity type of subscribed service.
        Returns:
        the value
      • getBookingOptyNumber

        public String getBookingOptyNumber()
        Booking opportunity number of subscribed service.
        Returns:
        the value
      • getRevenueLineId

        public Long getRevenueLineId()
        Subscribed service revenue line ID.
        Returns:
        the value
      • getRevenueLineNumber

        public String getRevenueLineNumber()
        Revenue line number of subscribed service.
        Returns:
        the value
      • getMajorSet

        public Long getMajorSet()
        Subscribed service major set.
        Returns:
        the value
      • getTimeMajorsetStart

        public Date getTimeMajorsetStart()
        Subscribed service major set start date.
        Returns:
        the value
      • getTimeMajorsetEnd

        public Date getTimeMajorsetEnd()
        Subscribed service major set end date.
        Returns:
        the value
      • getSystemArrInLc

        public String getSystemArrInLc()
        Subscribed service system ARR (Annualized Recurring Revenue).
        Returns:
        the value
      • getSystemArrInSc

        public String getSystemArrInSc()
        Subscribed service system ARR in standard currency.
        Returns:
        the value
      • getSystemAtrArrInLc

        public String getSystemAtrArrInLc()
        Subscribed service system ATR-ARR (Annualized Recurring Revenue - Available to Renew).
        Returns:
        the value
      • getSystemAtrArrInSc

        public String getSystemAtrArrInSc()
        Subscribed service system ATR-ARR in standard currency.
        Returns:
        the value
      • getRevisedArrInLc

        public String getRevisedArrInLc()
        Subscribed service revised ARR.
        Returns:
        the value
      • getRevisedArrInSc

        public String getRevisedArrInSc()
        Subscribed service revised ARR in standard currency.
        Returns:
        the value
      • getTotalValue

        public String getTotalValue()
        Subscribed service total value.
        Returns:
        the value
      • getOriginalPromoAmount

        public String getOriginalPromoAmount()
        Subscribed service promotion amount.
        Returns:
        the value
      • getOrderHeaderId

        public Long getOrderHeaderId()
        Sales order header associated with the subscribed service.
        Returns:
        the value
      • getOrderNumber

        public Long getOrderNumber()
        Sales order number associated with the subscribed service.
        Returns:
        the value
      • getOrderType

        public String getOrderType()
        Order type of subscribed service.
        Returns:
        the value
      • getOrderLineId

        public Long getOrderLineId()
        Sales order line ID associated with the subscribed service.
        Returns:
        the value
      • getOrderLineNumber

        public Integer getOrderLineNumber()
        Sales order line number associated with the subscribed service.
        Returns:
        the value
      • getCommitmentScheduleId

        public String getCommitmentScheduleId()
        Subscribed service commitment schedule ID.
        Returns:
        the value
      • getSalesAccountPartyId

        public Long getSalesAccountPartyId()
        Subscribed service sales account party ID.
        Returns:
        the value
      • getDataCenter

        public String getDataCenter()
        Subscribed service data center.
        Returns:
        the value
      • getDataCenterRegion

        public String getDataCenterRegion()
        Subscribed service data center region.
        Returns:
        the value
      • getAdminEmail

        public String getAdminEmail()
        Subscribed service admin email ID.
        Returns:
        the value
      • getBuyerEmail

        public String getBuyerEmail()
        Subscribed service buyer email ID.
        Returns:
        the value
      • getSubscriptionSource

        public String getSubscriptionSource()
        Subscribed service source.
        Returns:
        the value
      • getProvisioningSource

        public String getProvisioningSource()
        Subscribed service provisioning source.
        Returns:
        the value
      • getFulfillmentSet

        public String getFulfillmentSet()
        Subscribed service fulfillment set.
        Returns:
        the value
      • getIsIntentToPay

        public Boolean getIsIntentToPay()
        Subscribed service intent to pay parameter.
        Returns:
        the value
      • getIsPayg

        public Boolean getIsPayg()
        Subscribed service PAYG parameter.
        Returns:
        the value
      • getPricingModel

        public String getPricingModel()
        Subscribed service pricing model.
        Returns:
        the value
      • getProgramType

        public String getProgramType()
        Subscribed service program type.
        Returns:
        the value
      • getStartDateType

        public String getStartDateType()
        Subscribed service start date type.
        Returns:
        the value
      • getTimeProvisioned

        public Date getTimeProvisioned()
        Subscribed service provisioning date.
        Returns:
        the value
      • getPromoType

        public String getPromoType()
        Subscribed service promotion type.
        Returns:
        the value
      • getCsi

        public Long getCsi()
        Subscribed service CSI number.
        Returns:
        the value
      • getCustomerTransactionReference

        public String getCustomerTransactionReference()
        Identifier for a customer’s transactions for purchase of any Oracle services.
        Returns:
        the value
      • getPartnerCreditAmount

        public String getPartnerCreditAmount()
        Subscribed service partner credit amount.
        Returns:
        the value
      • getIsSingleRateCard

        public Boolean getIsSingleRateCard()
        Indicates if the subscribed service has a single rate card.
        Returns:
        the value
      • getAgreementId

        public Long getAgreementId()
        Subscribed service agreement ID.
        Returns:
        the value
      • getAgreementName

        public String getAgreementName()
        Subscribed service agreement name.
        Returns:
        the value
      • getAgreementType

        public String getAgreementType()
        Subscribed service agreement type.
        Returns:
        the value
      • getBillingFrequency

        public String getBillingFrequency()
        Subscribed service invoice frequency.
        Returns:
        the value
      • getTimeWelcomeEmailSent

        public Date getTimeWelcomeEmailSent()
        Subscribed service welcome email sent date.
        Returns:
        the value
      • getTimeServiceConfigurationEmailSent

        public Date getTimeServiceConfigurationEmailSent()
        Subscribed service configuration email sent date.
        Returns:
        the value
      • getTimeCustomerConfig

        public Date getTimeCustomerConfig()
        Subscribed service customer configuration date.
        Returns:
        the value
      • getTimeAgreementEnd

        public Date getTimeAgreementEnd()
        Subscribed service agreement end date.
        Returns:
        the value
      • getTimeCreated

        public Date getTimeCreated()
        Subscribed service creation date.
        Returns:
        the value
      • getCreatedBy

        public String getCreatedBy()
        User that created the subscribed service.
        Returns:
        the value
      • getTimeUpdated

        public Date getTimeUpdated()
        Subscribed service last update date.
        Returns:
        the value
      • getUpdatedBy

        public String getUpdatedBy()
        User that updated the subscribed service.
        Returns:
        the value
      • getRatecardType

        public String getRatecardType()
        SPM (Subscription Plan Management) rate card type.
        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel