- Invoices — summary

- Invoices — summary

Discover your Recurly invoice data effortlessly with the Invoices - External export feature.

Overview

Required plan

This feature or setting is available to all customers on any Recurly subscription plan.

Definition

The Invoices Summary export provides a detailed report for every invoice. This data gives you a deeper understanding of every invoice to help you manage your invoices better.

Filters

Invoice Status Filter

This filter allows you to select invoices based on their current statuses which include:
-All: All invoices including credit and charge.
-Charge: Only charge invoices.
-Credit: Only credit invoices.

Date Range Filters

Created

Involves invoices created within a chosen time span.

Modified

Entails invoices modified in a selected time range.

Exports table

Download Button Download our complete export schema

To help you identify and organize information effectively, the export provides a structured table that contains the following columns:

Column NameExampleDescriptionData type (max size)
idb964b5439c2548a489b3a136e75aee9fUnique internal identifier for the invoice. This is also called the 'invoice_id' or 'uuid' for the invoice in the API.varchar(32)
invoice_number1291External invoice identifier.string
billed_date2012-02-19 12:01:33 PSTCreation date of the invoice. Equivalent to date in the deprecated Invoices export. Used for Created date range filter.timestamp
due_on2012-02-19 12:01:33 PSTDate invoice is due. This is the date the net terms is reached.timestamp
closed_at2012-02-19 12:01:33 PSTDate invoice was closed (paid) or failed.timestamp
statuspending, processing, past_due, paid, failed, voidedCurrent status of the invoice. Equivalent to invoice_state in the Adjustments export. See filter notes above for details on what each status means.varchar(20)
net_termson-receipt, net-10, net-30, net-60Identifies 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.string
collection_methodautomatic or manualIdentifies 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.string
account_code123122EAccount code being charged for this invoice.varchar(50)
account_nameJJ SmithFirst and last name from account associated with that invoice.string
account_companyCompany, Inc.Company name from account. This field is from the Account Info and is displayed on the invoice if it exists.varchar(225)
account_line11 Main StreetAddress 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.string
account_line2Suite 100Address 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.string
account_citySan FranciscoCity 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.string
account_stateCAState 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.string
account_zip94107ZIP/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.string
account_countryUSThe 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.string
vat_numberIE124211145VAT 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.varchar(20)
po_numberAE12523For 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.varchar(50)
coupon_code50offThe code for the coupon associated with any discounts on the invoice. This value will only exist if a coupon was applied to the invoice.string
currencyUSDThe currency of the amounts on the invoice. We do not allow mixed currency invoices.varchar(3)
invoice_total100The final total on the invoice. The summation of invoice charges, discounts, credits, and tax. Equivalent to the total in the deprecated Invoices export.numeric
invoice_subtotal50The Subtotal on the invoice. The summation of charges, discounts, and credits, before tax.numeric
tax_amount15.00The total tax amount on the invoice.numeric
tax_typeusst, vat, ca, au, nzProvides 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.varchar(6)
tax_regionNY, FR, GST, VATProvides 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.varchar(15)
tax_rate0.1Tax rate applied on the invoice.numeric
credit_to_account0Amount 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.numeric
recovery_reasonexp_date, retry, account_updater, prior_recovery, customer_updatesIf 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?".varchar
invoice_countryFRThis 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.varchar(2)
evidence_matchedAccount Info Country, Billing Info Country, IP Address Country, Credit Card BIN CountryThis 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.string
modified_at2014-12-26 08:23:34 PSTThe date the invoice was last modified. An invoice is only modified if the status changes. Used for Modified date range filter.timestamp
invoice_typepurchase, refund, renewal, immediate_change, termination, credit, gift_card, write_off, external_refund, carryforward_credit, carryforward_gift_credit, usage_correction, importThis is the invoice origin. 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'. All other invoice types are unlocked only when the Credit Invoices feature is enabled. See the full table of invoice origins for descriptions.string
original_invoice_number1002If the row is a refund invoice, this value will exist and show the invoice number of the purchase invoice the refund was created from.string
ship_address_nameJulie SmithThe first and last name associated with the shipping addressstring
ship_address_line1ship_address_line1ship_address_line1string
ship_address_line2Apt 1The second line of the street address for the shipping addressstring
ship_address_cityWest BloomfieldThe city for the shipping addressstring
ship_address_stateMIThe state for the shipping addressstring
ship_address_zip48322The zip or postal code for the shipping addressstring
ship_address_countryUSThe country for the shipping addressstring
ship_address_phone248-555-1212The phone number associated with the shipping addressstring
invoice_doc_typelegacy, charge, creditThis is the invoice document type. All invoices created before the Credit Invoices feature is enabled will have a type of ‘legacy’. Once Credit Invoices is enabled, new invoices will be either ‘charge’ or ‘credit’.string
invoice_balance50.25The balance of the invoice. This column will be null until Recurly's Credit Invoices feature is enabled on your Recurly site.numeric
invoice_balance_modified_at2016-01-01 10:17:02 UTCThe 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.timestamp
invoice_discount50.25The total of all adjustments on the invoice, before discounts and taxes.numeric
invoice_subtotal_before_discounts50.25The 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.numeric
invoice_refundable_amount50.25The refundable amount of the invoice.numeric
shipping_address_count1Number of shipping addresses if multiple shipping addresses per invoice is enabled.numeric
dunning_campaign_code12345678Dunning Campaign Code.varchar(50)
dunning_campaign_id23456789Dunning Campaign ID.string
dunning_campaign_version1234Dunning Campaign Version.string
used_tax_serviceTRUETRUE/FALSE boolean column indicating whether the invoice has used Recurly tax services.boolean
business_entity_code123456789Business Entity Code.string
parent_account_code123122EParent account code being charged for this invoice.varchar(50)

Version changelog

Version 5 - 12/12/23

  • Addition of parent_account_code column.

Version 4 - 5/15/23

  • Addition of business_entity_code column.

Version 3 - 3/21/23

  • Addition of used_tax_service column.

Version 2 - 6/23/21

  • Addition of dunning_campaign_code, dunning_campain_id and dunning_campaign version columns.