What are all of the potential invoice statuses?

Production Billing's Avatar

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

    Marc Guyer's Avatar

    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
  2. 2 Posted by Production Bill... on May 18, 2012 @ 09:15 PM

    Production Billing's Avatar

    What about voided or refunded?

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

    Marc Guyer's Avatar

    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.

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

Discussions are closed to public comments.
If you need help with Cheddar please start a new discussion.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac