com.softlayer.api.service.billing.Info Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.billing;
import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.billing.Currency;
import com.softlayer.api.service.billing.info.Ach;
import com.softlayer.api.service.billing.info.Cycle;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
* Every SoftLayer customer account has billing specific information which is kept in the SoftLayer_Billing_Info data type. This information is used by the SoftLayer accounting group when sending invoices and making billing inquiries.
*
* @see SoftLayer_Billing_Info
*/
@ApiType("SoftLayer_Billing_Info")
public class Info extends Entity {
/**
* The SoftLayer customer account associated with this billing information.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
@ApiProperty
protected List achInformation;
public List getAchInformation() {
if (achInformation == null) {
achInformation = new ArrayList();
}
return achInformation;
}
/**
* Currency to be used by this customer account.
*/
@ApiProperty
protected Currency currency;
public Currency getCurrency() {
return currency;
}
public void setCurrency(Currency currency) {
this.currency = currency;
}
/**
* Information related to an account's current and previous billing cycles.
*/
@ApiProperty
protected Cycle currentBillingCycle;
public Cycle getCurrentBillingCycle() {
return currentBillingCycle;
}
public void setCurrentBillingCycle(Cycle currentBillingCycle) {
this.currentBillingCycle = currentBillingCycle;
}
/**
* The date on which an account was last billed.
*/
@ApiProperty
protected GregorianCalendar lastBillDate;
public GregorianCalendar getLastBillDate() {
return lastBillDate;
}
public void setLastBillDate(GregorianCalendar lastBillDate) {
this.lastBillDate = lastBillDate;
}
/**
* The date on which an account will be billed next.
*/
@ApiProperty
protected GregorianCalendar nextBillDate;
public GregorianCalendar getNextBillDate() {
return nextBillDate;
}
public void setNextBillDate(GregorianCalendar nextBillDate) {
this.nextBillDate = nextBillDate;
}
/**
* A SoftLayer account's identifier.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long accountId;
public Long getAccountId() {
return accountId;
}
public void setAccountId(Long accountId) {
accountIdSpecified = true;
this.accountId = accountId;
}
protected boolean accountIdSpecified;
public boolean isAccountIdSpecified() {
return accountIdSpecified;
}
public void unsetAccountId() {
accountId = null;
accountIdSpecified = false;
}
/**
* The day of the month that a SoftLayer customer is billed.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long anniversaryDayOfMonth;
public Long getAnniversaryDayOfMonth() {
return anniversaryDayOfMonth;
}
public void setAnniversaryDayOfMonth(Long anniversaryDayOfMonth) {
anniversaryDayOfMonthSpecified = true;
this.anniversaryDayOfMonth = anniversaryDayOfMonth;
}
protected boolean anniversaryDayOfMonthSpecified;
public boolean isAnniversaryDayOfMonthSpecified() {
return anniversaryDayOfMonthSpecified;
}
public void unsetAnniversaryDayOfMonth() {
anniversaryDayOfMonth = null;
anniversaryDayOfMonthSpecified = false;
}
/**
* This value doesn't persist to this object. It's used as part of the account creation process only;
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String cardAccountNumber;
public String getCardAccountNumber() {
return cardAccountNumber;
}
public void setCardAccountNumber(String cardAccountNumber) {
cardAccountNumberSpecified = true;
this.cardAccountNumber = cardAccountNumber;
}
protected boolean cardAccountNumberSpecified;
public boolean isCardAccountNumberSpecified() {
return cardAccountNumberSpecified;
}
public void unsetCardAccountNumber() {
cardAccountNumber = null;
cardAccountNumberSpecified = false;
}
/**
* the expiration month of the credit card on file
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long cardExpirationMonth;
public Long getCardExpirationMonth() {
return cardExpirationMonth;
}
public void setCardExpirationMonth(Long cardExpirationMonth) {
cardExpirationMonthSpecified = true;
this.cardExpirationMonth = cardExpirationMonth;
}
protected boolean cardExpirationMonthSpecified;
public boolean isCardExpirationMonthSpecified() {
return cardExpirationMonthSpecified;
}
public void unsetCardExpirationMonth() {
cardExpirationMonth = null;
cardExpirationMonthSpecified = false;
}
/**
* the expiration year of the credit card on file
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long cardExpirationYear;
public Long getCardExpirationYear() {
return cardExpirationYear;
}
public void setCardExpirationYear(Long cardExpirationYear) {
cardExpirationYearSpecified = true;
this.cardExpirationYear = cardExpirationYear;
}
protected boolean cardExpirationYearSpecified;
public boolean isCardExpirationYearSpecified() {
return cardExpirationYearSpecified;
}
public void unsetCardExpirationYear() {
cardExpirationYear = null;
cardExpirationYearSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected String cardNickname;
public String getCardNickname() {
return cardNickname;
}
public void setCardNickname(String cardNickname) {
cardNicknameSpecified = true;
this.cardNickname = cardNickname;
}
protected boolean cardNicknameSpecified;
public boolean isCardNicknameSpecified() {
return cardNicknameSpecified;
}
public void unsetCardNickname() {
cardNickname = null;
cardNicknameSpecified = false;
}
/**
* the type of the credit card on file
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String cardType;
public String getCardType() {
return cardType;
}
public void setCardType(String cardType) {
cardTypeSpecified = true;
this.cardType = cardType;
}
protected boolean cardTypeSpecified;
public boolean isCardTypeSpecified() {
return cardTypeSpecified;
}
public void unsetCardType() {
cardType = null;
cardTypeSpecified = false;
}
/**
* This value doesn't persist to this object. It's used as part of the account creation process only.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String cardVerificationNumber;
public String getCardVerificationNumber() {
return cardVerificationNumber;
}
public void setCardVerificationNumber(String cardVerificationNumber) {
cardVerificationNumberSpecified = true;
this.cardVerificationNumber = cardVerificationNumber;
}
protected boolean cardVerificationNumberSpecified;
public boolean isCardVerificationNumberSpecified() {
return cardVerificationNumberSpecified;
}
public void unsetCardVerificationNumber() {
cardVerificationNumber = null;
cardVerificationNumberSpecified = false;
}
/**
* The date a customer's billing information was created.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar createDate;
public GregorianCalendar getCreateDate() {
return createDate;
}
public void setCreateDate(GregorianCalendar createDate) {
createDateSpecified = true;
this.createDate = createDate;
}
protected boolean createDateSpecified;
public boolean isCreateDateSpecified() {
return createDateSpecified;
}
public void unsetCreateDate() {
createDate = null;
createDateSpecified = false;
}
/**
* A SoftLayer customer's billing information identifier.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long id;
public Long getId() {
return id;
}
public void setId(Long id) {
idSpecified = true;
this.id = id;
}
protected boolean idSpecified;
public boolean isIdSpecified() {
return idSpecified;
}
public void unsetId() {
id = null;
idSpecified = false;
}
/**
* The last four digits of the credit card currently on the account. This is the only portion of the card that we store. For Paypal customers, this value will be empty.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long lastFourPaymentCardDigits;
public Long getLastFourPaymentCardDigits() {
return lastFourPaymentCardDigits;
}
public void setLastFourPaymentCardDigits(Long lastFourPaymentCardDigits) {
lastFourPaymentCardDigitsSpecified = true;
this.lastFourPaymentCardDigits = lastFourPaymentCardDigits;
}
protected boolean lastFourPaymentCardDigitsSpecified;
public boolean isLastFourPaymentCardDigitsSpecified() {
return lastFourPaymentCardDigitsSpecified;
}
public void unsetLastFourPaymentCardDigits() {
lastFourPaymentCardDigits = null;
lastFourPaymentCardDigitsSpecified = false;
}
/**
* The date of the last payment received by SoftLayer from the account holder.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar lastPaymentDate;
public GregorianCalendar getLastPaymentDate() {
return lastPaymentDate;
}
public void setLastPaymentDate(GregorianCalendar lastPaymentDate) {
lastPaymentDateSpecified = true;
this.lastPaymentDate = lastPaymentDate;
}
protected boolean lastPaymentDateSpecified;
public boolean isLastPaymentDateSpecified() {
return lastPaymentDateSpecified;
}
public void unsetLastPaymentDate() {
lastPaymentDate = null;
lastPaymentDateSpecified = false;
}
/**
* The date a customer's billing information was last modified.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar modifyDate;
public GregorianCalendar getModifyDate() {
return modifyDate;
}
public void setModifyDate(GregorianCalendar modifyDate) {
modifyDateSpecified = true;
this.modifyDate = modifyDate;
}
protected boolean modifyDateSpecified;
public boolean isModifyDateSpecified() {
return modifyDateSpecified;
}
public void unsetModifyDate() {
modifyDate = null;
modifyDateSpecified = false;
}
/**
* The payment terms for an account.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long paymentTerms;
public Long getPaymentTerms() {
return paymentTerms;
}
public void setPaymentTerms(Long paymentTerms) {
paymentTermsSpecified = true;
this.paymentTerms = paymentTerms;
}
protected boolean paymentTermsSpecified;
public boolean isPaymentTermsSpecified() {
return paymentTermsSpecified;
}
public void unsetPaymentTerms() {
paymentTerms = null;
paymentTermsSpecified = false;
}
/**
* The percentage discount received on all one-time charges on a customer's monthly bill.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long percentDiscountOnetime;
public Long getPercentDiscountOnetime() {
return percentDiscountOnetime;
}
public void setPercentDiscountOnetime(Long percentDiscountOnetime) {
percentDiscountOnetimeSpecified = true;
this.percentDiscountOnetime = percentDiscountOnetime;
}
protected boolean percentDiscountOnetimeSpecified;
public boolean isPercentDiscountOnetimeSpecified() {
return percentDiscountOnetimeSpecified;
}
public void unsetPercentDiscountOnetime() {
percentDiscountOnetime = null;
percentDiscountOnetimeSpecified = false;
}
/**
* The percentage discount received on all recurring charges on a customer's monthly bill.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long percentDiscountRecurring;
public Long getPercentDiscountRecurring() {
return percentDiscountRecurring;
}
public void setPercentDiscountRecurring(Long percentDiscountRecurring) {
percentDiscountRecurringSpecified = true;
this.percentDiscountRecurring = percentDiscountRecurring;
}
protected boolean percentDiscountRecurringSpecified;
public boolean isPercentDiscountRecurringSpecified() {
return percentDiscountRecurringSpecified;
}
public void unsetPercentDiscountRecurring() {
percentDiscountRecurring = null;
percentDiscountRecurringSpecified = false;
}
/**
* The total recurring fee amount for servers that are in the spare pool status.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long sparePoolAmount;
public Long getSparePoolAmount() {
return sparePoolAmount;
}
public void setSparePoolAmount(Long sparePoolAmount) {
sparePoolAmountSpecified = true;
this.sparePoolAmount = sparePoolAmount;
}
protected boolean sparePoolAmountSpecified;
public boolean isSparePoolAmountSpecified() {
return sparePoolAmountSpecified;
}
public void unsetSparePoolAmount() {
sparePoolAmount = null;
sparePoolAmountSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected String taxCertificateId;
public String getTaxCertificateId() {
return taxCertificateId;
}
public void setTaxCertificateId(String taxCertificateId) {
taxCertificateIdSpecified = true;
this.taxCertificateId = taxCertificateId;
}
protected boolean taxCertificateIdSpecified;
public boolean isTaxCertificateIdSpecified() {
return taxCertificateIdSpecified;
}
public void unsetTaxCertificateId() {
taxCertificateId = null;
taxCertificateIdSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected String vatId;
public String getVatId() {
return vatId;
}
public void setVatId(String vatId) {
vatIdSpecified = true;
this.vatId = vatId;
}
protected boolean vatIdSpecified;
public boolean isVatIdSpecified() {
return vatIdSpecified;
}
public void unsetVatId() {
vatId = null;
vatIdSpecified = false;
}
/**
* A count of
*/
@ApiProperty
protected Long achInformationCount;
public Long getAchInformationCount() {
return achInformationCount;
}
public void setAchInformationCount(Long achInformationCount) {
this.achInformationCount = achInformationCount;
}
public Service asService(ApiClient client) {
return service(client, id);
}
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
public static Service service(ApiClient client, Long id) {
return client.createService(Service.class, id == null ? null : id.toString());
}
/**
* SoftLayer billing info contains company billing information such as the last date a payment was made and the last time any billing information was update. Use the data returned by these methods with other API services to get more detailed information about your billing information.
*
* Due to the sensitivity of your billing information we don't allow changing this data through the API. Please open a sales ticket in our customer portal if you need to change this information.
*
* @see SoftLayer_Billing_Info
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Billing_Info")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* getObject retrieves the SoftLayer_Billing_Info object whose data corresponds to the account to which your portal user is tied.
*
* @see SoftLayer_Billing_Info::getObject
*/
@ApiMethod(instanceRequired = true)
public Info getObject();
/**
* The SoftLayer customer account associated with this billing information.
*
* @see SoftLayer_Billing_Info::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* @see SoftLayer_Billing_Info::getAchInformation
*/
@ApiMethod(instanceRequired = true)
public List getAchInformation();
/**
* Currency to be used by this customer account.
*
* @see SoftLayer_Billing_Info::getCurrency
*/
@ApiMethod(instanceRequired = true)
public Currency getCurrency();
/**
* Information related to an account's current and previous billing cycles.
*
* @see SoftLayer_Billing_Info::getCurrentBillingCycle
*/
@ApiMethod(instanceRequired = true)
public Cycle getCurrentBillingCycle();
/**
* The date on which an account was last billed.
*
* @see SoftLayer_Billing_Info::getLastBillDate
*/
@ApiMethod(instanceRequired = true)
public GregorianCalendar getLastBillDate();
/**
* The date on which an account will be billed next.
*
* @see SoftLayer_Billing_Info::getNextBillDate
*/
@ApiMethod(instanceRequired = true)
public GregorianCalendar getNextBillDate();
}
public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#getAccount}
*/
public Future getAccount();
/**
* Async callback version of {@link Service#getAccount}
*/
public Future getAccount(ResponseHandler callback);
/**
* Async version of {@link Service#getAchInformation}
*/
public Future> getAchInformation();
/**
* Async callback version of {@link Service#getAchInformation}
*/
public Future getAchInformation(ResponseHandler> callback);
/**
* Async version of {@link Service#getCurrency}
*/
public Future getCurrency();
/**
* Async callback version of {@link Service#getCurrency}
*/
public Future getCurrency(ResponseHandler callback);
/**
* Async version of {@link Service#getCurrentBillingCycle}
*/
public Future getCurrentBillingCycle();
/**
* Async callback version of {@link Service#getCurrentBillingCycle}
*/
public Future getCurrentBillingCycle(ResponseHandler callback);
/**
* Async version of {@link Service#getLastBillDate}
*/
public Future getLastBillDate();
/**
* Async callback version of {@link Service#getLastBillDate}
*/
public Future getLastBillDate(ResponseHandler callback);
/**
* Async version of {@link Service#getNextBillDate}
*/
public Future getNextBillDate();
/**
* Async callback version of {@link Service#getNextBillDate}
*/
public Future getNextBillDate(ResponseHandler callback);
}
public static class Mask extends com.softlayer.api.service.Entity.Mask {
public com.softlayer.api.service.Account.Mask account() {
return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
}
public com.softlayer.api.service.billing.info.Ach.Mask achInformation() {
return withSubMask("achInformation", com.softlayer.api.service.billing.info.Ach.Mask.class);
}
public Currency.Mask currency() {
return withSubMask("currency", Currency.Mask.class);
}
public com.softlayer.api.service.billing.info.Cycle.Mask currentBillingCycle() {
return withSubMask("currentBillingCycle", com.softlayer.api.service.billing.info.Cycle.Mask.class);
}
public Mask lastBillDate() {
withLocalProperty("lastBillDate");
return this;
}
public Mask nextBillDate() {
withLocalProperty("nextBillDate");
return this;
}
public Mask accountId() {
withLocalProperty("accountId");
return this;
}
public Mask anniversaryDayOfMonth() {
withLocalProperty("anniversaryDayOfMonth");
return this;
}
public Mask cardAccountNumber() {
withLocalProperty("cardAccountNumber");
return this;
}
public Mask cardExpirationMonth() {
withLocalProperty("cardExpirationMonth");
return this;
}
public Mask cardExpirationYear() {
withLocalProperty("cardExpirationYear");
return this;
}
public Mask cardNickname() {
withLocalProperty("cardNickname");
return this;
}
public Mask cardType() {
withLocalProperty("cardType");
return this;
}
public Mask cardVerificationNumber() {
withLocalProperty("cardVerificationNumber");
return this;
}
public Mask createDate() {
withLocalProperty("createDate");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask lastFourPaymentCardDigits() {
withLocalProperty("lastFourPaymentCardDigits");
return this;
}
public Mask lastPaymentDate() {
withLocalProperty("lastPaymentDate");
return this;
}
public Mask modifyDate() {
withLocalProperty("modifyDate");
return this;
}
public Mask paymentTerms() {
withLocalProperty("paymentTerms");
return this;
}
public Mask percentDiscountOnetime() {
withLocalProperty("percentDiscountOnetime");
return this;
}
public Mask percentDiscountRecurring() {
withLocalProperty("percentDiscountRecurring");
return this;
}
public Mask sparePoolAmount() {
withLocalProperty("sparePoolAmount");
return this;
}
public Mask taxCertificateId() {
withLocalProperty("taxCertificateId");
return this;
}
public Mask vatId() {
withLocalProperty("vatId");
return this;
}
public Mask achInformationCount() {
withLocalProperty("achInformationCount");
return this;
}
}
}