Calculate the sales tax with TaxJar service.

1 min

POST

https://app.amberflo.io/integration/tax/sales-tax/taxjar

Body Parameters

bodycom.amberflo.integration.tax.SalesTaxRequest.in
- accountAddresscom.amberflo.integration.tax.Address.inrequired
  Description
  The address of the account that is providing the product
  - countrystringrequired
  - postalCodestring
  - statestring
  - citystringrequired
  - line1stringrequired
- customerAddresscom.amberflo.integration.tax.Address.inrequired
  Description
  The address of the customer whose invoice the tax is being calculated on
  - countrystringrequired
  - postalCodestring
  - statestring
  - citystringrequired
  - line1stringrequired
- salesTaxOrdercom.amberflo.integration.tax.SalesTaxOrder.inrequired
  Description
  The order for the sales tax calculation request
  - idstringrequired
  - amountnumberrequired
- productCategorycom.amberflo.integration.tax.SalesTaxProductCategory.inrequired
  Description
  The category of product that the account is charging the customer for
- accountIntegrationDetailcom.amberflo.integration.tax.AccountIntegrationDetail.inrequired
  Description
  The extra account integration detail required for the sales tax integration.
  - usernamestring
    Description
    User name or account id etc.
  - passwordstring
    Description
    API key, password, license key (such as Avalara), etc.
  - companyCodestring
    Description
    Company code for the integration if applicable, such as Avalara.
  - environmentstring
    Description
    Environment that the account integration detail is used for if applicable. Such as sandbox or production
- customerIntegrationDetailcom.amberflo.integration.tax.CustomerIntegrationDetail.inrequired
  Description
  The extra customer integration detail required for the sales tax integration.
  - customerCodestringrequired
    Description
    The identifier for a customer.
- timeInSecondsinteger<int64>required
  Description
  Time of transaction, which could be invoice start/end time, tax calculation time, etc.

Responses

200Successful request

com.amberflo.integration.tax.SalesTaxResponse.out
- salesTaxAmountnumber
  Description
  The amount of sales tax the customer needs to pay
- invoiceSalesTaxcom.amberflo.integration.tax.InvoiceSalesTax.out
  Description
  The sales tax related details
  - totalTaxAmountnumber
    Description
    The total tax for all lines in this transaction
  - totalTaxableAmountnumber
    Description
    The portion of the total amount of this transaction that was taxable
  - totalExemptAmountnumber
    Description
    The amount of this transaction that was exempt
  - combinedTaxRatenumber
    Description
    The rate of taxation, as a fraction of the amount
  - hasNexusboolean
    Description
    Has nexus
  - taxCodestring
    Description
    The tax code
- messagecom.amberflo.service.common.log_message.LogMessage.out
  Description
  The message that contains information regarding sales tax calculation
  - levelcom.amberflo.service.common.log_message.MessageLevel.out
  - codecom.amberflo.service.common.log_message.MessageCode.out
  - messagestring

curl

curl --request POST \
     --url https://app.amberflo.io/integration/tax/sales-tax/taxjar \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "accountAddress": {
     "country": "",
     "city": "",
     "line1": ""
     },
     "customerAddress": {
     "country": "",
     "city": "",
     "line1": ""
     },
     "salesTaxOrder": {
     "id": "",
     "amount": ""
     },
     "productCategory": "",
     "accountIntegrationDetail": {},
     "customerIntegrationDetail": {
     "customerCode": ""
     },
     "timeInSeconds": 0
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "accountAddress": {
      "country": "",
      "city": "",
      "line1": ""
   },
   "customerAddress": {
      "country": "",
      "city": "",
      "line1": ""
   },
   "salesTaxOrder": {
      "id": "",
      "amount": ""
   },
   "productCategory": "",
   "accountIntegrationDetail": {},
   "customerIntegrationDetail": {
      "customerCode": ""
   },
   "timeInSeconds": 0
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/integration/tax/sales-tax/taxjar", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/integration/tax/sales-tax/taxjar")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "accountAddress": {
      "country": "",
      "city": "",
      "line1": ""
   },
   "customerAddress": {
      "country": "",
      "city": "",
      "line1": ""
   },
   "salesTaxOrder": {
      "id": "",
      "amount": ""
   },
   "productCategory": "",
   "accountIntegrationDetail": {},
   "customerIntegrationDetail": {
      "customerCode": ""
   },
   "timeInSeconds": 0
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/integration/tax/sales-tax/taxjar"

payload = json.dumps({
   "accountAddress": {
      "country": "",
      "city": "",
      "line1": ""
   },
   "customerAddress": {
      "country": "",
      "city": "",
      "line1": ""
   },
   "salesTaxOrder": {
      "id": "",
      "amount": ""
   },
   "productCategory": "",
   "accountIntegrationDetail": {},
   "customerIntegrationDetail": {
      "customerCode": ""
   },
   "timeInSeconds": 0
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "salesTaxAmount": 0,
  "invoiceSalesTax": {
    "totalTaxAmount": 0,
    "totalTaxableAmount": 0,
    "totalExemptAmount": 0,
    "combinedTaxRate": 0,
    "hasNexus": false,
    "taxCode": ""
  },
  "message": {
    "level": "",
    "code": "",
    "message": ""
  }
}