Adjustments — taxes - export
Overview
Required plan
This feature or setting is available to all customers on any Recurly subscription plan.
Prerequisite
You must enable one of our tax integrations (Vertex, Avalara) to view this export. Please reach out to your Recurly account manager or [email protected] to have this feature activated in your account.
Definition
The Adjustments - Taxes export is designed for reporting on taxes calculated through Vertex. It is pertinent to note that for reporting on taxes calculated through Avalara, you should utilize the Adjustments export. This CSV file contains a row for each tax jurisdiction that is returned for a line item. Even line items without taxes will be included but as a single row in the export.
Filters
Versions Filter
- The Versions filter allows you to select the version that is most appropriate for your needs. This is based on the Version changelog at the bottom of this page.
Time Range Filter
This export showcases adjustments alongside their respective taxes created during a predefined time range. It is important to note that the creation date of an adjustment coincides with the invoice issuance date unless the adjustment was initiated on the account uninvoiced, awaiting processing in the upcoming billing event.
- The Time range filter (dropdown) allows you to view data within a specific period such as last month, year to date or a custom date range. The Start Date and End Date will automatically update based on the value selected in the Time range filter. You can also choose "Between..." in the dropdown, which will allow you to enter a customized date range.
Exports table
To help you identify and organize information effectively, the export provides a structured table that contains the following columns:
| Column Name | Example | Description | Data type (max size) |
|---|---|---|---|
| adjustment_uuid | 34a302b4ed87c4eebeee4942b98b932f | The unique id for the line item. | varchar(32) |
| account_code | 1234568 | The unique code for the account. | varchar(50) |
| subscription_id | 2f1f711a62b424391a690e4895a3f2a5 | The unique id for the subscription associated with the line item. | varchar(32) |
| invoice_id | 34a27fd20e668a389c064e43c183bcf1 | The unique id for the invoice. | varchar(32) |
| invoice_number | 1001 | The invoice number displayed on the invoice. | string |
| invoice_billed_date | 2016-08-03 16:26:26 UTC | The date the invoice was posted. | timestamp |
| invoice_state | pending, past_due, paid, failed, open, closed, voided, processing | The current state of the invoice. | varchar(32) |
| refund_tax_date | 2016-08-03 16:26:26 UTC | Date of the original purchase invoice if the invoice is a refund or subscription change. | timestamp |
| refund_geo_code | 123456789 | Not applicable for Vertex O Series or Vertex Cloud integrations. | string |
| adjustment_description | Gold Plan | The line item description on the invoice. | varchar(255) |
| adjustment_product_code | gold_plan | The plan code, add-on code, or one-off charge product code for the line item’s product. | varchar(50) |
| adjustment_currency | USD | The currency of the line item. | varchar(3) |
| adjustment_amount | 74.97 | Pre-discount, pre-tax amount of the line item. If negative, it reflects a credit from a downgrade or refund. | numeric |
| adjustment_discount | 49.99 | The discount amount on the line item. | numeric |
| adjustment_coupon_code | 5dollars_off | The coupon code applied to the line item for the discount. | string |
| tax_type | vat | The tax type represented in the row for the line item. | varchar(6) |
| jurisdiction | country, province, state, city, county, federal, district | The tax jurisdiction represented in the row for the line item. | string |
| jurisdiction_amount | 1.31 | The tax amount for the jurisdiction. | numeric |
| jurisdiction_rate | 0.01744 | The tax rate for the jurisdiction. | numeric |
| jurisdiction_description | Florida Communications Tax | The name of the imposition in the jurisdiction. | string |
| jurisdiction_name | france, united kingdom | The identifying name for the jurisdiction. | string |
| geo_code | 123456789 | Not applicable for Vertex O Series or Vertex Cloud integrations. | string |
| adjustment_tax_code | digital_product | The tax code of the product represented by the line item. Available from version 2. | string |
| classification | product_1 | string | |
| item_code | item123 | The user-specified unique ID of the sold item on this adjustment. More details on this page. | varchar(50) |
| item_id | 1234567890 | The system-generated unique ID of the sold item on this adjustment. | string |
| external_sku | abc123 | The user-specified SKU of the sold item on this adjustment. | varchar(50) |
| tax_region | US | Indicates the tax region. | string |
| tax_inclusive | true | Indicates whether the price includes tax. | boolean |
| business_entity_code | 123456789 | Indicates business entity code. | string |
| adjustment_api_id | e28zov4fw0v2 | Adjustment API ID | string |
Version changelog
Version 8 - Feb 5, 2025
- Addition of
adjustment_api_id.
Version 7 - May 15, 2023
- Update to export made 8/20/2024: Merchants integrated directly with Vertex will now see the corresponding geocode values passed from Vertex populated in the "geo_code" field within this export. The "geocode" identifier passed serves as a specific way to pinpoint the location/address that was used for tax calculation on the invoice. This field provides accurate reporting for tax to state and local tax authorities. This field is also queryable via V2/V3 API.
- Added business_entity_code column.
Version 6 - March 3, 2022
- Added tax_inclusive column.
Version 5 - August 11, 2021
- Added tax_region column.
Version 4 - February 13, 2020
- Added a column for external_sku pertaining to Item Charges.
Version 3 - November 21, 2019
- Added item_code and item_id columns for Item Charges.
Version 2 - September 20, 2018
- Added adjustment_tax_code column.
- Added classification column. (Conditional on Vertex tax integration)
Updated 7 months ago