Contacts

Named contacts on a customer or ship-to.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
tablename	string(100)	Which table the contact belongs to (customer, vendor, shipto).
tablerecordid	integer	Tablerecordid. Id only.
entrydateread-only	string	When the record was created.
firstname	string(100)	Contact first name.
lastname	string(100)	Contact last name.
description	text	Description. Stored as `text`, no practical length limit.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
authorizedbuyer	boolean	True when the contact is an authorized buyer for the account.
taskstatusid	integer	Reference to `taskstatuses`, by id. Write either this or `taskstatus`.
taskstatus	string(100)	The `name` of the referenced taskstatuses, instead of the id. Send this or `taskstatusid`, not both unless they agree.
inactive	integer	1 hides the contact from pickers.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/contactnames/batch 207

Create many.

Requires scope customers:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
tablename	string(100)	Which table the contact belongs to (customer, vendor, shipto).
tablerecordid	integer	Tablerecordid. Id only.
entrydateread-only	string	When the record was created.
firstname	string(100)	Contact first name.
lastname	string(100)	Contact last name.
description	text	Description. Stored as `text`, no practical length limit.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
authorizedbuyer	boolean	True when the contact is an authorized buyer for the account.
taskstatusid	integer	Reference to `taskstatuses`, by id. Write either this or `taskstatus`.
taskstatus	string(100)	The `name` of the referenced taskstatuses, instead of the id. Send this or `taskstatusid`, not both unless they agree.
inactive	integer	1 hides the contact from pickers.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/contactnames/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "tablename": "Example tablename",
        "tablerecordid": 104,
        "firstname": "Example firstname",
        "lastname": "Example lastname",
        "description": "Example description",
        "authorizedbuyer": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/contactnames/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'tablename' => 'Example tablename',
      'tablerecordid' => 104,
      'firstname' => 'Example firstname',
      'lastname' => 'Example lastname',
      'description' => 'Example description',
      'authorizedbuyer' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/contactnames/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "tablename": "Example tablename",
            "tablerecordid": 104,
            "firstname": "Example firstname",
            "lastname": "Example lastname",
            "description": "Example description",
            "authorizedbuyer": False,
        },
    ],
)
r.raise_for_status()

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

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

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

GET/contactnames 200403

List contacts.

Requires scope customers:read.

Parameters

Name	In	Type	Notes
description	query	string	description. 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/contactnames' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/contactnames 201400

Create.

Requires scope customers:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
tablename	string(100)	Which table the contact belongs to (customer, vendor, shipto).
tablerecordid	integer	Tablerecordid. Id only.
entrydateread-only	string	When the record was created.
firstname	string(100)	Contact first name.
lastname	string(100)	Contact last name.
description	text	Description. Stored as `text`, no practical length limit.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
authorizedbuyer	boolean	True when the contact is an authorized buyer for the account.
taskstatusid	integer	Reference to `taskstatuses`, by id. Write either this or `taskstatus`.
taskstatus	string(100)	The `name` of the referenced taskstatuses, instead of the id. Send this or `taskstatusid`, not both unless they agree.
inactive	integer	1 hides the contact from pickers.
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/contactnames' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "tablename": "Example tablename",
    "tablerecordid": 104,
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "description": "Example description",
    "authorizedbuyer": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/contactnames');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'tablename' => 'Example tablename',
    'tablerecordid' => 104,
    'firstname' => 'Example firstname',
    'lastname' => 'Example lastname',
    'description' => 'Example description',
    'authorizedbuyer' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/contactnames",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "tablename": "Example tablename",
        "tablerecordid": 104,
        "firstname": "Example firstname",
        "lastname": "Example lastname",
        "description": "Example description",
        "authorizedbuyer": False,
    },
)
r.raise_for_status()

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

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

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

Response 201

{
    "tablename": "Example tablename",
    "tablerecordid": 104,
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "description": "Example description",
    "authorizedbuyer": false
}

GET/contactnames/{id} 200404

Retrieve one record.

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

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

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

Response 200

{
    "tablename": "Example tablename",
    "tablerecordid": 104,
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "description": "Example description",
    "authorizedbuyer": false
}

PATCH/contactnames/{id} 200404

Update.

Requires scope customers:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
tablename	string(100)	Which table the contact belongs to (customer, vendor, shipto).
tablerecordid	integer	Tablerecordid. Id only.
entrydateread-only	string	When the record was created.
firstname	string(100)	Contact first name.
lastname	string(100)	Contact last name.
description	text	Description. Stored as `text`, no practical length limit.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
authorizedbuyer	boolean	True when the contact is an authorized buyer for the account.
taskstatusid	integer	Reference to `taskstatuses`, by id. Write either this or `taskstatus`.
taskstatus	string(100)	The `name` of the referenced taskstatuses, instead of the id. Send this or `taskstatusid`, not both unless they agree.
inactive	integer	1 hides the contact from pickers.
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/contactnames/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "tablename": "Example tablename",
    "tablerecordid": 104,
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "description": "Example description",
    "authorizedbuyer": false
}'

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

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/contactnames/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "tablename": "Example tablename",
        "tablerecordid": 104,
        "firstname": "Example firstname",
        "lastname": "Example lastname",
        "description": "Example description",
        "authorizedbuyer": False,
    },
)
r.raise_for_status()

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

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

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

Response 200

{
    "tablename": "Example tablename",
    "tablerecordid": 104,
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "description": "Example description",
    "authorizedbuyer": false
}

DELETE/contactnames/{id} 200404

Cancel.

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

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

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

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

Response 200

{
    "tablename": "Example tablename",
    "tablerecordid": 104,
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "description": "Example description",
    "authorizedbuyer": false
}

B2B users →

Customer-portal logins. Credentials are never returned.

Orders →

Sales orders. One table serves several documents. ordertype is fulfillment, service or rental; status is quote, unconfirmed, open, partial or billed. A quote is status: "quote" - it is not an order type, and it wins over ordertype, so a service order that is still a quote is a quote. Converting a quote to an order is a PATCH of status to open, which commits inventory.