net.billforward.model

Class Account

java.lang.Object

net.billforward.model.BillingEntity

net.billforward.model.InsertableEntity<TEntityType>

net.billforward.model.MutableEntity<Account>

net.billforward.model.Account

public class Account
extends MutableEntity<Account>

An account represents a customer or employee within an organization. All data for a particular customer or employee in an organization is associated with their account, for example, a user's subscriptions, invoices or payment methods.

Author:

Ian

See Also:

https://app.billforward.net/api/#/method/accounts

Field Summary

Fields

Modifier and Type	Field and Description
protected String	changedBy
protected Date	created
protected boolean	deleted
protected String	id
protected String	organizationID
protected PaymentMethod[]	paymentMethods
protected Profile	profile
protected static ResourcePath	resourcePath
protected int	successfulSubscriptions
protected Date	updated
protected String	userID

Fields inherited from class net.billforward.model.BillingEntity

m_client, PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
Account()
Account(BillForwardClient client_)

Method Summary

Methods

Modifier and Type	Method and Description
static Account	create(Account account)
static Account[]	getAll()
static Account	getByID(String ID)
String	getChangedBy()
Date	getCreated()
String	getID()
String	getOrganizationID()
PaymentMethod[]	getPaymentMethods()
Profile	getProfile()
protected ResourcePath	getResourcePath()
int	getSuccessfulSubscriptions() Number of distinct, paid subscriptions associated with this account.
Date	getUpdated()
String	getUserID() User associated with the account.
boolean	isDeleted() Indicates if an account has been retired.
protected static ResourcePath	ResourcePath()
void	setDeleted(boolean deleted)
void	setProfile(Profile profile_)
void	setUserID(String userID) Associated a user with account

Methods inherited from class net.billforward.model.MutableEntity

save

Methods inherited from class net.billforward.model.InsertableEntity

create, create, retire

Methods inherited from class net.billforward.model.BillingEntity

getAll, getByID, getByID, getByIDPostPath, getClient, setClient, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

protected String id

organizationID

protected String organizationID

userID

protected String userID

successfulSubscriptions

protected int successfulSubscriptions

deleted

protected boolean deleted

created

protected Date created

updated

protected Date updated

changedBy

protected String changedBy

profile

protected Profile profile

paymentMethods

protected PaymentMethod[] paymentMethods

resourcePath

protected static ResourcePath resourcePath

Constructor Detail

Account

public Account(BillForwardClient client_)

Account

public Account()

Method Detail

getID

public String getID()

Returns:

ID of the account.

getOrganizationID

public String getOrganizationID()

Returns:

Organization associated with the account.

getUserID

public String getUserID()

User associated with the account. If this is null, no user is currently associated with the account. A user is only set when an account is associated with a user account.

Returns:

User associated with the account.

setUserID

public void setUserID(String userID)

Associated a user with account

Parameters:

User - associated with the account.

getSuccessfulSubscriptions

public int getSuccessfulSubscriptions()

Number of distinct, paid subscriptions associated with this account. Initially the value will be 0 when no successful subscriptions have been taken. A subscription cancelled whilst in trial is counted as successful.

Returns:

Number of distinct, paid subscriptions associated with this account.

isDeleted

public boolean isDeleted()

Indicates if an account has been retired. If an account has been retired it can still be retrieved using the appropriate flag on API requests.

Returns:

Indicates if an account has been retired.

setDeleted

public void setDeleted(boolean deleted)

getCreated

public Date getCreated()

Returns:

The UTC DateTime when the object was created.

getUpdated

public Date getUpdated()

Returns:

The UTC DateTime when the object was last updated.

getChangedBy

public String getChangedBy()

Returns:

ID of the user who last updated the entity.

getProfile

public Profile getProfile()

Returns:

setProfile

public void setProfile(Profile profile_)

getPaymentMethods

public PaymentMethod[] getPaymentMethods()

create

public static Account create(Account account)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             CardException,
                             APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getByID

public static Account getByID(String ID)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getAll

public static Account[] getAll()
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getResourcePath

protected ResourcePath getResourcePath()

Specified by:

getResourcePath in class BillingEntity

ResourcePath

protected static ResourcePath ResourcePath()