Page Comparison

Page Properties

id	api_docs_tax_quotes

Name	Tax Quotes / Create
Description	Calculate the tax to be charged on a purchase from Ticket Evolution
Type	POST
URL	/v9/tax_quotes
Credential Type	API\|User

Purpose

This endpoint allows buyers to accurately calculate the tax to be collected on a purchase from Ticket Evolution. Calling this service is the first of two steps to ensure an Order associated with a Ticket Group has the correct tax to be collected; the second is creating the Order itself after the tax quote has been generated passing tax_signature alongside the payload (see Orders / Create for instructions on the second step).

Info

IMPORTANT: The Tax Quote endpoint is set up as a convenience to you to determine how much tax Ticket Evolution will charge you if this order is created. Ticket Evolution will charge you tax during the order creation even if you choose not to pre-calculate using this endpoint as part of your checkout flow.

If you feel you are exempt from tax collection and can provide an exemption certificate, please get in touch.

Parameters

Name	Description	Type	Required
`ticket_group_id`	ID of the ticket group for which a tax quote is required.	Integer	Required
`quantity`	Number of tickets being purchased.	Integer	Required
`payment_type`	The `payment_type` to be used on the wholesale portion of the order. If the wholesale portion will be paid via `credit_card` instead of `evopay` it is important that it is included in your Tax Quote because the credit card service fee may be taxable and if this is indicated in the tax quote the response will include the `service_fee` that will be added and the tax amount will be accurate.	String	Optional
`retail`	An object containing values for the retail sale portion of a Buy/Sell Order. If included, a `retail` object will be included in the response with tax data for the the retail portion of the order.	Object	Optional

Retail Object

If included in the request, a retail object will be included in the response with tax data for the the retail sale portion of a Buy/Sell order.

Name	Description	Type	Required
`price`	The price per ticket the retail customer is being charged.	Float	Yes
`shipping`	The amount the retail customer is being charged for shipping.	Float	No
`service_fee`	The amount the retail customer is being charged for a service fee.	Float	No
`additional_expense`	The amount the retail customer is being charged for additional expense.	Float	No
`discount`	The amount being discounted for the retail customer.	Float	No

Response

The response to a successful request will be a tax quote for the given Ticket group, alongside a signature that will be required in further calls to the Create Order endpoint to include the tax.

Attribute	Always present?	Data type	Description
`ticket_group_id`	Yes	integer	The `ticket_group_id` provided in the request
`quantity`	Yes	integer	The `quantity` provided in the request
`tax_signature`	Yes	string	Unique identifier for this tax quote. This should be passed as `tax_signature` when creating orders.
`wholesale.price`	Yes	float	The `wholesale_price` for the tickets in the `ticket_group` as calculated by TEvo.
`wholesale.subtotal`	Yes	float	The subtotal for the wholesale order
`wholesale.tax`	Yes	float	Amount of tax to be collected on the wholesale portion of the purchase.
`wholesale.total`	Yes	float	Final price after tax has been applied.
`retail`	No	object	The `retail` object will only be returned if a `retail` object was included in the request.
`retail.price`	Yes, if `retail` is included	float	The retail price of the tickets provided in the request
`retail.shipping`	Only if present in original request	float	The shipping amount if provided in the request
`retail.service_fee`	Only if present in original request	float	The service_fee if provided in the request
`retail.additional_expense`	Only if present in original request	float	The additional_expense if provided in the request
`retail.discount`	Only if present in original request	float	The discount if provided in the request
`retail.subtotal`	Yes, if `retail` is included	float	The subtotal of the retail portion of the purchase
`retail.tax`	Yes, if `retail` is included	float	The amount of tax that should be charged on the the retail portion of the purchase
`retail.total`	Yes, if `retail` is included	float	The summed total of values for the retail portion of the request

Examples

Request

Response

POST /v9/tax_quotes

Wholesale Only Request

Code Block

language	json

{
  "ticket_group_id": 6,
  "quantity": 2,
  "payment_type": "credit_card"
}

Code Block

language	json

{
  "ticket_group_id": 6,
  "quantity": 2,
  "tax_signature": "9166e5ac-c663-4236-ae8b-76eb890a0468",
  "wholesale": {
    "price": 132.5,
    "subtotal": 265,
    "service_fee": 7.95,
    "tax": 23.5,
    "total": 296.45
  }
}

Wholesale and Retail Minimal Request

Code Block

language	json

{
  "ticket_group_id": 6,
  "quantity": 2,
  "retail": {
    "price": 160
  }
}

Code Block

language	json

{
  "ticket_group_id": 6,
  "quantity": 2,
  "tax_signature": "9166e5ac-c663-4236-ae8b-76eb890a0468",
  "wholesale": {
    "price": 132.5,
    "subtotal": 265,
    "service_fee": 0,
    "tax": 23.5,
    "total": 288.5
  },
  "retail": {
    "price": 160,
    "subtotal": 341,
    "tax": 28.16,
    "total": 369.16
  }
}

Wholesale and Retail Full Request

Code Block

language	json

{
  "ticket_group_id": 6,
  "quantity": 2,
  "retail": {
    "price": 160,
    "shipping": 15,
    "service_fee": 10,
    "additional_expense": 5,
    "discount": 9,
  }
}

Code Block

language	json

{
  "ticket_group_id": 6,
  "quantity": 2,
  "tax_signature": "9166e5ac-c663-4236-ae8b-76eb890a0468",
  "wholesale": {
    "price": 132.5,
    "subtotal": 265,
    "service_fee": 0,
    "tax": 23.5,
    "total": 288.5
  },
  "retail": {
    "price": 160,
    "shipping": 15,
    "service_fee": 10,
    "additional_expense": 5,
    "discount": 9,
    "subtotal": 341,
    "tax": 28.16,
    "total": 369.16
  }
}

...

As part of Orders Parameters, we’ll have a new field to pass over the signature associated with a tax_quote:

...

Parameter

...

Description

...

Type

...

Presence

...

Other

...

tax_signature

...

Unique identifier

...

String

...

Optional

...

Versions Compared

Old Version 14

New Version Current

Key

Purpose

Parameters

Retail Object

Response

Examples