Service order statuses

Custom service order statuses ("In Progress", "Waiting for Parts", "Order Complete"...). Referenced by statusid on a service order; complete marks the statuses that mean the work is done.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
description	string(50)	The status name shown on the service order screen ("Waiting for Parts", "Order Complete").
sortorder	integer	Display order in the status dropdown, low first.
entrydateread-only	string	When the status option was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
complete	boolean	This status means the work is done. The order list treats an order carrying a complete status as finished.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/orderstatusoptions/batch 207

Create many.

Requires scope orders:write.

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
description	string(50)	The status name shown on the service order screen ("Waiting for Parts", "Order Complete").
sortorder	integer	Display order in the status dropdown, low first.
entrydateread-only	string	When the status option was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
complete	boolean	This status means the work is done. The order list treats an order carrying a complete status as finished.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/orderstatusoptions/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "description": "Example description",
        "sortorder": 1,
        "complete": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/orderstatusoptions/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'description' => 'Example description',
      'sortorder' => 1,
      'complete' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/orderstatusoptions/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "description": "Example description",
            "sortorder": 1,
            "complete": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/orderstatusoptions/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        description: "Example description",
        sortorder: 1,
        complete: 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 {
        description = "Example description",
        sortorder = 1,
        complete = false,
    },
};

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

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

GET/orderstatusoptions 200403

List service order statuses.

Requires scope orders:read.

Parameters

Name	In	Type	Notes
description	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
modifiedsince	query	string	Delta polling.
externalid	query	string	Exact match on your own key.

When it fails

Status	Code	Meaning
403	insufficient_scope	Token lacks read scope.

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

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

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

POST/orderstatusoptions 201400

Create.

Requires scope orders:write.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
description	string(50)	The status name shown on the service order screen ("Waiting for Parts", "Order Complete").
sortorder	integer	Display order in the status dropdown, low first.
entrydateread-only	string	When the status option was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
complete	boolean	This status means the work is done. The order list treats an order carrying a complete status as finished.
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/orderstatusoptions' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "description": "Example description",
    "sortorder": 1,
    "complete": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/orderstatusoptions');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'description' => 'Example description',
    'sortorder' => 1,
    'complete' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/orderstatusoptions",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "description": "Example description",
        "sortorder": 1,
        "complete": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/orderstatusoptions',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      description: "Example description",
      sortorder: 1,
      complete: 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 {
    description = "Example description",
    sortorder = 1,
    complete = false,
};

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

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

Response 201

{
    "description": "Example description",
    "sortorder": 1,
    "complete": false
}

GET/orderstatusoptions/{id} 200404

Retrieve one record.

Requires scope orders:read.

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 \
  'https://acme.nolapro.com/!/api/v2/orderstatusoptions/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

Response 200

{
    "description": "Example description",
    "sortorder": 1,
    "complete": false
}

PATCH/orderstatusoptions/{id} 200404

Update.

Requires scope orders:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
description	string(50)	The status name shown on the service order screen ("Waiting for Parts", "Order Complete").
sortorder	integer	Display order in the status dropdown, low first.
entrydateread-only	string	When the status option was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
complete	boolean	This status means the work is done. The order list treats an order carrying a complete status as finished.
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/orderstatusoptions/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "description": "Example description",
    "sortorder": 1,
    "complete": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/orderstatusoptions/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'description' => 'Example description',
    'sortorder' => 1,
    'complete' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/orderstatusoptions/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "description": "Example description",
        "sortorder": 1,
        "complete": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/orderstatusoptions/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      description: "Example description",
      sortorder: 1,
      complete: 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 {
    description = "Example description",
    sortorder = 1,
    complete = false,
};

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

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

Response 200

{
    "description": "Example description",
    "sortorder": 1,
    "complete": false
}

DELETE/orderstatusoptions/{id} 200404

Cancel.

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

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

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

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

Response 200

{
    "description": "Example description",
    "sortorder": 1,
    "complete": false
}

Bank accounts →

Read-only. Bank accounts carry accountnumber, positive-pay SFTP credentials and private keys. Those are never returned, and the account is not writable through the API - changing where money moves is not an integration operation.

Bank deposits →

Deposits into a bank account.