{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"tax-quote (XML resource)","type":"basic","slug":"tax-quote-xml-resource","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\": \"`ship-to`\",\n    \"0-1\": \"container\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"The destination address details of where the products/services will be delivered to. See [ship-to](doc:ship-to-xml-resource).\",\n    \"1-0\": \"`ship-from`\",\n    \"1-1\": \"container\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"The origination address where the goods will be shipped from, or where the service will originate. See [ship-from](doc:ship-from).\",\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\": \"container\",\n    \"3-2\": \"**Required**\",\n    \"3-3\": \"Contains the line item details for the purchase. The request can contain multiple `lines` containers. See [lines](doc:lines-xml-resource).\"\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\": \"`ship-to`\",\n    \"0-1\": \"container\",\n    \"0-2\": \"The destination address details of where the products/services will be delivered to. See [ship-to](doc:ship-to-xml-resource).\",\n    \"1-0\": \"`ship-from`\",\n    \"1-1\": \"container\",\n    \"1-2\": \"The origination address where the goods will be shipped from, or where the service will originate. See [ship-from](doc:ship-from).\",\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\": \"`tax-reference`\",\n    \"3-1\": \"string\",\n    \"3-2\": \"BlueSnap identifier for the tax quote.\",\n    \"4-0\": \"`total-tax`\",\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\": \"`company-id`\",\n    \"6-1\": \"integer\",\n    \"6-2\": \"The merchant's company ID in Avalara.\",\n    \"7-0\": \"`request-date`\",\n    \"7-1\": \"string\",\n    \"7-2\": \"The date the Create Tax Quote request was sent.\",\n    \"8-0\": \"`total-amount`\",\n    \"8-1\": \"decimal\",\n    \"8-2\": \"The total amount.\",\n    \"9-0\": \"`total-exempt`\",\n    \"9-1\": \"decimal\",\n    \"9-2\": \"The total exempt amount.\",\n    \"10-0\": \"`total-taxable`\",\n    \"10-1\": \"decimal\",\n    \"10-2\": \"The total taxable amount.\",\n    \"11-0\": \"`vat-code`\",\n    \"11-2\": \"VAT ID, if applicable.\",\n    \"11-1\": \"string\",\n    \"12-0\": \"`lines`\",\n    \"12-1\": \"container\",\n    \"12-2\": \"Contains the line item details for the purchase. See [lines](doc:lines-xml-resource).\",\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\": \"`tax-vat-type`\",\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":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60957f4cce403c0045a03242","createdAt":"2020-09-01T17:58:50.484Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Tax Quotes","slug":"tax-quotes","order":16,"from_sync":false,"reference":false,"_id":"60957f4cce403c0045a031f4","createdAt":"2020-09-01T15:20:37.817Z","version":"60957f4cce403c0045a03255","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.38 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60957f4cce403c0045a031e3","60957f4cce403c0045a031e4","60957f4cce403c0045a031e5","60957f4cce403c0045a031e6","60957f4cce403c0045a031e7","60957f4cce403c0045a031e8","60957f4cce403c0045a031e9","60957f4cce403c0045a031ea","60957f4cce403c0045a031eb","60957f4cce403c0045a031ec","60957f4cce403c0045a031ed","60957f4cce403c0045a031ee","5b34c737e0dca2000311de6a","60957f4cce403c0045a031ef","60957f4cce403c0045a031f0","60957f4cce403c0045a031f1","60957f4cce403c0045a031f2","60957f4cce403c0045a031f3","60957f4cce403c0045a031f4","60957f4cce403c0045a031f5"],"_id":"60957f4cce403c0045a03255","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"603fec227146110018e1daaf","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

tax-quote (XML resource)

Contains details about the tax quote

Request

Property Name
Type
Required
Description

ship-to

container

Required

The destination address details of where the products/services will be delivered to. See ship-to.

ship-from

container

Optional

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

currency

string

Required

Currency code for the tax quote.

lines

container

Required

Contains the line item details for the purchase. The request can contain multiple lines containers. See lines.


Response

Property Name
Type
Description

ship-to

container

The destination address details of where the products/services will be delivered to. See ship-to.

ship-from

container

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

currency

string

Currency code for the tax quote.

tax-reference

string

BlueSnap identifier for the tax quote.

total-tax

decimal

The total tax amount.

status

string

The status of the tax quote.

Values: Saved or Committed

company-id

integer

The merchant's company ID in Avalara.

request-date

string

The date the Create Tax Quote request was sent.

total-amount

decimal

The total amount.

total-exempt

decimal

The total exempt amount.

total-taxable

decimal

The total taxable amount.

vat-code

string

VAT ID, if applicable.

lines

container

Contains the line item details for 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.

tax-vat-type

string

The type of tax.

Values: TAX or VAT