Package com.softlayer.api.service.billing

Class Invoice

  • @ApiType("SoftLayer_Billing_Invoice")
public class Invoice
extends Entity
    The SoftLayer_Billing_Invoice data type contains general information relating to an individual invoice applied to a SoftLayer customer account. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the invoice is generated.
    See Also:
    SoftLayer_Billing_Invoice

    • Field Detail

      • detailedPdfGeneratedFlag

        @ApiProperty
protected Boolean detailedPdfGeneratedFlag
        A flag that will reflect whether the detailed version of the pdf has been generated.

      • invoiceTopLevelItems

        @ApiProperty
protected List<Item> invoiceTopLevelItems
        A list of top-level invoice items that are on the currently pending invoice.

      • invoiceTotalOneTimeAmount

        @ApiProperty
protected BigDecimal invoiceTotalOneTimeAmount
        The total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes.

      • invoiceTotalOneTimeTaxAmount

        @ApiProperty
protected BigDecimal invoiceTotalOneTimeTaxAmount
        A sum of all the taxes related to one time charges for this invoice.

      • invoiceTotalPreTaxAmount

        @ApiProperty
protected BigDecimal invoiceTotalPreTaxAmount
        The total amount of this invoice. This does not include taxes.

      • invoiceTotalRecurringAmount

        @ApiProperty
protected BigDecimal invoiceTotalRecurringAmount
        The total Recurring amount of this invoice. This amount does not include taxes or one time charges.

      • invoiceTotalRecurringTaxAmount

        @ApiProperty
protected BigDecimal invoiceTotalRecurringTaxAmount
        The total amount of the recurring taxes on this invoice.

      • localCurrencyExchangeRate

        @ApiProperty
protected ExchangeRate localCurrencyExchangeRate
        Exchange rate used for billing this invoice.

      • sellerRegistration

        @ApiProperty
protected String sellerRegistration
        This is the seller's tax registration.

      • taxInfo

        @ApiProperty
protected Info taxInfo
        This is the tax information that applies to tax auditing. This is the official tax record for this invoice.

      • taxInfoHistory

        @ApiProperty
protected List<Info> taxInfoHistory
        This is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information.

      • taxMessage

        @ApiProperty
protected String taxMessage
        This is a message explaining the tax treatment for this invoice.

      • taxType

        @ApiProperty
protected Type taxType
        This is the strategy used to calculate tax on this invoice.

      • accountIdSpecified

        protected boolean accountIdSpecified

      • address1Specified

        protected boolean address1Specified

      • address2Specified

        protected boolean address2Specified

      • citySpecified

        protected boolean citySpecified

      • claimedTaxExemptTxFlag

        @ApiProperty(canBeNullOrNotSet=true)
protected Boolean claimedTaxExemptTxFlag
        Whether an account was exempt from taxes on their invoices at the time an invoice is created.

      • claimedTaxExemptTxFlagSpecified

        protected boolean claimedTaxExemptTxFlagSpecified

      • closedDateSpecified

        protected boolean closedDateSpecified

      • companyNameSpecified

        protected boolean companyNameSpecified

      • country

        @ApiProperty(canBeNullOrNotSet=true)
protected String country
        A two-letter abbreviation of the country portion of an address belonging to an account at the time an invoice is created.

      • countrySpecified

        protected boolean countrySpecified

      • createDateSpecified

        protected boolean createDateSpecified

      • documentsGeneratedFlagSpecified

        protected boolean documentsGeneratedFlagSpecified

      • emailSpecified

        protected boolean emailSpecified

      • endingBalance

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal endingBalance
        An SoftLayer account's balance at the time an invoice is closed. This value is measured in US Dollar ($USD) currency.

      • endingBalanceSpecified

        protected boolean endingBalanceSpecified

      • faxPhoneSpecified

        protected boolean faxPhoneSpecified

      • firstNameSpecified

        protected boolean firstNameSpecified

      • idSpecified

        protected boolean idSpecified

      • lastNameSpecified

        protected boolean lastNameSpecified

      • modifyDateSpecified

        protected boolean modifyDateSpecified

      • officePhoneSpecified

        protected boolean officePhoneSpecified

      • postalCode

        @ApiProperty(canBeNullOrNotSet=true)
protected String postalCode
        The postal code portion of an address belonging to an account at the time an invoice is created.

      • postalCodeSpecified

        protected boolean postalCodeSpecified

      • purchaseOrderNumberSpecified

        protected boolean purchaseOrderNumberSpecified

      • startingBalance

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal startingBalance
        An SoftLayer account's balance at the time an invoice is created. This value is measured in US Dollar ($USD) currency.

      • startingBalanceSpecified

        protected boolean startingBalanceSpecified

      • state

        @ApiProperty(canBeNullOrNotSet=true)
protected String state
        A two-letter abbreviation of the state portion of an address belonging to an account at the time an invoice is created. If the account that the invoice was generated for resides outside a province then this is set to "other".

      • stateSpecified

        protected boolean stateSpecified

      • statusCode

        @ApiProperty(canBeNullOrNotSet=true)
protected String statusCode
        An invoice's status. The "OPEN" status means SoftLayer has not yet received payment for this invoice. "CLOSED" status means that SoftLayer has received payment and closed the invoice. The "CLOSED_FAILED" status code means SoftLayer closed the invoice without receiving a payment. Invoices are usually set to CLOSED_FAILED status in cases where customer accounts are terminated for non-payment.

      • statusCodeSpecified

        protected boolean statusCodeSpecified

      • taxStatusIdSpecified

        protected boolean taxStatusIdSpecified

      • taxTypeIdSpecified

        protected boolean taxTypeIdSpecified

      • typeCode

        @ApiProperty(canBeNullOrNotSet=true)
protected String typeCode
        An invoice's type. SoftLayer invoices and service credits are differentiated by their type. The "NEW" type code signifies an invoice for new service. A SoftLayer customer's first invoice has the NEW type code. "RECURRING" invoices are generated on a SoftLayer customer's anniversary billing date for monthly services. "ONE-TIME-CHARGE" invoices are generated when one-time charges are applied to an account. "CREDIT" invoices are generated whenever SoftLayer applies a credit against an account's balance. There are two special types of service credits. "REFUND" type credits are applied against a customer's account balance along with the receivables on their account. "MANUAL_PAYMENT_CREDIT" invoice credits are generated whenever a customer makes an unscheduled payment.

      • typeCodeSpecified

        protected boolean typeCodeSpecified

      • invoiceTopLevelItemCount

        @ApiProperty
protected Long invoiceTopLevelItemCount
        A count of a list of top-level invoice items that are on the currently pending invoice.

      • itemCount

        @ApiProperty
protected Long itemCount
        A count of the items that belong to this invoice.

      • paymentCount

        @ApiProperty
protected Long paymentCount
        A count of the payments for the invoice.

      • taxInfoHistoryCount

        @ApiProperty
protected Long taxInfoHistoryCount
        A count of this is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information.

    • Constructor Detail

      • Invoice

        public Invoice()

    • Method Detail

      • getAccount

        public Account getAccount()

      • setAccount

        public void setAccount​(Account account)

      • setAmount

        public void setAmount​(BigDecimal amount)

      • getBrandAtInvoiceCreation

        public Brand getBrandAtInvoiceCreation()

      • setBrandAtInvoiceCreation

        public void setBrandAtInvoiceCreation​(Brand brandAtInvoiceCreation)

      • getDetailedPdfGeneratedFlag

        public Boolean getDetailedPdfGeneratedFlag()

      • setDetailedPdfGeneratedFlag

        public void setDetailedPdfGeneratedFlag​(Boolean detailedPdfGeneratedFlag)

      • getInvoiceTopLevelItems

        public List<Item> getInvoiceTopLevelItems()

      • getInvoiceTotalAmount

        public BigDecimal getInvoiceTotalAmount()

      • setInvoiceTotalAmount

        public void setInvoiceTotalAmount​(BigDecimal invoiceTotalAmount)

      • getInvoiceTotalOneTimeAmount

        public BigDecimal getInvoiceTotalOneTimeAmount()

      • setInvoiceTotalOneTimeAmount

        public void setInvoiceTotalOneTimeAmount​(BigDecimal invoiceTotalOneTimeAmount)

      • getInvoiceTotalOneTimeTaxAmount

        public BigDecimal getInvoiceTotalOneTimeTaxAmount()

      • setInvoiceTotalOneTimeTaxAmount

        public void setInvoiceTotalOneTimeTaxAmount​(BigDecimal invoiceTotalOneTimeTaxAmount)

      • getInvoiceTotalPreTaxAmount

        public BigDecimal getInvoiceTotalPreTaxAmount()

      • setInvoiceTotalPreTaxAmount

        public void setInvoiceTotalPreTaxAmount​(BigDecimal invoiceTotalPreTaxAmount)

      • getInvoiceTotalRecurringAmount

        public BigDecimal getInvoiceTotalRecurringAmount()

      • setInvoiceTotalRecurringAmount

        public void setInvoiceTotalRecurringAmount​(BigDecimal invoiceTotalRecurringAmount)

      • getInvoiceTotalRecurringTaxAmount

        public BigDecimal getInvoiceTotalRecurringTaxAmount()

      • setInvoiceTotalRecurringTaxAmount

        public void setInvoiceTotalRecurringTaxAmount​(BigDecimal invoiceTotalRecurringTaxAmount)

      • getItems

        public List<Item> getItems()

      • getLocalCurrencyExchangeRate

        public ExchangeRate getLocalCurrencyExchangeRate()

      • setLocalCurrencyExchangeRate

        public void setLocalCurrencyExchangeRate​(ExchangeRate localCurrencyExchangeRate)

      • setPayment

        public void setPayment​(BigDecimal payment)

      • getSellerRegistration

        public String getSellerRegistration()

      • setSellerRegistration

        public void setSellerRegistration​(String sellerRegistration)

      • getTaxInfo

        public Info getTaxInfo()

      • setTaxInfo

        public void setTaxInfo​(Info taxInfo)

      • getTaxInfoHistory

        public List<Info> getTaxInfoHistory()

      • getTaxMessage

        public String getTaxMessage()

      • setTaxMessage

        public void setTaxMessage​(String taxMessage)

      • getTaxType

        public Type getTaxType()

      • setTaxType

        public void setTaxType​(Type taxType)

      • getAccountId

        public Long getAccountId()

      • setAccountId

        public void setAccountId​(Long accountId)

      • isAccountIdSpecified

        public boolean isAccountIdSpecified()

      • unsetAccountId

        public void unsetAccountId()

      • getAddress1

        public String getAddress1()

      • setAddress1

        public void setAddress1​(String address1)

      • isAddress1Specified

        public boolean isAddress1Specified()

      • unsetAddress1

        public void unsetAddress1()

      • getAddress2

        public String getAddress2()

      • setAddress2

        public void setAddress2​(String address2)

      • isAddress2Specified

        public boolean isAddress2Specified()

      • unsetAddress2

        public void unsetAddress2()

      • getCity

        public String getCity()

      • setCity

        public void setCity​(String city)

      • isCitySpecified

        public boolean isCitySpecified()

      • unsetCity

        public void unsetCity()

      • getClaimedTaxExemptTxFlag

        public Boolean getClaimedTaxExemptTxFlag()

      • setClaimedTaxExemptTxFlag

        public void setClaimedTaxExemptTxFlag​(Boolean claimedTaxExemptTxFlag)

      • isClaimedTaxExemptTxFlagSpecified

        public boolean isClaimedTaxExemptTxFlagSpecified()

      • unsetClaimedTaxExemptTxFlag

        public void unsetClaimedTaxExemptTxFlag()

      • isClosedDateSpecified

        public boolean isClosedDateSpecified()

      • unsetClosedDate

        public void unsetClosedDate()

      • getCompanyName

        public String getCompanyName()

      • setCompanyName

        public void setCompanyName​(String companyName)

      • isCompanyNameSpecified

        public boolean isCompanyNameSpecified()

      • unsetCompanyName

        public void unsetCompanyName()

      • getCountry

        public String getCountry()

      • setCountry

        public void setCountry​(String country)

      • isCountrySpecified

        public boolean isCountrySpecified()

      • unsetCountry

        public void unsetCountry()

      • isCreateDateSpecified

        public boolean isCreateDateSpecified()

      • unsetCreateDate

        public void unsetCreateDate()

      • getDocumentsGeneratedFlag

        public Boolean getDocumentsGeneratedFlag()

      • setDocumentsGeneratedFlag

        public void setDocumentsGeneratedFlag​(Boolean documentsGeneratedFlag)

      • isDocumentsGeneratedFlagSpecified

        public boolean isDocumentsGeneratedFlagSpecified()

      • unsetDocumentsGeneratedFlag

        public void unsetDocumentsGeneratedFlag()

      • getEmail

        public String getEmail()

      • setEmail

        public void setEmail​(String email)

      • isEmailSpecified

        public boolean isEmailSpecified()

      • unsetEmail

        public void unsetEmail()

      • getEndingBalance

        public BigDecimal getEndingBalance()

      • setEndingBalance

        public void setEndingBalance​(BigDecimal endingBalance)

      • isEndingBalanceSpecified

        public boolean isEndingBalanceSpecified()

      • unsetEndingBalance

        public void unsetEndingBalance()

      • getFaxPhone

        public String getFaxPhone()

      • setFaxPhone

        public void setFaxPhone​(String faxPhone)

      • isFaxPhoneSpecified

        public boolean isFaxPhoneSpecified()

      • unsetFaxPhone

        public void unsetFaxPhone()

      • getFirstName

        public String getFirstName()

      • setFirstName

        public void setFirstName​(String firstName)

      • isFirstNameSpecified

        public boolean isFirstNameSpecified()

      • unsetFirstName

        public void unsetFirstName()

      • getId

        public Long getId()

      • setId

        public void setId​(Long id)

      • isIdSpecified

        public boolean isIdSpecified()

      • unsetId

        public void unsetId()

      • getLastName

        public String getLastName()

      • setLastName

        public void setLastName​(String lastName)

      • isLastNameSpecified

        public boolean isLastNameSpecified()

      • unsetLastName

        public void unsetLastName()

      • isModifyDateSpecified

        public boolean isModifyDateSpecified()

      • unsetModifyDate

        public void unsetModifyDate()

      • getOfficePhone

        public String getOfficePhone()

      • setOfficePhone

        public void setOfficePhone​(String officePhone)

      • isOfficePhoneSpecified

        public boolean isOfficePhoneSpecified()

      • unsetOfficePhone

        public void unsetOfficePhone()

      • getPostalCode

        public String getPostalCode()

      • setPostalCode

        public void setPostalCode​(String postalCode)

      • isPostalCodeSpecified

        public boolean isPostalCodeSpecified()

      • unsetPostalCode

        public void unsetPostalCode()

      • getPurchaseOrderNumber

        public String getPurchaseOrderNumber()

      • setPurchaseOrderNumber

        public void setPurchaseOrderNumber​(String purchaseOrderNumber)

      • isPurchaseOrderNumberSpecified

        public boolean isPurchaseOrderNumberSpecified()

      • unsetPurchaseOrderNumber

        public void unsetPurchaseOrderNumber()

      • getStartingBalance

        public BigDecimal getStartingBalance()

      • setStartingBalance

        public void setStartingBalance​(BigDecimal startingBalance)

      • isStartingBalanceSpecified

        public boolean isStartingBalanceSpecified()

      • unsetStartingBalance

        public void unsetStartingBalance()

      • getState

        public String getState()

      • setState

        public void setState​(String state)

      • isStateSpecified

        public boolean isStateSpecified()

      • unsetState

        public void unsetState()

      • getStatusCode

        public String getStatusCode()

      • setStatusCode

        public void setStatusCode​(String statusCode)

      • isStatusCodeSpecified

        public boolean isStatusCodeSpecified()

      • unsetStatusCode

        public void unsetStatusCode()

      • getTaxStatusId

        public Long getTaxStatusId()

      • setTaxStatusId

        public void setTaxStatusId​(Long taxStatusId)

      • isTaxStatusIdSpecified

        public boolean isTaxStatusIdSpecified()

      • unsetTaxStatusId

        public void unsetTaxStatusId()

      • getTaxTypeId

        public Long getTaxTypeId()

      • setTaxTypeId

        public void setTaxTypeId​(Long taxTypeId)

      • isTaxTypeIdSpecified

        public boolean isTaxTypeIdSpecified()

      • unsetTaxTypeId

        public void unsetTaxTypeId()

      • getTypeCode

        public String getTypeCode()

      • setTypeCode

        public void setTypeCode​(String typeCode)

      • isTypeCodeSpecified

        public boolean isTypeCodeSpecified()

      • unsetTypeCode

        public void unsetTypeCode()

      • getInvoiceTopLevelItemCount

        public Long getInvoiceTopLevelItemCount()

      • setInvoiceTopLevelItemCount

        public void setInvoiceTopLevelItemCount​(Long invoiceTopLevelItemCount)

      • getItemCount

        public Long getItemCount()

      • setItemCount

        public void setItemCount​(Long itemCount)

      • getPaymentCount

        public Long getPaymentCount()

      • setPaymentCount

        public void setPaymentCount​(Long paymentCount)

      • getTaxInfoHistoryCount

        public Long getTaxInfoHistoryCount()

      • setTaxInfoHistoryCount

        public void setTaxInfoHistoryCount​(Long taxInfoHistoryCount)