applied_tax

Description

The historical record of taxes that were applied to a given transaction.

Actions

GET
View a applied_tax
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Properties

Property Description Type Constraints
rate The tax rate as a percentage for this applied tax. As an example, a 9.75% tax rate would be displayed as 9.75. Decimal Read only
name The original tax name of this tax. String Read Only
amount The amount of tax applied to the transaction. Note, this amount is not rounded to the specific currency decimal precision. Decimal Read only
apply_to_handling Whether or not this tax was also applied to the handling fees for the transaction. Boolean Read only
apply_to_shipping Whether or not this tax was also applied to the shipping fees for the transaction. Boolean Read only
is_future_tax Whether or not this applied tax is part of a subscription that is to be charged in the future based on when this transaction was processed. Boolean Read only
shipto If this tax only applied to a specific shipto shipment, the shipto address name will be listed here. String Read Only
date_created The date this resource was created. Date Read only
date_modified The date this resource was last modified. Date Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api-sandbox.foxycart.com/applied_taxes/80060",
            "title": "This Applied Tax"
        },
        "fx:store": {
            "href": "https://api-sandbox.foxycart.com/stores/66",
            "title": "This Store"
        },
        "fx:transaction": {
            "href": "https://api-sandbox.foxycart.com/transactions/3844508",
            "title": "This Transaction"
        },
        "fx:tax": {
            "href": "https://api-sandbox.foxycart.com/taxes/31588",
            "title": "This Tax"
        }
    },
    "rate": 9.35,
    "name": "TN",
    "amount": 1.7765,
    "apply_to_handling": true,
    "apply_to_shipping": true,
    "is_future_tax": false,
    "shipto": "",
    "date_created": null,
    "date_modified": null
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/applied_taxes/80060" rel="https://api.foxycart.com/rels/applied_tax">
  <link rel="self" href="https://api-sandbox.foxycart.com/applied_taxes/80060" title="This Applied Tax"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api-sandbox.foxycart.com/stores/66" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/transaction" href="https://api-sandbox.foxycart.com/transactions/3844508" title="This Transaction"/>
  <link rel="https://api.foxycart.com/rels/tax" href="https://api-sandbox.foxycart.com/taxes/31588" title="This Tax"/>
  <rate>9.35</rate>
  <name>TN</name>
  <amount>1.7765</amount>
  <apply_to_handling>true</apply_to_handling>
  <apply_to_shipping>true</apply_to_shipping>
  <is_future_tax>false</is_future_tax>
  <shipto></shipto>
  <date_created></date_created>
  <date_modified></date_modified>
</resource>

{
    "class": [
        "applied_tax"
    ],
    "properties": {
        "rate": 9.35,
        "name": "TN",
        "amount": 1.7765,
        "apply_to_handling": true,
        "apply_to_shipping": true,
        "is_future_tax": false,
        "shipto": "",
        "date_created": null,
        "date_modified": null
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/applied_taxes/80060"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/66"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/transaction"
            ],
            "href": "https://api-sandbox.foxycart.com/transactions/3844508"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/tax"
            ],
            "href": "https://api-sandbox.foxycart.com/taxes/31588"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.