Package net.amcintosh.freshbooks.models

Enum Class Invoice.InvoiceStatus

java.lang.Object

java.lang.Enum<Invoice.InvoiceStatus>

net.amcintosh.freshbooks.models.Invoice.InvoiceStatus

All Implemented Interfaces:

Serializable, Comparable<Invoice.InvoiceStatus>, Constable

Enclosing class:

Invoice

public static enum Invoice.InvoiceStatus
extends Enum<Invoice.InvoiceStatus>

Status values for an invoice.
Values are:

• DISPUTED: An Invoice with the Dispute option enabled, which has been disputed by a Client. This is a feature of FreshBooks Classic only and should only appear in migrated accounts.
• DRAFT: An Invoice that has been created, but not yet sent.
• SENT: An Invoice that has been sent to a Client or marked as sent.
• VIEWED: An Invoice that has been viewed by a Client.
• PAID: A fully paid Invoice.
• AUTOPAID: An Invoice paid automatically with a saved credit card.
• RETRY: An Invoice that would normally be paid automatically, but encountered a processing issue, either due to a bad card or a service outage. It will be retried 1 day later.
• FAILED: An Invoice that was in Retry status which again encountered a processing issue when being retried.
• PARTIAL: An Invoice that has been partially paid.

See Also:

• FreshBooks API - Invoices

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTOPAID
DISPUTED
DRAFT
FAILED
PAID
PARTIAL
RETRY
SENT
VIEWED

Method Summary

Modifier and Type	Method	Description
int	getValue()
static Invoice.InvoiceStatus	valueOf(int invoiceStatus)	Returns the enum constant of this class with the specified name.
static Invoice.InvoiceStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Invoice.InvoiceStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISPUTED

public static final Invoice.InvoiceStatus DISPUTED

DRAFT

public static final Invoice.InvoiceStatus DRAFT

SENT

public static final Invoice.InvoiceStatus SENT

VIEWED

public static final Invoice.InvoiceStatus VIEWED

PAID

public static final Invoice.InvoiceStatus PAID

AUTOPAID

public static final Invoice.InvoiceStatus AUTOPAID

RETRY

public static final Invoice.InvoiceStatus RETRY

FAILED

public static final Invoice.InvoiceStatus FAILED

PARTIAL

public static final Invoice.InvoiceStatus PARTIAL

Method Details

values

public static Invoice.InvoiceStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Invoice.InvoiceStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

valueOf

public static Invoice.InvoiceStatus valueOf(int invoiceStatus)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

invoiceStatus - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()