Taxes schema

You can see information about the taxes applied to sales, including tax totals, tax rates, and details about the order that each tax payment is attributed to.

Using SINCE and UNTIL will filter your taxes data by the date that a sale or return was made. A query that filters with SINCE -1m UNTIL today will show all sales and returns that were made in the last month.

Example taxes query - taxes collected in last 7 days

  1. SHOW taxes
  2. BY tax_name, tax_rate
  3. FROM taxes
  4. SINCE -7d
  5. UNTIL today

Tax properties

The following properties show information about the tax applied to sales:

Properties Type Description
Aggregate properties - used in the SHOW clause
taxes price The sum of tax_amount.
Non-aggregate properties - used in the BY clause
tax_amount price The monetary value of tax.
tax_country string The country of the tax rate.
tax_name string The name of the tax rate, for example NY State Tax
.
tax_rate string The tax rate percentage.
tax_city string The city of the tax rate.
tax_region string The state or province of the tax rate.

Product properties

The following properties show information about the product in a sale that tax is attributed to:

Properties Type Description
Non-aggregate properties - used in the BY clause
product_title string The title of the product.
product_vendor string The vendor of the product.
product_type string The product’s type
product_id number The unique numeric identifier for the product.
product_price price The price of the product variant.
variant_title string The title of the product variant.
variant_sku string The SKU of the product variant.
variant_id number The unique numeric identifier for the product variant.

Customer properties

The following properties show billing and shipping information for a sale:

Properties Type Description
Non-aggregate properties - used in the BY clause
customer_email string The email address entered by the customer.
customer_name string The first and last names entered by the customer.
customer_id number The unique numeric identifier for the customer.
customer_type string Shows First-time if this is the customer’s first order, and Returning if this is not the customer’s first order.
billing_country string The country from the customer’s billing address.
billing_region string The state or province from the customer’s billing address.
billing_company string The company from the customer’s billing address.
billing_city string The city from the customer’s billing address.
shipping_region string The state or province from the customer’s shipping address.
shipping_city string The city from the customer’s shipping address.
shipping_country string The country from the customer’s billing address.

Sales channel properties

The following properties show information about the sales channel that a sale was made through:

Properties Type Description
Non-aggregate properties - used in the BY clause
channel_provider_name string The sales channel that the order was placed through.
pos_location_name string The name of the point of sale location where the sale was made.
## Employee properties If a payment was from a POS sale or a draft order, then the following property shows information about the employee who made the sale:
Properties Type Description
Non-aggregate properties - used in the BY clause
employee_id number The unique numeric identifier for the employee who created the order.
employee_name string The name of the employee who created the order.
## Time properties The following properties show information about the date and time that a sale was made:
Properties Type Description
Non-aggregate properties - used in the BY or OVER clause
year year The year of a sales transaction.
month month The month of a sales transaction.
week week The week of a sales transaction.
day day The day of a sales transaction.
hour hour The hour of a sales transaction.