Package net.amcintosh.freshbooks.models

Enum Class Invoice.InvoiceV3Status

java.lang.Object

java.lang.Enum<Invoice.InvoiceV3Status>

net.amcintosh.freshbooks.models.Invoice.InvoiceV3Status

All Implemented Interfaces:

Serializable, Comparable<Invoice.InvoiceV3Status>, Constable

Enclosing class:

Invoice

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

v3 status fields give a descriptive name to states which can be used in filters.
Values are:

• CREATED: Invoice is created and in no other state
• DRAFT: Invoice is saved in draft status
• SENT: Invoice has been sent
• VIEWED: Invoice has been viewed by recipient
• FAILED: An autobill related to the invoice has been tried more than once and failed
• RETRY: An autobill related to the invoice has been tried once and failed, and will be retried
• SUCCESS: An autobill related to the invoice has succeeded
• AUTOPAID: A payment has been tied to the invoice automatically via autobill
• PAID: Payments related to the invoice have succeeded and the object is fully paid
• PARTIAL: Some payment related to the invoice has succeeded but the invoice is not yet paid off
• DISPUTED: The invoice is disputed
• RESOLVED: The invoice was disputed and the dispute has been marked as resolved
• OVERDUE: The invoice required an action at an earlier date that was not met
• DEPOSIT_PARTIAL: The invoice has a related deposit which has been partially paid
• DEPOSIT_PAID: The invoice has a related deposit which has been fully paid
• DECLINED: The invoice has a related order which has been declined
• PENDING: The invoice has a related order which is pending

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
CREATED
DECLINED
DEPOSIT_PAID
DEPOSIT_PARTIAL
DISPUTED
DRAFT
FAILED
OVERDUE
PAID
PARTIAL
PENDING
RESOLVED
RETRY
SENT
SUCCESS
VIEWED

Method Summary

Modifier and Type	Method	Description
static Invoice.InvoiceV3Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Invoice.InvoiceV3Status[]	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

CREATED

public static final Invoice.InvoiceV3Status CREATED

DRAFT

public static final Invoice.InvoiceV3Status DRAFT

SENT

public static final Invoice.InvoiceV3Status SENT

VIEWED

public static final Invoice.InvoiceV3Status VIEWED

FAILED

public static final Invoice.InvoiceV3Status FAILED

RETRY

public static final Invoice.InvoiceV3Status RETRY

SUCCESS

public static final Invoice.InvoiceV3Status SUCCESS

AUTOPAID

public static final Invoice.InvoiceV3Status AUTOPAID

PAID

public static final Invoice.InvoiceV3Status PAID

PARTIAL

public static final Invoice.InvoiceV3Status PARTIAL

DISPUTED

public static final Invoice.InvoiceV3Status DISPUTED

RESOLVED

public static final Invoice.InvoiceV3Status RESOLVED

OVERDUE

public static final Invoice.InvoiceV3Status OVERDUE

DEPOSIT_PARTIAL

public static final Invoice.InvoiceV3Status DEPOSIT_PARTIAL

DEPOSIT_PAID

public static final Invoice.InvoiceV3Status DEPOSIT_PAID

DECLINED

public static final Invoice.InvoiceV3Status DECLINED

PENDING

public static final Invoice.InvoiceV3Status PENDING

Method Details

values

public static Invoice.InvoiceV3Status[] 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.InvoiceV3Status 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