Package org.killbill.billing.account.api
Interface AccountData
-
- All Known Subinterfaces:
Account,MutableAccountData
public interface AccountDataThe interfaceAccountDataspecifies all the fields on theAccount.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetAddress1()StringgetAddress2()IntegergetBillCycleDayLocal()The billCycleDay should be interpreted in the account timezone.StringgetCity()StringgetCompanyName()StringgetCountry()CurrencygetCurrency()StringgetEmail()StringgetExternalKey()IntegergetFirstNameLength()StringgetLocale()StringgetName()The first and last name when that applies are combined into one name.StringgetNotes()UUIDgetParentAccountId()UUIDgetPaymentMethodId()StringgetPhone()StringgetPostalCode()org.joda.time.DateTimegetReferenceTime()StringgetStateOrProvince()org.joda.time.DateTimeZonegetTimeZone()BooleanisMigrated()BooleanisPaymentDelegatedToParent()
-
-
-
Method Detail
-
getExternalKey
String getExternalKey()
- Returns:
- the account externalKey
-
getName
String getName()
The first and last name when that applies are combined into one name.- Returns:
- the name of the account
- See Also:
getFirstNameLength()
-
getFirstNameLength
Integer getFirstNameLength()
- Returns:
- the length of the first name that can be extracted from the name
-
getEmail
String getEmail()
- Returns:
- the primary account email
-
getBillCycleDayLocal
Integer getBillCycleDayLocal()
The billCycleDay should be interpreted in the account timezone. The billCycleDay is used to determine when to bill an account Its is either set at account creation time or automatically set by the system.- Returns:
- the billCycleDay for that account
- See Also:
BillingAlignment
-
getCurrency
Currency getCurrency()
- Returns:
- the currency on the account
-
getPaymentMethodId
UUID getPaymentMethodId()
- Returns:
- the UUID of the current default paymentMethod
-
getReferenceTime
org.joda.time.DateTime getReferenceTime()
- Returns:
- the referenceTime for that account
-
getTimeZone
org.joda.time.DateTimeZone getTimeZone()
- Returns:
- the timezone for that account
-
getLocale
String getLocale()
- Returns:
- the locale for that account
-
getAddress1
String getAddress1()
- Returns:
- the address for that account (first line)
-
getAddress2
String getAddress2()
- Returns:
- the address for that account (second line)
-
getCompanyName
String getCompanyName()
- Returns:
- the company for that account
-
getCity
String getCity()
- Returns:
- the city for that account
-
getStateOrProvince
String getStateOrProvince()
- Returns:
- the state or province for that account
-
getPostalCode
String getPostalCode()
- Returns:
- the postal code for that account
-
getCountry
String getCountry()
- Returns:
- the country for that account
-
getPhone
String getPhone()
- Returns:
- the phone number for that account
-
isMigrated
Boolean isMigrated()
- Returns:
- whether or not that account was migrated into the system
-
getParentAccountId
UUID getParentAccountId()
- Returns:
- the UUID of the parent Account
-
isPaymentDelegatedToParent
Boolean isPaymentDelegatedToParent()
- Returns:
- whether or not the child account payment is delegated to Parent
-
getNotes
String getNotes()
- Returns:
- the notes for that account
-
-