Enum InvoiceStatus

pub enum InvoiceStatus {
    Draft,
    Unpaid,
    Scheduled,
    PartiallyPaid,
    Paid,
    PartiallyRefunded,
    Refunded,
    Canceled,
    Failed,
    PaymentPending,
}

Indicates the status of an invoice.

Variants

Draft

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

The invoice is published but not yet paid.

Scheduled

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

A partial payment is received for the invoice.

Paid

The customer paid the invoice in full.

PartiallyRefunded

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

Refunded

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

Canceled

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

Square canceled the invoice due to suspicious activity.

PaymentPending

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.

Trait Implementations

impl Clone for InvoiceStatus

fn clone(&self) -> InvoiceStatus

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InvoiceStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InvoiceStatus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InvoiceStatus

fn eq(&self, other: &InvoiceStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InvoiceStatus

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InvoiceStatus

impl StructuralPartialEq for InvoiceStatus