Tax

V1

This representation is not public and is for internal use only.

The tax endpoints provide access to tax quotation & reporting.


Endpoints

Verb Endpoint Description
GET /v1/theatres/{theatre-number}/tax-groups/{tax-group-code}/taxes Returns a tax quote for a given theatre tax group. A sale-price query parameter is required.
GET /v1/theatres/{theatre-number}/products/{sku}/taxes Returns a tax quote for a given theatre product. If no sale-price is provided, the product retail price will be used.
GET /v1/products/{sku}/taxes Returns a tax quote for a given product, assuming the SKU can be used to determine the Theatre Number. If no sale-price is provided, the product retail price will be used.

Tax Route Values (Required)

  • You must supply a theatre-number route value when getting item quotes by SKU or Tax Group Code..
    • If an unknown or ill-formatted value is used, a 404 error is returned.
  • You must supply a tax-group-code route value when getting item quotes by Tax Group Code..
    • If an unknown or ill-formatted value is used, a 404 error is returned.
  • You must supply a sku route value when getting item quotes by SKU..
    • If an unknown or ill-formatted value is used, a 404 error is returned.
  • You must supply a order-id route value when getting order quotes or creating tax records.
    • If an unknown or ill-formatted value is used, a 404 error is returned.

Tax Query Parameters

  • You must supply a sale-price query string parameter to when calculating tax for a single item. The sale-price is the item cost to use when calculating tax..
    • If not provided when required, a 400 "Bad Request" response is returned.
  • You may optionally supply a tax-inclusive query string parameter to when calculating tax for a tax-inclusive item. Specifies whether taxes are to be included in the sale price (true) or if taxes are to be added to the sale price (false)..
    • If not provided, the default is false.
    • Options Include:
      • true
      • false
  • You may optionally supply a queue-option query string parameter to when creating a tax journal entry, denoting items sold or refunded in an order. The queue-option specifies whether or not, and how, to queue the entry for asynchronous processing. .
    • If not provided, the default is NeverQueue.
    • Options Include:
      • NeverQueue
      • QueueOnFailure
      • AlwaysQueue

Order Item Taxes Representation


Order Item Taxes Representation Properties

Name Description
TaxDate The date for which the taxes were calculated.
TaxableAmount The calculated taxable amount, according to tax rules.
TaxAmount The calculated tax amount, according to tax rules.
IsPriceTaxInclusive Indicates if the tax was calculated as price-inclusive.
TaxItems A list of order item tax representations.


Order Item Taxes Representation Links

Relation Description Methods Templated
self The current order item taxes representation. GET No

Order Item Tax Representation


Order Item Tax Representation Properties

Name Description
TaxCode The code corresponding to this specific tax rule
RateClassification Describes how the rate is classified, for filing purposes.
TaxStructure Describes how the tax is structured, such as flat or quantity-based fees.
CalculatedTaxAmount The amount of tax applied by this tax rule.
TaxableAmount The amount that is considered taxable under this rule.
NontaxableAmount The amount that is considered nontaxable under this rule.
PercentRate The percent rate, if any, used to calculate the tax amount.
IsApplied Indicates if this tax rule was applied (true) or not (false). The tax rule may ordinarily be applied, but is not for some reason (exemption, tax-free holidays, etc).


Examples

Get tax quote for tax group at theatre
GET  https://api.amctheatres.com/v1/theatres/904/tax-groups/20030/taxes?sale-price=15

Request Required Headers

X-AMC-Vendor-Key 7E3E178B-4C84-49E4-896E-A873B5E7F3E2
Content-Type application/json
Get tax quote for SKU at theatre
GET  https://api.amctheatres.com/v1/theatres/904/products/SUBSCRIPTION-NEW-904-ALISTTIER3/taxes?sale-price=15

Request Required Headers

X-AMC-Vendor-Key 7E3E178B-4C84-49E4-896E-A873B5E7F3E2
Content-Type application/json
Get tax quote for theatre-identifying SKU
GET  https://api.amctheatres.com/v1/products/SUBSCRIPTION-NEW-904-ALISTTIER3/taxes?sale-price=15

Request Required Headers

X-AMC-Vendor-Key 7E3E178B-4C84-49E4-896E-A873B5E7F3E2
Content-Type application/json