b964b5439c2548a489

Unique internal identifier for the adjustment. Equivalent to line_item_uuid in the deprecated Invoices export.

varchar(32)

123122E

Account code being charged for this invoice.

varchar(50)

1fed8d153fcf4ea2a1

Subscription UUID associated with this adjustment on the invoice.

varchar(32)

4bdb2171cebe4ecf

Unique internal identifier for the invoice. This is called the 'id' in the Invoices - Summary export or 'uuid' for the invoice in the API.

varchar(32)

invoiced or pending

Current status of the adjustment. Pending adjustments are charges or credits on an account that have not been applied to an invoice yet. Invoiced adjustments will always have an invoice associated with them.

string

charge or credit

Charges are positive adjustments that debit the account. Credits are negative adjustments that credit the account.

varchar(10)

2012-02-19 12:01:33 PST

Creation date of the adjustment. This date will equal the billed_date of the invoice in most cases, but will be older than the billed_date if the adjustment was created on the account a period of time before it was invoiced. The adjustment_created_at date will never be after the invoice's billed_date.

timestamp

2012-02-19 12:01:33 PST

Bill cycle start date for a specific adjustment. Equivalent to line_item_start_date in the deprecated Invoices export.

timestamp

2012-02-19 12:01:33 PST

Bill cycle end date for a specific adjustment. Equivalent to line_item_end_date in the deprecated Invoices.

timestamp

Gold Plan

Description for a specific adjustment. This is automatically generated for all plan adjustments. This is custom for one-time custom charges and credits. Equivalent to line_item_description in the deprecated Invoices export

varchar(255)

1

Quantity of the adjustment.

numeric

USD

Currency of the adjustment.

varchar(3)

100

Adjustment amount, before discounts or taxes.

numeric

50

The total amount of the adjustment after discounts and taxes [(quantity x price) + discount + tax]. Equivalent to line_item_total in the deprecated Invoices.

numeric

0 or 1

0 indicates adjustment is not taxable, 1 indicates adjustment is taxable.

boolean

5

The discount applied to the adjustment.

numeric

5

The tax amount for the adjustment.

numeric

X100

Internal accounting code for a specific adjustment. This value will only populate if you define an accounting code for the adjustment. Accounting codes can be defined for all adjustments except free trials, which will inherit the plan's accounting code. Equivalent to line_item_accounting_code in the deprecated Invoices export.

varchar(25)

gold

Product code for a specific adjustment. This will populate automatically with the plan code or add-on code if the adjustment is for a subscription. This will populate for custom charges and credits (origin = debit or one_time) if a value was set when the adjustment was created. Equivalent to line_item_product_code in the deprecated Invoices export.

varchar(50)

P0000000, physical

Tax code is a field associated with the adjustment that we send to Avalara for tax calculations. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own Avalara AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.

varchar(50)

plan, plan_trial, setup_fee, add_on, add_on_trial, usage_add_on, usage_add_on_trial, one_time, debit, credit, coupon, carryforward, gift_card, external_gift_card

The original source for an adjustment. A credit created from an original charge will have the value of the charge's origin. Equivalent to line_item_origin in the deprecated Invoices export. (plan = subscription fee, plan_trial = trial period 0 amount charge, setup_fee = subscription setup fee, add_on = subscription add-on fee, debit = custom charge through the UI or Adjustments API, one_time = custom charge through the Transactions API, credit = custom credit, carryforward = the charge that zeros out a negative invoice and should be ignored)

varchar(20)

usst, vat, ca, au, nz

Tax type for the adjustment. Will be "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

The tax region for the adjustment. 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.09

Tax rate applied to the adjustment.

numeric

5

The tax amount for the adjustment. This column is the same as the adjustment_tax column, but tax_amount may be missing a few values for merchants who have used Recurly's older VAT feature (pre-2015). Merchants who used the old VAT feature should use the adjustment_tax column for older reports.

numeric

country_juris*

united states

Country tax jurisdiction of the adjustment. This will be the full name of the country in lowercase.

string

country_rate*

0

Country tax rate of the adjustment. This is the tax rate that corresponds to the country_juris and country_amount.

numeric

country_amount*

0

Country tax amount of the adjustment. This is the tax amount that corresponds to country_rate and country_juris.

numeric

state_juris*

california, ontario

State or province tax jurisdiction of the adjustment. This will be the full name of the state or province in lowercase.

string

state_rate*

0.065

State or province tax rate of the adjustment. This is the tax rate that corresponds to the state_juris and state_amount.

numeric

state_amount*

0.33

State or province tax amount of the adjustment. This is the tax amount that corresponds to state_rate and state_juris.

numeric

county_juris*

san mateo

County tax jurisdiction of the adjustment. This will be the full name of the county in lowercase.

string

county_rate*

0.01

County tax rate of the adjustment. This is the tax rate that corresponds to the county_juris and county_amount.

numeric

county_amount*

0.05

County tax amount of the adjustment. This is the tax amount that corresponds to county_rate and county_juris.

numeric

city_juris*

san francisco

City tax jurisdiction of the adjustment. This will be the full name of the city in lowercase.

string

city_rate*

0.1

City tax rate of the adjustment. This is the tax rate that corresponds to the city_juris and city_amount.

numeric

city_amount*

0.05

City tax amount of the adjustment. This is the tax amount that corresponds to city_rate and city_juris.

numeric

special_juris*

san francisco

Special tax jurisdiction of the adjustment. This will be the full name of the jurisdiction in lowercase.

string

special_rate*

0.1

Special jurisdiction tax rate of the adjustment. This is the tax rate that corresponds to the special_juris and special_amount.

numeric

special_amount*

0.05

Special jurisdiction tax amount of the adjustment. This is the tax amount that corresponds to special_rate and special_juris.

numeric

TRUE, FALSE

TRUE indicates that the adjustment is a refund of a charge. FALSE indicates that the adjustment was a standard charge.

boolean

b964b5439c2548a

Value is the uuid of the previous related adjustment. Will only have a value if the adjustment is a credit created from a previous credit, or if the credit was created from a charge refund.

varchar(32)

1291

Invoice number of the invoice the adjustment was on.

string

pending

Current state of the invoice the adjustment was on. Equivalent to invoice_status in the Invoices - Summary export.

varchar(20)

1monthfree-K09SC9R8

The coupon code that discounted the specific adjustment_discount amount on the adjustment.

string

2012-02-19 12:01:33 PST

Creation date of the invoice. Equivalent to date in the deprecated Invoices export.

timestamp

2012-02-19 12:01:33 PST

Date invoice was paid or failed.

timestamp

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.

numeric

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)

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. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.

string

purchase or 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'.

string

JJ Smith

First and last name from account.

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.

varchar(2)

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)

basic

The plan code for the plan associated with the subscription. This value will exist for plan fee, setup fee, add-on fee and free trial adjustments. This value will not exist for custom charges, custom credits, or open amount refund credits.

varchar(50)

1002

If the row is an adjustment on a refund invoice, this value will exist and show the invoice number of the purchase invoice the refund was created from.

string

2012-02-19 12:01:33 PST

The due date of the invoice.

timestamp

50.25

The adjustment amount after discounts, but before taxes.

numeric

general, service, promotional, refund, write_off, gift_card

The credit reason code of the adjustment. This is a new attribute with Recurly defined values the merchant can choose from when creating custom credits, or Recurly will set when issuing credits.
This column will be null until Recurly's Credit Invoices feature is enabled on your Recurly site.

string

50.25

The refundable amount of the charge adjustment, which is the adjustment total, including discounts and tax, minus all credit adjustments issued against it.
This column will be null until Recurly's Credit Invoices feature is enabled on your Recurly site.

numeric

Jane Doe

The first and last name associated with the shipping address for the adjustment.

string

123 Main Street

The first address line associated with the shipping address for the adjustment

string

Suite #202

The second address line associated with the shipping address for the adjustment

string

San Francisco

The city associated with the shipping address for the adjustment.

string

CA

The state associated with the shipping address for the adjustment.

string

94110

The zip code associated with the shipping address for the adjustment

string

US

The country ISO code associated with the shipping address for the adjustment

string

510-100-1000

The phone number associated with the shipping address for the adjustment

string

usps-overnight

The Shipping Method code used when the Shipping Method was created.

varchar(50)

item123

The Item Code maps to the user-specified unique ID of the item that was sold on this adjustment.

Reference this page for more on items.

varchar(50)

12345678998

The Item ID maps to the system-generated unique ID of the item that was sold on this adjustment.

string

abc123

The External SKU mapps to the user-specified SKU of the item that was sold on this adjustment.

varchar(50)

true

Indicates whether the purchase was inclusive or exclusive of tax.

boolean

2345678

Business entity code.

string

adjustment_api_id

e28zov4fw0v2

Adjustment API ID

string