b964b5439c2548a489b3a136e75aee9f

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

varchar(32)

1291

External invoice identifier.

string

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.

timestamp

2012-02-19 12:01:33 PST

Date invoice is due. This is the date the net terms is reached.

timestamp

2012-02-19 12:01:33 PST

Date invoice was closed (paid) or failed.

timestamp

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.

varchar(20)

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.

string

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.

string

123122E

Account code being charged for this invoice.

varchar(50)

JJ Smith

First and last name from account associated with that invoice.

string

Company, Inc.

Company name from account. This field is from the Account Info and is displayed on the invoice if it exists.

varchar(225)

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.

string

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.

string

San Francisco

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.

string

CA

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.

string

94107

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.

string

US

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.

string

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.

varchar(20)

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.

varchar(50)

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.

string

USD

The currency of the amounts on the invoice. We do not allow mixed currency invoices.

varchar(3)

100

The final total on the invoice. The summation of invoice charges, discounts, credits, and tax. Equivalent to the total in the deprecated Invoices export.

numeric

50

The Subtotal on the invoice. The summation of charges, discounts, and credits, before tax.

numeric

15.00

The total tax amount on the invoice.

numeric

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.

varchar(6)

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.

varchar(15)

0.1

Tax rate applied on the invoice.

numeric

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.

numeric

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?".

varchar

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.

varchar(2)

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.

string

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.

timestamp

purchase, refund, renewal, immediate_change, termination, credit, gift_card, write_off, external_refund, carryforward_credit, carryforward_gift_credit, usage_correction, import

This 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

1002

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.

string

Julie Smith

The first and last name associated with the shipping address

string

ship_address_line1

ship_address_line1

string

Apt 1

The second line of the street address for the shipping address

string

West Bloomfield

The city for the shipping address

string

MI

The state for the shipping address

string

48322

The zip or postal code for the shipping address

string

US

The country for the shipping address

string

248-555-1212

The phone number associated with the shipping address

string

legacy, charge, credit

This 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

50.25

The balance of the invoice. This column will be null until Recurly's Credit Invoices feature is enabled on your Recurly site.

numeric

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.

timestamp

50.25

Total of all discounts on the invoice.

numeric

50.25

The total of all adjustments on the invoice, before discounts and taxes.

numeric

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.

numeric

1

Number of shipping addresses if multiple shipping addresses per invoice is enabled.

numeric

12345678

Dunning Campaign Code.

varchar(50)

23456789

Dunning Campaign ID.

string

1234

Dunning Campaign Version.

string

TRUE

TRUE/FALSE boolean column indicating whether the invoice has used Recurly tax services.

boolean

123456789

Business Entity Code.

string

123122E

Parent account code being charged for this invoice.

varchar(50)

invoice_api_id

e28zov4fw0v2

Invoice API ID

string