Skip to main content
POST
/
tax-rates
Create tax rate
curl --request POST \
  --url https://api.arcuserp.com/v1/tax-rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rate": 123,
  "name": "TX Sales Tax",
  "display_name": "TX Sales Tax",
  "description": "<string>",
  "tax_type": "sales",
  "jurisdiction_country": "US",
  "jurisdiction_state": "TX",
  "jurisdiction_county": "<string>",
  "jurisdiction_city": "<string>",
  "jurisdiction_postal_code": "<string>",
  "inclusive": false,
  "is_active": true,
  "effective_from": "2023-12-25",
  "effective_to": "2023-12-25",
  "metadata": {}
}
'
import requests

url = "https://api.arcuserp.com/v1/tax-rates"

payload = {
    "rate": 123,
    "name": "TX Sales Tax",
    "display_name": "TX Sales Tax",
    "description": "<string>",
    "tax_type": "sales",
    "jurisdiction_country": "US",
    "jurisdiction_state": "TX",
    "jurisdiction_county": "<string>",
    "jurisdiction_city": "<string>",
    "jurisdiction_postal_code": "<string>",
    "inclusive": False,
    "is_active": True,
    "effective_from": "2023-12-25",
    "effective_to": "2023-12-25",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rate: 123,
    name: 'TX Sales Tax',
    display_name: 'TX Sales Tax',
    description: '<string>',
    tax_type: 'sales',
    jurisdiction_country: 'US',
    jurisdiction_state: 'TX',
    jurisdiction_county: '<string>',
    jurisdiction_city: '<string>',
    jurisdiction_postal_code: '<string>',
    inclusive: false,
    is_active: true,
    effective_from: '2023-12-25',
    effective_to: '2023-12-25',
    metadata: {}
  })
};

fetch('https://api.arcuserp.com/v1/tax-rates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/tax-rates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rate' => 123,
    'name' => 'TX Sales Tax',
    'display_name' => 'TX Sales Tax',
    'description' => '<string>',
    'tax_type' => 'sales',
    'jurisdiction_country' => 'US',
    'jurisdiction_state' => 'TX',
    'jurisdiction_county' => '<string>',
    'jurisdiction_city' => '<string>',
    'jurisdiction_postal_code' => '<string>',
    'inclusive' => false,
    'is_active' => true,
    'effective_from' => '2023-12-25',
    'effective_to' => '2023-12-25',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/tax-rates"

	payload := strings.NewReader("{\n  \"rate\": 123,\n  \"name\": \"TX Sales Tax\",\n  \"display_name\": \"TX Sales Tax\",\n  \"description\": \"<string>\",\n  \"tax_type\": \"sales\",\n  \"jurisdiction_country\": \"US\",\n  \"jurisdiction_state\": \"TX\",\n  \"jurisdiction_county\": \"<string>\",\n  \"jurisdiction_city\": \"<string>\",\n  \"jurisdiction_postal_code\": \"<string>\",\n  \"inclusive\": false,\n  \"is_active\": true,\n  \"effective_from\": \"2023-12-25\",\n  \"effective_to\": \"2023-12-25\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/tax-rates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rate\": 123,\n  \"name\": \"TX Sales Tax\",\n  \"display_name\": \"TX Sales Tax\",\n  \"description\": \"<string>\",\n  \"tax_type\": \"sales\",\n  \"jurisdiction_country\": \"US\",\n  \"jurisdiction_state\": \"TX\",\n  \"jurisdiction_county\": \"<string>\",\n  \"jurisdiction_city\": \"<string>\",\n  \"jurisdiction_postal_code\": \"<string>\",\n  \"inclusive\": false,\n  \"is_active\": true,\n  \"effective_from\": \"2023-12-25\",\n  \"effective_to\": \"2023-12-25\",\n  \"metadata\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/tax-rates")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rate\": 123,\n  \"name\": \"TX Sales Tax\",\n  \"display_name\": \"TX Sales Tax\",\n  \"description\": \"<string>\",\n  \"tax_type\": \"sales\",\n  \"jurisdiction_country\": \"US\",\n  \"jurisdiction_state\": \"TX\",\n  \"jurisdiction_county\": \"<string>\",\n  \"jurisdiction_city\": \"<string>\",\n  \"jurisdiction_postal_code\": \"<string>\",\n  \"inclusive\": false,\n  \"is_active\": true,\n  \"effective_from\": \"2023-12-25\",\n  \"effective_to\": \"2023-12-25\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{}
{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}
{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}
{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}
{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

​
Idempotency-Key
string

Body

application/json
​
rate
number
required

Tax rate as a decimal (e.g. 0.0825 for 8.25%)

​
name
string

Human-friendly name for the tax rate (alias for display_name; if both provided, display_name wins).

Example:

"TX Sales Tax"

​
display_name
string

Canonical display name stored in DB. Accepted alongside 'name' alias.

Example:

"TX Sales Tax"

​
description
string
​
tax_type
enum<string>
default:sales
Available options:
sales,
use,
vat,
gst,
hst,
pst,
excise,
other
​
jurisdiction_country
string

ISO 3166-1 alpha-2 country code

Example:

"US"

​
jurisdiction_state
string
Example:

"TX"

​
jurisdiction_county
string
​
jurisdiction_city
string
​
jurisdiction_postal_code
string
​
inclusive
boolean
default:false
​
is_active
boolean
default:true
​
effective_from
string<date>
​
effective_to
string<date>
​
metadata
object

Response

Created tax rate

The response is of type object.