Class EventProperties


  • public final class EventProperties
    extends Object
    The event properties.
    • Constructor Detail

      • EventProperties

        public EventProperties()
    • Method Detail

      • transactionDate

        public OffsetDateTime transactionDate()
        Get the transactionDate property: The date of the event.
        Returns:
        the transactionDate value.
      • description

        public String description()
        Get the description property: The description of the event.
        Returns:
        the description value.
      • newCredit

        public Amount newCredit()
        Get the newCredit property: The amount of new credit or commitment for NewCredit or SettleCharges event.
        Returns:
        the newCredit value.
      • adjustments

        public Amount adjustments()
        Get the adjustments property: The amount of balance adjustment. The property is not available for ConsumptionCommitment lots.
        Returns:
        the adjustments value.
      • creditExpired

        public Amount creditExpired()
        Get the creditExpired property: The amount of expired credit or commitment for NewCredit or SettleCharges event.
        Returns:
        the creditExpired value.
      • charges

        public Amount charges()
        Get the charges property: The amount of charges for events of type SettleCharges and PendingEligibleCharges.
        Returns:
        the charges value.
      • closedBalance

        public Amount closedBalance()
        Get the closedBalance property: The balance after the event.
        Returns:
        the closedBalance value.
      • eventType

        public EventType eventType()
        Get the eventType property: Identifies the type of the event.
        Returns:
        the eventType value.
      • withEventType

        public EventProperties withEventType​(EventType eventType)
        Set the eventType property: Identifies the type of the event.
        Parameters:
        eventType - the eventType value to set.
        Returns:
        the EventProperties object itself.
      • invoiceNumber

        public String invoiceNumber()
        Get the invoiceNumber property: The number which uniquely identifies the invoice on which the event was billed. This will be empty for unbilled events.
        Returns:
        the invoiceNumber value.
      • billingProfileId

        public String billingProfileId()
        Get the billingProfileId property: The ID that uniquely identifies the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement.
        Returns:
        the billingProfileId value.
      • billingProfileDisplayName

        public String billingProfileDisplayName()
        Get the billingProfileDisplayName property: The display name of the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement.
        Returns:
        the billingProfileDisplayName value.
      • lotId

        public String lotId()
        Get the lotId property: The ID that uniquely identifies the lot for which the event happened.
        Returns:
        the lotId value.
      • lotSource

        public String lotSource()
        Get the lotSource property: Identifies the source of the lot for which the event happened.
        Returns:
        the lotSource value.
      • canceledCredit

        public Amount canceledCredit()
        Get the canceledCredit property: Amount of canceled credit.
        Returns:
        the canceledCredit value.
      • creditCurrency

        public String creditCurrency()
        Get the creditCurrency property: The credit currency of the event.
        Returns:
        the creditCurrency value.
      • billingCurrency

        public String billingCurrency()
        Get the billingCurrency property: The billing currency of the event.
        Returns:
        the billingCurrency value.
      • reseller

        public Reseller reseller()
        Get the reseller property: The reseller of the event.
        Returns:
        the reseller value.
      • creditExpiredInBillingCurrency

        public AmountWithExchangeRate creditExpiredInBillingCurrency()
        Get the creditExpiredInBillingCurrency property: The amount of expired credit or commitment for NewCredit or SettleCharges event in billing currency.
        Returns:
        the creditExpiredInBillingCurrency value.
      • newCreditInBillingCurrency

        public AmountWithExchangeRate newCreditInBillingCurrency()
        Get the newCreditInBillingCurrency property: The amount of new credit or commitment for NewCredit or SettleCharges event in billing currency.
        Returns:
        the newCreditInBillingCurrency value.
      • adjustmentsInBillingCurrency

        public AmountWithExchangeRate adjustmentsInBillingCurrency()
        Get the adjustmentsInBillingCurrency property: The amount of balance adjustment in billing currency.
        Returns:
        the adjustmentsInBillingCurrency value.
      • chargesInBillingCurrency

        public AmountWithExchangeRate chargesInBillingCurrency()
        Get the chargesInBillingCurrency property: The amount of charges for events of type SettleCharges and PendingEligibleCharges in billing currency.
        Returns:
        the chargesInBillingCurrency value.
      • closedBalanceInBillingCurrency

        public AmountWithExchangeRate closedBalanceInBillingCurrency()
        Get the closedBalanceInBillingCurrency property: The balance in billing currency after the event.
        Returns:
        the closedBalanceInBillingCurrency value.
      • etag

        public String etag()
        Get the etag property: The eTag for the resource.
        Returns:
        the etag value.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.