Tax classes

Tax classes applied to items. The avatax* columns mirror an AvaTax tax code and are only meaningful on installs using it.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(100)	Class name.
exempt	boolean	Items in this class are exempt.
avataxtaxcode	string(255)	Matching AvaTax tax code.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this tax classes. Scoped to your company.

Endpoints#

POST/taxclasses/batch 207

Create many.

Requires scope tax:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(100)	Class name.
exempt	boolean	Items in this class are exempt.
avataxtaxcode	string(255)	Matching AvaTax tax code.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this tax classes. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/taxclasses/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "id": 2,
        "name": "Taxable goods",
        "exempt": false,
        "avataxtaxcode": "",
        "cancel": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxclasses/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'id' => 2,
      'name' => 'Taxable goods',
      'exempt' => false,
      'avataxtaxcode' => '',
      'cancel' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/taxclasses/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "id": 2,
            "name": "Taxable goods",
            "exempt": False,
            "avataxtaxcode": "",
            "cancel": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxclasses/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        id: 2,
        name: "Taxable goods",
        exempt: false,
        avataxtaxcode: "",
        cancel: false,
      },
    ]),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new[] {
    new {
        id = 2,
        name = "Taxable goods",
        exempt = false,
        avataxtaxcode = "",
        cancel = false,
    },
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/taxclasses/batch") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

GET/taxclasses 200403

List tax classes.

Requires scope tax:read.

Parameters

Name	In	Type	Notes
name	query	string	name. Partial match, case-insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
externalid	query	string	Exact match on your own key. Scoped to your company.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
403	insufficient_scope	Token lacks `taxclasses:read`.

curl \
  'https://acme.nolapro.com/!/api/v2/taxclasses' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxclasses');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/taxclasses",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxclasses',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/taxclasses");
res.EnsureSuccessStatusCode();

POST/taxclasses 201400409

Create.

Requires scope tax:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(100)	Class name.
exempt	boolean	Items in this class are exempt.
avataxtaxcode	string(255)	Matching AvaTax tax code.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this tax classes. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.
409	duplicate	That code is already in use.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/taxclasses' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 2,
    "name": "Taxable goods",
    "exempt": false,
    "avataxtaxcode": "",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxclasses');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 2,
    'name' => 'Taxable goods',
    'exempt' => false,
    'avataxtaxcode' => '',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/taxclasses",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 2,
        "name": "Taxable goods",
        "exempt": False,
        "avataxtaxcode": "",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxclasses',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 2,
      name: "Taxable goods",
      exempt: false,
      avataxtaxcode: "",
      cancel: false,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    id = 2,
    name = "Taxable goods",
    exempt = false,
    avataxtaxcode = "",
    cancel = false,
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/taxclasses") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 201

{
    "id": 2,
    "name": "Taxable goods",
    "exempt": false,
    "avataxtaxcode": "",
    "cancel": false
}

GET/taxclasses/{id} 200404

Retrieve one record.

Requires scope tax:read.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl \
  'https://acme.nolapro.com/!/api/v2/taxclasses/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxclasses/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/taxclasses/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxclasses/104',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/taxclasses/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 2,
    "name": "Taxable goods",
    "exempt": false,
    "avataxtaxcode": "",
    "cancel": false
}

PATCH/taxclasses/{id} 200404409

Update.

Requires scope tax:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(100)	Class name.
exempt	boolean	Items in this class are exempt.
avataxtaxcode	string(255)	Matching AvaTax tax code.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this tax classes. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.
409	stale_record	`If-Match` did not match.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/taxclasses/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 2,
    "name": "Taxable goods",
    "exempt": false,
    "avataxtaxcode": "",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxclasses/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 2,
    'name' => 'Taxable goods',
    'exempt' => false,
    'avataxtaxcode' => '',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/taxclasses/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 2,
        "name": "Taxable goods",
        "exempt": False,
        "avataxtaxcode": "",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxclasses/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 2,
      name: "Taxable goods",
      exempt: false,
      avataxtaxcode: "",
      cancel: false,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    id = 2,
    name = "Taxable goods",
    exempt = false,
    avataxtaxcode = "",
    cancel = false,
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/taxclasses/104") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 2,
    "name": "Taxable goods",
    "exempt": false,
    "avataxtaxcode": "",
    "cancel": false
}

DELETE/taxclasses/{id} 200403404

Cancel.

Requires scope tax:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
403	insufficient_scope	Needs `taxclasses:cancel`.
404	not_found	No record with that id.

curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/taxclasses/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxclasses/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.delete(
    "https://acme.nolapro.com/!/api/v2/taxclasses/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxclasses/104',
  {
    method: 'DELETE',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var req = new HttpRequestMessage(HttpMethod.Delete,
    "https://acme.nolapro.com/!/api/v2/taxclasses/104");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 2,
    "name": "Taxable goods",
    "exempt": false,
    "avataxtaxcode": "",
    "cancel": false
}

Tax exemptions →

Tax exemption reasons and their rates. More than a label - each carries a state and a taxrate.

Tax groups →

Tax groups. Empty on many installs until tax is configured.