Home → Questions →

What are all of the potential invoice statuses?

• Edit

Production Billing

May 18, 2012 @ 09:02 PM

We want to display invoices' status on our web site with a different visual treatment for each. Can you indicate what all of the potential statuses are?

1. Support Staff 1 Posted by Marc Guyer on May 18, 2012 @ 09:13 PM

   

   We don't have any defined statuses but here's the breakdown:

   • pending/current: a future scheduled invoice (billingDatetime < now) - there's only one of these at a time per subscription.
   • settled: has a paid transaction - indicated by a value in the paidTransactionId node.
   • outstanding: billingDatetime < now and does not have a paid transaction

   There are also three types of invoices:

   • setup - you don't have any setup fees so you wont see any of these
   • subscription - this is a normal recurring type invoice
   • one-time - you'll only see these if you execute this special type
   • Edit

2. 2 Posted by Production Bill... on May 18, 2012 @ 09:15 PM

   

   What about voided or refunded?

   • Edit

3. Support Staff 3 Posted by Marc Guyer on May 18, 2012 @ 09:41 PM

   

   Ah right. Again, those are determined heuristically:

   • voided: The invoice's paid transaction corresponding to the paidTransactionId has a response value of voided
   • refunded: the sum of the amounts of transactions with parentTransactionId == paidTransactionId and the amount of the transaction corresponding to paidTransactionId is equal to zero
   • partially-refunded: like refunded but sum > 0

   BTW, none of these are considered to be "outstanding". They are still considered "settled" when determining whether or not the the customer owes for the invoice.

   • Edit

4. Dean closed this discussion on Jan 22, 2013 @ 10:42 PM.