InvoiceStatus enum

Inheritance

Constructors

InvoiceStatus()
const

Values

draft → const InvoiceStatus

The invoice is a draft. You must publish a draft invoice before Square can process it. A draft invoice has no public_url, so it is not available to customers.

unpaid → const InvoiceStatus

The invoice is published but not yet paid.

scheduled → const InvoiceStatus

The invoice is scheduled to be processed. On the scheduled date, Square sends the invoice, initiates an automatic payment, or takes no action, depending on the delivery method and payment request settings. Square also sets the invoice status to the appropriate state: UNPAID, PAID, PARTIALLY_PAID, or PAYMENT_PENDING.

partiallyPaid → const InvoiceStatus

A partial payment is received for the invoice.

The customer paid the invoice in full.

partiallyRefunded → const InvoiceStatus

The invoice is paid (or partially paid) and some but not all the amount paid is refunded.

refunded → const InvoiceStatus

The full amount that the customer paid for the invoice is refunded.

canceled → const InvoiceStatus

The invoice is canceled. Square no longer requests payments from the customer. The public_url page remains and is accessible, but it displays the invoice as canceled and does not accept payment.

failed → const InvoiceStatus

Square canceled the invoice due to suspicious activity.

paymentPending → const InvoiceStatus

A payment on the invoice was initiated but has not yet been processed.

When in this state, invoices cannot be updated and other payments cannot be initiated.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<InvoiceStatus>
A constant List of the values in this enum, in order of their declaration.