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_quote_signature
alongside the payload (see Orders / Create for instructions on the second step).
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 |
---|---|---|---|
| ID of the ticket group for which a tax quote is required. | Integer | Required |
| Number of tickets being purchased. | Integer | Required |
| The | String | Optional |
| An object containing values for the retail sale portion of a Buy/Sell Order. If included, a | 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 |
---|---|---|---|
| The price per ticket the retail customer is being charged. | Float | Yes |
| The amount the retail customer is being charged for shipping. | Float | No |
| The amount the retail customer is being charged for a service fee. | Float | No |
| The amount the retail customer is being charged for additional expense. | Float | No |
| 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 |
---|---|---|---|
| Yes | integer | The |
| Yes | integer | The |
| Yes | string | Unique identifier for this tax quote. This should be passed as |
| Yes | float | The |
| Yes | float | The subtotal for the wholesale order |
| Yes | float | Amount of tax to be collected on the wholesale portion of the purchase. |
| Yes | float | Final price after tax has been applied. |
| No | object | The |
| Yes, if | float | The retail price of the tickets provided in the request |
| Only if present in original request | float | The shipping amount if provided in the request |
| Only if present in original request | float | The service_fee if provided in the request |
| Only if present in original request | float | The additional_expense if provided in the request |
| Only if present in original request | float | The discount if provided in the request |
| Yes, if | float | The subtotal of the retail portion of the purchase |
| Yes, if | float | The amount of tax that should be charged on the the retail portion of the purchase |
| Yes, if | float | The summed total of values for the retail portion of the request |
Examples
Request | Response |
---|---|
| |
Wholesale Only Request { "ticket_group_id": 6, "quantity": 2, "payment_type": "credit_card" } | { "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 { "ticket_group_id": 6, "quantity": 2, "retail": { "price": 160 } } | { "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 { "ticket_group_id": 6, "quantity": 2, "retail": { "price": 160, "shipping": 15, "service_fee": 10, "additional_expense": 5, "discount": 9, } } | { "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 } } |
Pending POST Order addition:
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 |
---|---|---|---|---|
| Unique identifier | String | Optional |
The POST orders payload already has a tax
attribute, which is not changing. This value represents the tax a Buyer charges their Client, and is only used for record keeping. It is completely independent from the tax TEvo will charge the Buyer.