Stages

Pipeline stages.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
stagetypeid	integer	Stagetypeid. Id only.
name	string(100)	Name of the stage.
code	string(15)	Short code of the stage.
description	text	Description. Stored as `text`, no practical length limit.
autotrigger	string(100)	Action code that automatically advances a document into this stage (the Automatic Trigger on stage setup).
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
sortorder	integer	Display order. Lower sorts first.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/stages/batch 207

Create many.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
stagetypeid	integer	Stagetypeid. Id only.
name	string(100)	Name of the stage.
code	string(15)	Short code of the stage.
description	text	Description. Stored as `text`, no practical length limit.
autotrigger	string(100)	Action code that automatically advances a document into this stage (the Automatic Trigger on stage setup).
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
sortorder	integer	Display order. Lower sorts first.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/stages/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "stagetypeid": 104,
        "name": "Example name",
        "code": "ACME-01",
        "description": "Example description",
        "autotrigger": "Example autotrigger",
        "sortorder": 1
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/stages/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'stagetypeid' => 104,
      'name' => 'Example name',
      'code' => 'ACME-01',
      'description' => 'Example description',
      'autotrigger' => 'Example autotrigger',
      'sortorder' => 1,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/stages/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "stagetypeid": 104,
            "name": "Example name",
            "code": "ACME-01",
            "description": "Example description",
            "autotrigger": "Example autotrigger",
            "sortorder": 1,
        },
    ],
)
r.raise_for_status()

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

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

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

GET/stages 200403

List stages.

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.
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/stages' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/stages 201400

Create.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
stagetypeid	integer	Stagetypeid. Id only.
name	string(100)	Name of the stage.
code	string(15)	Short code of the stage.
description	text	Description. Stored as `text`, no practical length limit.
autotrigger	string(100)	Action code that automatically advances a document into this stage (the Automatic Trigger on stage setup).
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
sortorder	integer	Display order. Lower sorts first.
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/stages' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "stagetypeid": 104,
    "name": "Example name",
    "code": "ACME-01",
    "description": "Example description",
    "autotrigger": "Example autotrigger",
    "sortorder": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/stages');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'stagetypeid' => 104,
    'name' => 'Example name',
    'code' => 'ACME-01',
    'description' => 'Example description',
    'autotrigger' => 'Example autotrigger',
    'sortorder' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/stages",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "stagetypeid": 104,
        "name": "Example name",
        "code": "ACME-01",
        "description": "Example description",
        "autotrigger": "Example autotrigger",
        "sortorder": 1,
    },
)
r.raise_for_status()

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

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

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

Response 201

{
    "stagetypeid": 104,
    "name": "Example name",
    "code": "ACME-01",
    "description": "Example description",
    "autotrigger": "Example autotrigger",
    "sortorder": 1
}

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

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

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

Response 200

{
    "stagetypeid": 104,
    "name": "Example name",
    "code": "ACME-01",
    "description": "Example description",
    "autotrigger": "Example autotrigger",
    "sortorder": 1
}

PATCH/stages/{id} 200404

Update.

Requires scope setup:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
stagetypeid	integer	Stagetypeid. Id only.
name	string(100)	Name of the stage.
code	string(15)	Short code of the stage.
description	text	Description. Stored as `text`, no practical length limit.
autotrigger	string(100)	Action code that automatically advances a document into this stage (the Automatic Trigger on stage setup).
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
sortorder	integer	Display order. Lower sorts first.
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/stages/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "stagetypeid": 104,
    "name": "Example name",
    "code": "ACME-01",
    "description": "Example description",
    "autotrigger": "Example autotrigger",
    "sortorder": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/stages/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'stagetypeid' => 104,
    'name' => 'Example name',
    'code' => 'ACME-01',
    'description' => 'Example description',
    'autotrigger' => 'Example autotrigger',
    'sortorder' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/stages/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "stagetypeid": 104,
        "name": "Example name",
        "code": "ACME-01",
        "description": "Example description",
        "autotrigger": "Example autotrigger",
        "sortorder": 1,
    },
)
r.raise_for_status()

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

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

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

Response 200

{
    "stagetypeid": 104,
    "name": "Example name",
    "code": "ACME-01",
    "description": "Example description",
    "autotrigger": "Example autotrigger",
    "sortorder": 1
}

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

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

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

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

Response 200

{
    "stagetypeid": 104,
    "name": "Example name",
    "code": "ACME-01",
    "description": "Example description",
    "autotrigger": "Example autotrigger",
    "sortorder": 1
}

Stage types →

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

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.