Invoice

What your customer owes on the invoice in all, before payments. Integer minor units (cents for USD).

How much has been paid. An invoice Stripe has settled counts as paid in full, including any part Stripe took from the customer's Stripe balance (no payment is recorded for that part). Integer minor units (cents for USD).

What's still to pay: invoiceTotal less amountPaid, never below 0, and 0 for a voided invoice. Integer minor units (cents for USD).

The contact the invoice is addressed to (con_…), the first of the order's billing contacts; null when the order names none or the invoice has no order.

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

What's been refunded on the invoice, through credit notes (Create a credit note, or refunds made in Stripe). Integer minor units (cents for USD).

Three-letter ISO 4217 code, upper case.

The customer billed.

The invoice number your customer sees. For an invoice Spondo Billing made, INV- and a number counting up from INV-1001, one more than the highest number Spondo Billing has given so far (Stripe's invoice numbers don't count). For an invoice Stripe issued, Stripe's invoice number.

A page where your customer can dispute the invoice, when there is one.

When payment is due. For an invoice Spondo Billing posts, it's set on posting: the order's payment terms counted from that moment (14 days when the order sets none). Null when the invoice is collected automatically with no due date.

End of the billing period, exclusive (the next period's start).

The invoice's ID.

The total including tax. Integer minor units (cents for USD).

The total before tax. Integer minor units (cents for USD).

When the invoice was issued.

Your own key-value data, set with Update an invoice; null when unset.

The order this invoice bills, or null for an invoice raised outside an order.

Where your customer can see and pay the invoice: Stripe's hosted invoice page when Stripe collects it; otherwise, once it's posted, its hosted page, https://billing.getspondo.com/public/invoices/{publicUrlToken}, which shows your customer's bank transfer details when they have funding instructions. Null for a draft or voided invoice that Stripe doesn't collect.

How much of the invoice is paid. pending: nothing paid yet and not past its due date. partiallyPaid: some paid. paid: paid in full. overdue: posted, not paid in full and past its due date (this wins over partiallyPaid). A posted credit invoice (a total of zero or less) owes nothing, so it's paid, never overdue. error: collecting payment failed in a way that needs your attention.

When the invoice was posted; null until then.

The token in the address of the invoice's hosted page, https://billing.getspondo.com/public/invoices/{publicUrlToken}: a printable page your customer can open without signing in. Set when the invoice is posted; null for a draft, and usually for an invoice Stripe issued, which has Stripe's page instead.

Your customer's purchase order reference, set with Update an invoice.

order_based when the invoice bills an order; manual otherwise.

Start of the billing period, inclusive.

Where the invoice is in its life. building: being assembled for its period, and its lines can still change. draft: assembled and waiting to be posted; your customer hasn't been sent it and it can't be paid. pending: being posted. posted: issued to your customer; it can be paid, and payments can be allocated to its lines (it stays posted once paid: see paymentStatus). voided: cancelled after posting, so nothing is owed. canceled: discarded before it was posted. error: something stopped it being built or posted.

Tax on the invoice; negative on an invoice that credits more than it charges, which gives its tax back too. Integer minor units (cents for USD).

Whether the customer is exempt from tax.

Tax as a fraction of the total excluding tax, to 4 decimal places (0.08 is 8%); 0 when there is no tax.

calculated when a draft invoice carries tax, which can still change; committed once an invoice that carries tax is posted, and its tax is final; not_applicable when it carries none.

When the invoice last changed.