Quote price lists

Price lists used by Estimating quotes. The wider Estimating configuration surface (about 40 tables) is a module pass of its own and is not exposed here.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
stdsizeid	integer	Stdsizeid. Id only.
worktypeid	integer	Reference to `worktypes`, by id. Write either this or `worktype`.
worktype	string(100)	Code for the referenced worktype, instead of the id.
name	string(50)	Price list name.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
maxinkside1	integer	Most inks the price list covers on side 1.
maxinkside2	integer	Most inks the price list covers on side 2.
trimchargepermpercutmoney	string(2dp)	Stored as `decimal(8,2)`.
trimminchargemoney	string(2dp)	Stored as `decimal(8,2)`.
qtyperboxqty	string(0dp)	Quantity, 0 decimal places, as a string. Stored as `decimal(0dp)`.
notes	text	Notes. Stored as `blob`, no practical length limit.
point2id	integer	Point2id. Id only.
covereach_blackinandoutmoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_coloroutblackinmoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_colorinandoutmoney	string(5dp)	Stored as `decimal(19,5)`.
costper_nocovermoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_colorinblackoutmoney	string(5dp)	Stored as `decimal(19,5)`.
noinkcharge	integer	1 when ink is not charged separately on this price list.
scrap_percentnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
scrap_sheets_max	integer	Maximum scrap sheets allowed into the price calculation.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/estquotepricelists/batch 207

Create many.

Requires scope estimating:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
stdsizeid	integer	Stdsizeid. Id only.
worktypeid	integer	Reference to `worktypes`, by id. Write either this or `worktype`.
worktype	string(100)	Code for the referenced worktype, instead of the id.
name	string(50)	Price list name.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
maxinkside1	integer	Most inks the price list covers on side 1.
maxinkside2	integer	Most inks the price list covers on side 2.
trimchargepermpercutmoney	string(2dp)	Stored as `decimal(8,2)`.
trimminchargemoney	string(2dp)	Stored as `decimal(8,2)`.
qtyperboxqty	string(0dp)	Quantity, 0 decimal places, as a string. Stored as `decimal(0dp)`.
notes	text	Notes. Stored as `blob`, no practical length limit.
point2id	integer	Point2id. Id only.
covereach_blackinandoutmoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_coloroutblackinmoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_colorinandoutmoney	string(5dp)	Stored as `decimal(19,5)`.
costper_nocovermoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_colorinblackoutmoney	string(5dp)	Stored as `decimal(19,5)`.
noinkcharge	integer	1 when ink is not charged separately on this price list.
scrap_percentnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
scrap_sheets_max	integer	Maximum scrap sheets allowed into the price calculation.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/estquotepricelists/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "stdsizeid": 104,
        "worktypeid": 104,
        "worktype": "Example worktype",
        "name": "Example name",
        "maxinkside1": 1,
        "maxinkside2": 1
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/estquotepricelists/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'stdsizeid' => 104,
      'worktypeid' => 104,
      'worktype' => 'Example worktype',
      'name' => 'Example name',
      'maxinkside1' => 1,
      'maxinkside2' => 1,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/estquotepricelists/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "stdsizeid": 104,
            "worktypeid": 104,
            "worktype": "Example worktype",
            "name": "Example name",
            "maxinkside1": 1,
            "maxinkside2": 1,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/estquotepricelists/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        stdsizeid: 104,
        worktypeid: 104,
        worktype: "Example worktype",
        name: "Example name",
        maxinkside1: 1,
        maxinkside2: 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 {
        stdsizeid = 104,
        worktypeid = 104,
        worktype = "Example worktype",
        name = "Example name",
        maxinkside1 = 1,
        maxinkside2 = 1,
    },
};

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

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

GET/estquotepricelists 200403

List quote price lists.

Requires scope estimating:read.

Parameters

Name	In	Type	Notes
name	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
modifiedsince	query	string	RFC 3339 UTC timestamp. Returns only records changed since then, including cancelled ones - so `cancel` defaults to any rather than `false` when this is used. The response carries `_meta.synced_through`; store it and send it back next time.
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/estquotepricelists' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/estquotepricelists 201400

Create.

Requires scope estimating:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
stdsizeid	integer	Stdsizeid. Id only.
worktypeid	integer	Reference to `worktypes`, by id. Write either this or `worktype`.
worktype	string(100)	Code for the referenced worktype, instead of the id.
name	string(50)	Price list name.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
maxinkside1	integer	Most inks the price list covers on side 1.
maxinkside2	integer	Most inks the price list covers on side 2.
trimchargepermpercutmoney	string(2dp)	Stored as `decimal(8,2)`.
trimminchargemoney	string(2dp)	Stored as `decimal(8,2)`.
qtyperboxqty	string(0dp)	Quantity, 0 decimal places, as a string. Stored as `decimal(0dp)`.
notes	text	Notes. Stored as `blob`, no practical length limit.
point2id	integer	Point2id. Id only.
covereach_blackinandoutmoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_coloroutblackinmoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_colorinandoutmoney	string(5dp)	Stored as `decimal(19,5)`.
costper_nocovermoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_colorinblackoutmoney	string(5dp)	Stored as `decimal(19,5)`.
noinkcharge	integer	1 when ink is not charged separately on this price list.
scrap_percentnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
scrap_sheets_max	integer	Maximum scrap sheets allowed into the price calculation.
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/estquotepricelists' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "stdsizeid": 104,
    "worktypeid": 104,
    "worktype": "Example worktype",
    "name": "Example name",
    "maxinkside1": 1,
    "maxinkside2": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/estquotepricelists');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'stdsizeid' => 104,
    'worktypeid' => 104,
    'worktype' => 'Example worktype',
    'name' => 'Example name',
    'maxinkside1' => 1,
    'maxinkside2' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/estquotepricelists",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "stdsizeid": 104,
        "worktypeid": 104,
        "worktype": "Example worktype",
        "name": "Example name",
        "maxinkside1": 1,
        "maxinkside2": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/estquotepricelists',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      stdsizeid: 104,
      worktypeid: 104,
      worktype: "Example worktype",
      name: "Example name",
      maxinkside1: 1,
      maxinkside2: 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 {
    stdsizeid = 104,
    worktypeid = 104,
    worktype = "Example worktype",
    name = "Example name",
    maxinkside1 = 1,
    maxinkside2 = 1,
};

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

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

Response 201

{
    "stdsizeid": 104,
    "worktypeid": 104,
    "worktype": "Example worktype",
    "name": "Example name",
    "maxinkside1": 1,
    "maxinkside2": 1
}

GET/estquotepricelists/{id} 200404

Retrieve one record.

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

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

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

Response 200

{
    "stdsizeid": 104,
    "worktypeid": 104,
    "worktype": "Example worktype",
    "name": "Example name",
    "maxinkside1": 1,
    "maxinkside2": 1
}

PATCH/estquotepricelists/{id} 200404

Update.

Requires scope estimating:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
stdsizeid	integer	Stdsizeid. Id only.
worktypeid	integer	Reference to `worktypes`, by id. Write either this or `worktype`.
worktype	string(100)	Code for the referenced worktype, instead of the id.
name	string(50)	Price list name.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
maxinkside1	integer	Most inks the price list covers on side 1.
maxinkside2	integer	Most inks the price list covers on side 2.
trimchargepermpercutmoney	string(2dp)	Stored as `decimal(8,2)`.
trimminchargemoney	string(2dp)	Stored as `decimal(8,2)`.
qtyperboxqty	string(0dp)	Quantity, 0 decimal places, as a string. Stored as `decimal(0dp)`.
notes	text	Notes. Stored as `blob`, no practical length limit.
point2id	integer	Point2id. Id only.
covereach_blackinandoutmoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_coloroutblackinmoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_colorinandoutmoney	string(5dp)	Stored as `decimal(19,5)`.
costper_nocovermoney	string(5dp)	Stored as `decimal(19,5)`.
covereach_colorinblackoutmoney	string(5dp)	Stored as `decimal(19,5)`.
noinkcharge	integer	1 when ink is not charged separately on this price list.
scrap_percentnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
scrap_sheets_max	integer	Maximum scrap sheets allowed into the price calculation.
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/estquotepricelists/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "stdsizeid": 104,
    "worktypeid": 104,
    "worktype": "Example worktype",
    "name": "Example name",
    "maxinkside1": 1,
    "maxinkside2": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/estquotepricelists/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'stdsizeid' => 104,
    'worktypeid' => 104,
    'worktype' => 'Example worktype',
    'name' => 'Example name',
    'maxinkside1' => 1,
    'maxinkside2' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/estquotepricelists/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "stdsizeid": 104,
        "worktypeid": 104,
        "worktype": "Example worktype",
        "name": "Example name",
        "maxinkside1": 1,
        "maxinkside2": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/estquotepricelists/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      stdsizeid: 104,
      worktypeid: 104,
      worktype: "Example worktype",
      name: "Example name",
      maxinkside1: 1,
      maxinkside2: 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 {
    stdsizeid = 104,
    worktypeid = 104,
    worktype = "Example worktype",
    name = "Example name",
    maxinkside1 = 1,
    maxinkside2 = 1,
};

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

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

Response 200

{
    "stdsizeid": 104,
    "worktypeid": 104,
    "worktype": "Example worktype",
    "name": "Example name",
    "maxinkside1": 1,
    "maxinkside2": 1
}

DELETE/estquotepricelists/{id} 200404

Cancel.

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

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

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

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

Response 200

{
    "stdsizeid": 104,
    "worktypeid": 104,
    "worktype": "Example worktype",
    "name": "Example name",
    "maxinkside1": 1,
    "maxinkside2": 1
}

Quote comments →

Standard comment blocks attached to customers for quoting. This is quotecomment, not estquotequotenotes - the UI joins quotecomment.id = customer.quotecommentid (arcustcsvlist.php:118). The Estimating table of a similar name is a different thing and is not exposed.

Users →

Read-only, and deliberately minimal. Users are who NolaPro attributes work to, so an integrator needs to resolve an id to a name - and nothing more. Credentials, API keys, two-factor secrets and the ninety-odd preference columns are never returned.