applied_tax

Collection: applied_taxes

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

Required Scopes

Full store_full_access
Read transactions_read
Write transactions_write

Actions

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

Properties (9)

rate Number · Read-only

The tax rate as a percentage for this applied tax. As an example, a 9.75% tax rate would be displayed as 9.75.

name String · Read-only

The original tax name of this tax.

amount Number · Read-only

The amount of tax applied to the transaction. Note, this amount is not rounded to the specific currency decimal precision.

apply_to_handling Boolean · Read-only

Whether or not this tax was also applied to the handling fees for the transaction.

apply_to_shipping Boolean · Read-only

Whether or not this tax was also applied to the shipping fees for the transaction.

is_future_tax Boolean · Read-only

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.

shipto String · Read-only

If this tax only applied to a specific shipto shipment, the shipto address name will be listed here.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (4)

self This Applied Tax
fx:store GET PATCH PUT DELETE This Store
fx:transaction GET PATCH PUT POST This Transaction
fx:tax GET PATCH PUT DELETE This Tax
https://api.foxycart.com/applied_taxes/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/applied_taxes/123",
      "title": "This Applied Tax"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:transaction": {
      "href": "https://api.foxycart.com/transactions/999",
      "title": "This Transaction"
    },
    "fx:tax": {
      "href": "https://api.foxycart.com/taxes/999",
      "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
}