Stage types

Read-only. A static table rebuilt on every NolaPro update.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
code	string(100)	Short code of the stage type.
tablename	string(100)	Table the stage applies to (which document type carries this stage).
title	string(255)	Stage title shown on screens.
description	text	Description. Stored as `text`, no practical length limit.
modaccess	string(150)	Module whose access rights govern the stage (ap, ar).
modbit	string(20)	Access bits string checked against the user’s module rights.

Endpoints#

GET/stagetypes 200403

List stage types.

Requires scope setup:read.

Parameters

Name	In	Type	Notes
description	query	string	description. Partial match, case-insensitive.
code	query	string	code. Partial match, case-insensitive.
title	query	string	title. Partial match, case-insensitive.
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/stagetypes' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

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

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

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

Response 200

{
    "code": "ACME-01",
    "tablename": "Example tablename",
    "title": "Example title",
    "description": "Example description",
    "modaccess": "Example modaccess",
    "modbit": "Example modbit"
}

Invoice terms →

Payment terms. The most referenced lookup in the API - 18,112 of 18,115 customers point at one. Shared install-wide, so a change here is visible to every company.

Salespeople →

Salespeople and service reps. One table serves both roles - salesman and servicerep are flags, so filter on those rather than expecting two resources.