{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"taxQuote (JSON object)","type":"basic","slug":"taxquote-json-object","excerpt":"Contains details about the tax quote","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`shipTo`\",\n    \"0-1\": \"object\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"The destination address where the products/services will be delivered. See [shipTo](doc:shipto-json-object).\",\n    \"1-0\": \"`shipFrom`\",\n    \"1-1\": \"object\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"The origination address where the goods will be shipped from, or where the service will originate. See [shipFrom](doc:shipfrom-json-object).\",\n    \"2-0\": \"`currency`\",\n    \"2-1\": \"string\",\n    \"2-2\": \"**Required**\",\n    \"2-3\": \"[Currency code](https://support.bluesnap.com/docs/currencies) for the tax quote.\",\n    \"3-0\": \"`lines`\",\n    \"3-1\": \"array\",\n    \"3-2\": \"**Required**\",\n    \"3-3\": \"Contains the line item details of the purchase. See [lines](doc:lines-json-object).\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n<hr>\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`shipTo`\",\n    \"0-1\": \"object\",\n    \"0-2\": \"The destination address where the products/services will be delivered. See [shipTo](doc:shipto-json-object).\",\n    \"1-0\": \"`shipFrom`\",\n    \"1-1\": \"object\",\n    \"1-2\": \"The origination address where the goods will be shipped from, or where the service will originate. See [shipFrom](doc:shipfrom-json-object).\",\n    \"2-0\": \"`currency`\",\n    \"2-1\": \"string\",\n    \"2-2\": \"[Currency code](https://support.bluesnap.com/docs/currencies) for the tax quote.\",\n    \"3-0\": \"`taxReference`\",\n    \"3-1\": \"string\",\n    \"3-2\": \"BlueSnap identifier for the tax quote.\",\n    \"4-0\": \"`totalTax`\",\n    \"4-1\": \"decimal\",\n    \"4-2\": \"The total tax amount.\",\n    \"5-0\": \"`status`\",\n    \"5-1\": \"string\",\n    \"5-2\": \"The status of the tax quote. \\n\\nValues: `Saved` or `Committed`\",\n    \"6-0\": \"`companyId`\",\n    \"6-1\": \"integer\",\n    \"6-2\": \"The merchant's company ID in Avalara.\",\n    \"7-0\": \"`requestDate`\",\n    \"7-1\": \"string\",\n    \"7-2\": \"The date the Create Tax Quote request was sent.\",\n    \"8-0\": \"`totalAmount`\",\n    \"8-1\": \"decimal\",\n    \"8-2\": \"The total amount.\",\n    \"9-0\": \"`totalExempt`\",\n    \"9-1\": \"decimal\",\n    \"9-2\": \"The total exempt amount.\",\n    \"10-0\": \"`totalTaxable`\",\n    \"10-1\": \"decimal\",\n    \"10-2\": \"The total taxable amount.\",\n    \"11-0\": \"`vatCode`\",\n    \"11-2\": \"VAT ID, if applicable.\",\n    \"11-1\": \"string\",\n    \"12-0\": \"`lines`\",\n    \"12-1\": \"array\",\n    \"12-2\": \"Contains the line item details of the purchase. See [lines](doc:lines-json-object).\",\n    \"13-0\": \"`used`\",\n    \"13-1\": \"boolean\",\n    \"13-2\": \"Indicates whether the tax quote has been used in a transaction. \\n\\nValues: \\n* `true` - The tax quote has been used in a transaction. \\n* `false` - The tax quote has not been used in a transaction.\",\n    \"14-0\": \"`taxVatType`\",\n    \"14-1\": \"string\",\n    \"14-2\": \"The type of tax. \\n\\nValues: `TAX` or `VAT`\"\n  },\n  \"cols\": 3,\n  \"rows\": 15\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"603fec227146110018e1da98","createdAt":"2020-09-01T16:06:56.523Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Tax Quotes","slug":"tax-quotes","order":16,"from_sync":false,"reference":false,"_id":"603fec227146110018e1da4e","createdAt":"2020-09-01T15:20:37.817Z","version":"603fec227146110018e1daaf","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["603fec227146110018e1da3d","603fec227146110018e1da3e","603fec227146110018e1da3f","603fec227146110018e1da40","603fec227146110018e1da41","603fec227146110018e1da42","603fec227146110018e1da43","603fec227146110018e1da44","603fec227146110018e1da45","603fec227146110018e1da46","603fec227146110018e1da47","603fec227146110018e1da48","5b34c737e0dca2000311de6a","603fec227146110018e1da49","603fec227146110018e1da4a","603fec227146110018e1da4b","603fec227146110018e1da4c","603fec227146110018e1da4d","603fec227146110018e1da4e","603fec227146110018e1da4f"],"_id":"603fec227146110018e1daaf","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"6019bc72944282005e966fd4","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

taxQuote (JSON object)

Contains details about the tax quote

Request

Property Name
Type
Required
Description

shipTo

object

Required

The destination address where the products/services will be delivered. See shipTo.

shipFrom

object

Optional

The origination address where the goods will be shipped from, or where the service will originate. See shipFrom.

currency

string

Required

Currency code for the tax quote.

lines

array

Required

Contains the line item details of the purchase. See lines.


Response

Property Name
Type
Description

shipTo

object

The destination address where the products/services will be delivered. See shipTo.

shipFrom

object

The origination address where the goods will be shipped from, or where the service will originate. See shipFrom.

currency

string

Currency code for the tax quote.

taxReference

string

BlueSnap identifier for the tax quote.

totalTax

decimal

The total tax amount.

status

string

The status of the tax quote.

Values: Saved or Committed

companyId

integer

The merchant's company ID in Avalara.

requestDate

string

The date the Create Tax Quote request was sent.

totalAmount

decimal

The total amount.

totalExempt

decimal

The total exempt amount.

totalTaxable

decimal

The total taxable amount.

vatCode

string

VAT ID, if applicable.

lines

array

Contains the line item details of the purchase. See lines.

used

boolean

Indicates whether the tax quote has been used in a transaction.

Values:

  • true - The tax quote has been used in a transaction.
  • false - The tax quote has not been used in a transaction.

taxVatType

string

The type of tax.

Values: TAX or VAT