What data is in the Invoices - Summary export?

The invoice summary export contains the invoice header information and the summary totals for each of your invoices.

 

Invoice Status Filter

 

ALL

Every invoice generated within your Recurly site, regardless of status.

 

OPEN

All invoices that have not received a payment attempt. This status has a value of 'pending' in the export and does not include invoice with a 'past_due' status. This status only exists for manual invoices. If you see this status for an automatically collected invoice, it may mean that the payment attempt had a transaction communication error.

 

PROCESSING

All invoices that have an ACH bank payment in process. This status will only exist for ACH bank payments. The status means the associated payment transaction has not settled. An ACH invoice with the Processing status that reaches the due date will not move to Past Due or Paid until the transaction has settled.

 

CLOSED

All successfully collected invoices. This status has a value of 'paid' in the export and does not include the 'failed' status. It is important to note that the associated credit card, PayPal, or Amazon transaction with a paid invoice may not be settled with the gateway. Allow at least 1 to 3 business days for transaction settlement with the gateway.

 

PAST DUE

All automatic invoices that attempted collection, but payment failed, or manual invoices that have reached their due date. Payment for automatic invoices will be retried automatically through the dunning process.

 

FAILED

All invoices that have either experienced 20 declines, or have been through the dunning process without successful payment. These invoices will not be retried. It is important to note that failed invoices will clear the owed balance from the account and will not attempt any future collections, but the charge line items will still exist in the account history.

 

VOIDED

All credit invoices that have been voided. These invoices will not be retried. It is important to note that voided invoices will clear the owed balance from the account and will not attempt any future collections, but the credit line items will still exist in the account history.

 

Time Range Filter

 

CREATED

Sets the date range to the date the invoice was created, which is the 'billed_date' column in the export.

 

MODIFIED

Sets the date range to the last date the invoice was modified, which is the 'modified_at' column in the export. An invoice is only modified when its 'status' changes.

 
Export Contents
 
 
Column Name Example Description
id

b964b5439c2548a489b3a136e75aee9f

Unique internal identifier for the invoice. This is also called the 'invoice_id' or 'uuid' for the invoice in the API.

 
invoice_number

b964b5439c2548a489b3a136e75aee9f

External invoice identifier.
billed_date 2012-02-19 12:01:33 PST Creation date of the invoice. Equivalent to date in the deprecated Invoices export. Used for Created date range filter.
due_on 2012-02-19 12:01:33 PST Date invoice is due. This is the date the net terms is reached.
closed_at 2012-02-19 12:01:33 PST Date invoice was closed (paid) or failed.
status pending, processing, past_due, paid, failed, voided Current status of the invoice. Equivalent to invoice_state in the Adjustments export. See filter notes above for details on what each status means.
net_terms on-receipt, net-10, net-30, net-60 Identifies the net_terms agreement associated with the invoice. All automatic collection invoices are due 'on-receipt'. Manual collection invoices can have terms of net-10, net-30, net-60, or a custom net day amount.
collection_method automatic or manual Identifies whether the invoice fees are collected via manual or automatic invoicing. An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction.
account_code 123122E Account code being charged for this invoice.
account_name JJ Smith First and last name from account associated with that invoice.
account_company Company, Inc. Company name from account. This field is from the Account Info and is displayed on the invoice if it exists.
account_line1 1 Main Street Address line 1 of the customer's address on the invoice. This will come from the Billing Address or the Account Address depending on your tax settings and the invoice collection method.
account_line2 Suite 100 Address line 2 of the customer's address on the invoice. This will come from the Billing Address or the Account Address depending on your tax settings and the invoice collection method.
account_city Seattle City of the customer's address on the invoice. This will come from the Billing Address or the Account Address depending on your tax settings and the invoice collection method.
account_state WA State or province of the customer's address on the invoice. This will come from the Billing Address or the Account Address depending on your tax settings and the invoice collection method.
account_zip 32323 ZIP/postal code of the customer's address on the invoice. This will come from the Billing Address or the Account Address depending on your tax settings and the invoice collection method.
account_country USA The 2 letter country code for the country of the customer's address on the invoice. This will come from the Billing Address or the Account Address depending on your tax settings and the invoice collection method.
vat_number IE124211145 VAT registration number for the customer on the invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
po_number AE12523 For manual invoicing, this identifies the Purchase Order number associated with the invoice. This value must be entered by the merchant at the time the invoice is created or it will not exist.
coupon_code 50off The code for the coupon associated with any discounts on the invoice. This value will only exist if a coupon was applied to the invoice.
currency USD The currency of the amounts on the invoice. We do not allow mixed currency invoices.
invoice_total 100.00 The final total on the invoice. The summation of invoice charges, discounts, credits, and tax. Equivalent to the total in the deprecated Invoices export
invoice_subtotal 50.00 The Subtotal on the invoice. The summation of charges, discounts, and credits, before tax.
tax_amount 15.00 The total tax amount on the invoice.
     
tax_type usst, vat, ca, au, nz Provides the tax type as "vat" for EU VAT, "usst" for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
tax_region  NY, FR, GST, VAT  Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
tax_rate 0.1 Tax rate applied on the invoice.
credit_to_account 0 Amount of credit applied back to the account. This amount is a charge with adjustment_origin of 'carryforward' on the invoice. This charge is what zeros out the invoice and should be filtered out of your reports. Credit to Account also maps to the uninvoiced credit that is created for the same amount and left on the account for payment of a future invoice. That credit will have an adjustment_origin that matches the original charge's origin.
recovery_reason exp_date, retry, account_updater, prior_recovery, customer_updates If the initial transaction failed but a subsequent one succeeded, this field indicates why. See the details of what each reason means in our blog "Revenue Recovery: What Has Recurly Recovered for Me Lately?".
invoice_country FR This column is only visible if your site has European Union VAT or New Zealand GST Location Validation enabled. Column shows the EU or NZ country code of the customer's address on the invoice. The country refers to the evidence_matched.
evidence_matched Account Info Country, Billing Info Country, IP Address Country, Credit Card BIN Country This column is only visible if your site has European Union VAT or New Zealand GST Location Validation enabled. Column shows the two pieces of evidence that matched when the invoice was created. The corresponding country is the invoice_country.
modified_at 2014-12-26 08:23:34 PST The date the invoice was last modified. An invoice is only modified if the status changes. Used for Modified date range filter.
invoice_type  purchase, refund The original invoice will have a type of 'purchase'. Any refunds or voids will create a negative invoice to cancel out the original. This negative invoice will have a type of 'refund'.
original_invoice_number 111 If the row is a refund invoice, this value will exist and show the invoice number of the purchase invoice the refund was created from.
ship_address_name Julie Smith The first and last name associated with the shipping address
ship_address_line1 ship_address_line1 ship_address_line1
ship_address_line2 Apt 1 The second line of the street address for the shipping address
ship_address_city Lansing The city for the shipping address
ship_address_state MI The state for the shipping address
ship_address_zip 48311 The zip or postal code for the shipping address
ship_address_country US The country for the shipping address
ship_address_phone 248-555-1212 The phone number associated with the shipping address
invoice_doc_type legacy, charge, credit This is the invoice type. All invoices created before Credit Invoices is enabled will have a type of ‘legacy’. Once Credit Invoices is enabled, new invoices will be either ‘charge’ or ‘credit’.
invoice_balance 50.25 The balance of the invoice.
This column will be null until Recurly's Credit Invoices feature is enabled on your Recurly site.
invoice_balance_modified_at 2016-01-01 10:17:02 UTC The datetime the invoice_balance last changed due to a transaction or credit payment.
This column will be null until Recurly's Credit Invoices feature is enabled on your Recurly site.
invoice_discount 10 The total of all discounts on the invoice. This is the sum of each adjustment’s discount.
invoice_subtotal_before_discounts 50.25 The total of all adjustments on the invoice, before discounts and taxes.
invoice_refundable_amount 50.25 The refundable amount of the invoice, which is the invoice total, including discounts and tax, minus all credit invoices issued against it.
This column will be null until Recurly's Credit Invoices feature is enabled on your Recurly site.