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.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
comments	string(100)	The comment text.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this quote comments. Scoped to your company.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.

Endpoints#

POST/quotecomments/batch 207

Create many.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
comments	string(100)	The comment text.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this quote comments. Scoped to your company.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/quotecomments/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "id": 3,
        "comments": "Quote Comment",
        "cancel": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/quotecomments/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'id' => 3,
      'comments' => 'Quote Comment',
      'cancel' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/quotecomments/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "id": 3,
            "comments": "Quote Comment",
            "cancel": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/quotecomments/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        id: 3,
        comments: "Quote Comment",
        cancel: 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 {
        id = 3,
        comments = "Quote Comment",
        cancel = false,
    },
};

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

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

GET/quotecomments 200403

List quote comments.

Requires scope setup:read.

Parameters

Name	In	Type	Notes
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
externalid	query	string	Exact match on your own key. Scoped to your company.
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.
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 `quotecomments:read`.

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

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

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

POST/quotecomments 201400409

Create.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
comments	string(100)	The comment text.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this quote comments. Scoped to your company.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.
409	duplicate	That code is already in use.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/quotecomments' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 3,
    "comments": "Quote Comment",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/quotecomments');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 3,
    'comments' => 'Quote Comment',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/quotecomments",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 3,
        "comments": "Quote Comment",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/quotecomments',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 3,
      comments: "Quote Comment",
      cancel: 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 {
    id = 3,
    comments = "Quote Comment",
    cancel = false,
};

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

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

Response 201

{
    "id": 3,
    "comments": "Quote Comment",
    "cancel": false
}

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

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

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

Response 200

{
    "id": 3,
    "comments": "Quote Comment",
    "cancel": false
}

PATCH/quotecomments/{id} 200404409

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.
comments	string(100)	The comment text.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this quote comments. Scoped to your company.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.
409	stale_record	`If-Match` did not match.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/quotecomments/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 3,
    "comments": "Quote Comment",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/quotecomments/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 3,
    'comments' => 'Quote Comment',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/quotecomments/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 3,
        "comments": "Quote Comment",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/quotecomments/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 3,
      comments: "Quote Comment",
      cancel: 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 {
    id = 3,
    comments = "Quote Comment",
    cancel = false,
};

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

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

Response 200

{
    "id": 3,
    "comments": "Quote Comment",
    "cancel": false
}

DELETE/quotecomments/{id} 200403404

Cancel.

Requires scope setup:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
403	insufficient_scope	Needs `quotecomments:cancel`.
404	not_found	No record with that id.

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

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

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

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

Response 200

{
    "id": 3,
    "comments": "Quote Comment",
    "cancel": false
}

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.

External users →

Read-only and minimal. External identities. Credentials are never returned.