Work subtypes

Subtypes under a work type.

The object#

Field	Type	Description
id_worksubtyperead-only	integer	Primary key of the work subtype (this table is keyed `id_worksubtype`, not `id`).
id_worktype	integer	The work type this subtype belongs to.
name	string(100)	Name of the work subtype.
purpose	string(255)	What the work subtype is used for.
num_parts	integer	Number of parts the work applies to (multi-part forms).
vended	integer	Non-zero when the work is vended - purchased outside rather than produced in-house.
createdate	string	When the change happened, not when we sent it. A retry two hours later still carries the original time.
id_user_createread-only	integer	User who created the record.
lastrevisedateread-only	string	When the record was last revised.
id_user_reviseread-only	integer	User who last revised the record.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/worksubtypes/batch 207

Create many.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
id_worksubtyperead-only	integer	Primary key of the work subtype (this table is keyed `id_worksubtype`, not `id`).
id_worktype	integer	The work type this subtype belongs to.
name	string(100)	Name of the work subtype.
purpose	string(255)	What the work subtype is used for.
num_parts	integer	Number of parts the work applies to (multi-part forms).
vended	integer	Non-zero when the work is vended - purchased outside rather than produced in-house.
createdate	string	When the change happened, not when we sent it. A retry two hours later still carries the original time.
id_user_createread-only	integer	User who created the record.
lastrevisedateread-only	string	When the record was last revised.
id_user_reviseread-only	integer	User who last revised the record.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/worksubtypes/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "id_worktype": 1,
        "name": "Example name",
        "purpose": "Example purpose",
        "num_parts": 1,
        "vended": 1
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/worksubtypes/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'id_worktype' => 1,
      'name' => 'Example name',
      'purpose' => 'Example purpose',
      'num_parts' => 1,
      'vended' => 1,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/worksubtypes/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "id_worktype": 1,
            "name": "Example name",
            "purpose": "Example purpose",
            "num_parts": 1,
            "vended": 1,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/worksubtypes/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        id_worktype: 1,
        name: "Example name",
        purpose: "Example purpose",
        num_parts: 1,
        vended: 1,
      },
    ]),
  }
);
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_worktype = 1,
        name = "Example name",
        purpose = "Example purpose",
        num_parts = 1,
        vended = 1,
    },
};

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

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

GET/worksubtypes 200403

List work subtypes.

Requires scope setup:read.

Parameters

Name	In	Type	Notes
name	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
externalid	query	string	Exact match on your own key.
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 read scope.

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

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

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

POST/worksubtypes 201400

Create.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
id_worksubtyperead-only	integer	Primary key of the work subtype (this table is keyed `id_worksubtype`, not `id`).
id_worktype	integer	The work type this subtype belongs to.
name	string(100)	Name of the work subtype.
purpose	string(255)	What the work subtype is used for.
num_parts	integer	Number of parts the work applies to (multi-part forms).
vended	integer	Non-zero when the work is vended - purchased outside rather than produced in-house.
createdate	string	When the change happened, not when we sent it. A retry two hours later still carries the original time.
id_user_createread-only	integer	User who created the record.
lastrevisedateread-only	string	When the record was last revised.
id_user_reviseread-only	integer	User who last revised the record.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/worksubtypes' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id_worktype": 1,
    "name": "Example name",
    "purpose": "Example purpose",
    "num_parts": 1,
    "vended": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/worksubtypes');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'id_worktype' => 1,
    'name' => 'Example name',
    'purpose' => 'Example purpose',
    'num_parts' => 1,
    'vended' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/worksubtypes",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id_worktype": 1,
        "name": "Example name",
        "purpose": "Example purpose",
        "num_parts": 1,
        "vended": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/worksubtypes',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id_worktype: 1,
      name: "Example name",
      purpose: "Example purpose",
      num_parts: 1,
      vended: 1,
    }),
  }
);
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_worktype = 1,
    name = "Example name",
    purpose = "Example purpose",
    num_parts = 1,
    vended = 1,
};

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

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

Response 201

{
    "id_worktype": 1,
    "name": "Example name",
    "purpose": "Example purpose",
    "num_parts": 1,
    "vended": 1
}

GET/worksubtypes/{id} 200404

Retrieve one record.

Requires scope setup: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/worksubtypes/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

Response 200

{
    "id_worktype": 1,
    "name": "Example name",
    "purpose": "Example purpose",
    "num_parts": 1,
    "vended": 1
}

PATCH/worksubtypes/{id} 200404

Update.

Requires scope setup:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
id_worksubtyperead-only	integer	Primary key of the work subtype (this table is keyed `id_worksubtype`, not `id`).
id_worktype	integer	The work type this subtype belongs to.
name	string(100)	Name of the work subtype.
purpose	string(255)	What the work subtype is used for.
num_parts	integer	Number of parts the work applies to (multi-part forms).
vended	integer	Non-zero when the work is vended - purchased outside rather than produced in-house.
createdate	string	When the change happened, not when we sent it. A retry two hours later still carries the original time.
id_user_createread-only	integer	User who created the record.
lastrevisedateread-only	string	When the record was last revised.
id_user_reviseread-only	integer	User who last revised the record.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/worksubtypes/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id_worktype": 1,
    "name": "Example name",
    "purpose": "Example purpose",
    "num_parts": 1,
    "vended": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/worksubtypes/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'id_worktype' => 1,
    'name' => 'Example name',
    'purpose' => 'Example purpose',
    'num_parts' => 1,
    'vended' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/worksubtypes/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id_worktype": 1,
        "name": "Example name",
        "purpose": "Example purpose",
        "num_parts": 1,
        "vended": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/worksubtypes/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id_worktype: 1,
      name: "Example name",
      purpose: "Example purpose",
      num_parts: 1,
      vended: 1,
    }),
  }
);
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_worktype = 1,
    name = "Example name",
    purpose = "Example purpose",
    num_parts = 1,
    vended = 1,
};

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

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

Response 200

{
    "id_worktype": 1,
    "name": "Example name",
    "purpose": "Example purpose",
    "num_parts": 1,
    "vended": 1
}

DELETE/worksubtypes/{id} 200404

Cancel.

Requires scope setup:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

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

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

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

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

Response 200

{
    "id_worktype": 1,
    "name": "Example name",
    "purpose": "Example purpose",
    "num_parts": 1,
    "vended": 1
}

Service work types →

Work types for Service Orders. Only populated on installs running that module.

Countries →

Countries, with the number formatting NolaPro uses for each. The formatting columns are worth reading if you display amounts - they explain why a total renders differently per country.