Entity use codes

Taxable entity use codes, used by tax engines to classify why a sale is exempt.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
code	string(16)	The code this resource is keyed by. Matching is case insensitive.
name	string(255)	Short label.
description	text	Longer explanation.
validcountries	string(255)	Comma separated country codes. A string, not a relation.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this entity use codes. Scoped to your company.
lastchangedateread-only	string	Last modification (`lastchangedate`). Drives `modifiedsince`.

Endpoints#

POST/taxableentityusecodes/batch 207

Create many.

Always answers 207, one result per item.

Requires scope tax:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
code	string(16)	The code this resource is keyed by. Matching is case insensitive.
name	string(255)	Short label.
description	text	Longer explanation.
validcountries	string(255)	Comma separated country codes. A string, not a relation.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this entity use codes. Scoped to your company.
lastchangedateread-only	string	Last modification (`lastchangedate`). Drives `modifiedsince`.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/taxableentityusecodes/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "id": 1,
        "code": "A",
        "name": "Federal government",
        "description": "",
        "validcountries": "US",
        "cancel": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxableentityusecodes/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'id' => 1,
      'code' => 'A',
      'name' => 'Federal government',
      'description' => '',
      'validcountries' => 'US',
      'cancel' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/taxableentityusecodes/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "id": 1,
            "code": "A",
            "name": "Federal government",
            "description": "",
            "validcountries": "US",
            "cancel": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxableentityusecodes/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        id: 1,
        code: "A",
        name: "Federal government",
        description: "",
        validcountries: "US",
        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 = 1,
        code = "A",
        name = "Federal government",
        description = "",
        validcountries = "US",
        cancel = false,
    },
};

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

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

GET/taxableentityusecodes 200403

List entity use codes.

Requires scope tax:read.

Parameters

Name	In	Type	Notes
name	query	string	name. Partial match, case-insensitive.
description	query	string	description. Partial match, case-insensitive.
code	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` for cancelled only, 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 `taxableentityusecodes:read`.

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

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxableentityusecodes');
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/taxableentityusecodes",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxableentityusecodes',
  {
    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/taxableentityusecodes");
res.EnsureSuccessStatusCode();

POST/taxableentityusecodes 201400409

Create.

Requires scope tax:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
code	string(16)	The code this resource is keyed by. Matching is case insensitive.
name	string(255)	Short label.
description	text	Longer explanation.
validcountries	string(255)	Comma separated country codes. A string, not a relation.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this entity use codes. Scoped to your company.
lastchangedateread-only	string	Last modification (`lastchangedate`). Drives `modifiedsince`.

When it fails

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

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/taxableentityusecodes' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 1,
    "code": "A",
    "name": "Federal government",
    "description": "",
    "validcountries": "US",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxableentityusecodes');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 1,
    'code' => 'A',
    'name' => 'Federal government',
    'description' => '',
    'validcountries' => 'US',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/taxableentityusecodes",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 1,
        "code": "A",
        "name": "Federal government",
        "description": "",
        "validcountries": "US",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxableentityusecodes',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 1,
      code: "A",
      name: "Federal government",
      description: "",
      validcountries: "US",
      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 = 1,
    code = "A",
    name = "Federal government",
    description = "",
    validcountries = "US",
    cancel = false,
};

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

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

Response 201

{
    "id": 1,
    "code": "A",
    "name": "Federal government",
    "description": "",
    "validcountries": "US",
    "cancel": false
}

GET/taxableentityusecodes/{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/taxableentityusecodes/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxableentityusecodes/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/taxableentityusecodes/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxableentityusecodes/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/taxableentityusecodes/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 1,
    "code": "A",
    "name": "Federal government",
    "description": "",
    "validcountries": "US",
    "cancel": false
}

PATCH/taxableentityusecodes/{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.
code	string(16)	The code this resource is keyed by. Matching is case insensitive.
name	string(255)	Short label.
description	text	Longer explanation.
validcountries	string(255)	Comma separated country codes. A string, not a relation.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this entity use codes. Scoped to your company.
lastchangedateread-only	string	Last modification (`lastchangedate`). Drives `modifiedsince`.

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/taxableentityusecodes/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 1,
    "code": "A",
    "name": "Federal government",
    "description": "",
    "validcountries": "US",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxableentityusecodes/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 1,
    'code' => 'A',
    'name' => 'Federal government',
    'description' => '',
    'validcountries' => 'US',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/taxableentityusecodes/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 1,
        "code": "A",
        "name": "Federal government",
        "description": "",
        "validcountries": "US",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxableentityusecodes/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 1,
      code: "A",
      name: "Federal government",
      description: "",
      validcountries: "US",
      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 = 1,
    code = "A",
    name = "Federal government",
    description = "",
    validcountries = "US",
    cancel = false,
};

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

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

Response 200

{
    "id": 1,
    "code": "A",
    "name": "Federal government",
    "description": "",
    "validcountries": "US",
    "cancel": false
}

DELETE/taxableentityusecodes/{id} 200403404

Cancel.

Sets the cancel flag. Nothing is removed.

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 `taxableentityusecodes:cancel`.
404	not_found	No record with that id.

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

$ch = curl_init('https://acme.nolapro.com/!/api/v2/taxableentityusecodes/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/taxableentityusecodes/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/taxableentityusecodes/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/taxableentityusecodes/104");

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

Response 200

{
    "id": 1,
    "code": "A",
    "name": "Federal government",
    "description": "",
    "validcountries": "US",
    "cancel": false
}

Product tax types →

Product tax classification.

Departments →

Departments, used for payroll expense allocation. Each carries the GL accounts wages and taxes post to.