B2B users

Customer-portal logins. Credentials are never returned.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
firstname	string(100)	The portal user’s first name.
lastname	string(100)	The portal user’s last name.
loginname	string(100)	Login name for the B2B portal. Customers and vendors sign in to the portal with this, not with a NolaPro user account.
usertype	integer	What kind of portal user this is: 1 = customer contact, 2 = vendor contact, 0 = self-registered appointments login (no linked record). Legacy values 3 and 4 are treated as vendor.
referenceid	integer	The customer id (`usertype` 1) or vendor id (`usertype` 2) this login belongs to. Polymorphic, so there is no code sibling - send the id.
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`.
email	string(255)	Email address. Password resets and portal notifications go here.
viewedprivacypolicymessageread-only	integer	Set to 1 when the portal user dismisses the privacy-policy notice. It records the user’s own acknowledgment, so it cannot be written through the API.
wpemailconfirmedread-only	string(255)	Email address the appointments (external WordPress) login flow has verified. Set only when the user completes the emailed verification link, so it cannot be written through the API.
wpemailunconfirmedread-only	string(255)	Address awaiting verification in the appointments login flow. Moves to `wpemailconfirmed` when the user clicks the emailed link.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/b2busers/batch 207

Create many.

Requires scope customers:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
firstname	string(100)	The portal user’s first name.
lastname	string(100)	The portal user’s last name.
loginname	string(100)	Login name for the B2B portal. Customers and vendors sign in to the portal with this, not with a NolaPro user account.
usertype	integer	What kind of portal user this is: 1 = customer contact, 2 = vendor contact, 0 = self-registered appointments login (no linked record). Legacy values 3 and 4 are treated as vendor.
referenceid	integer	The customer id (`usertype` 1) or vendor id (`usertype` 2) this login belongs to. Polymorphic, so there is no code sibling - send the id.
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`.
email	string(255)	Email address. Password resets and portal notifications go here.
viewedprivacypolicymessageread-only	integer	Set to 1 when the portal user dismisses the privacy-policy notice. It records the user’s own acknowledgment, so it cannot be written through the API.
wpemailconfirmedread-only	string(255)	Email address the appointments (external WordPress) login flow has verified. Set only when the user completes the emailed verification link, so it cannot be written through the API.
wpemailunconfirmedread-only	string(255)	Address awaiting verification in the appointments login flow. Moves to `wpemailconfirmed` when the user clicks the emailed link.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/b2busers/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "firstname": "Example firstname",
        "lastname": "Example lastname",
        "loginname": "Example loginname",
        "usertype": 1,
        "referenceid": 104,
        "email": "Example email"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/b2busers/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'firstname' => 'Example firstname',
      'lastname' => 'Example lastname',
      'loginname' => 'Example loginname',
      'usertype' => 1,
      'referenceid' => 104,
      'email' => 'Example email',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/b2busers/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "firstname": "Example firstname",
            "lastname": "Example lastname",
            "loginname": "Example loginname",
            "usertype": 1,
            "referenceid": 104,
            "email": "Example email",
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/b2busers/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        firstname: "Example firstname",
        lastname: "Example lastname",
        loginname: "Example loginname",
        usertype: 1,
        referenceid: 104,
        email: "Example email",
      },
    ]),
  }
);
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 {
        firstname = "Example firstname",
        lastname = "Example lastname",
        loginname = "Example loginname",
        usertype = 1,
        referenceid = 104,
        email = "Example email",
    },
};

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

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

GET/b2busers 200403

List b2b users.

Requires scope customers:read.

Parameters

Name	In	Type	Notes
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/b2busers' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/b2busers 201400

Create.

Requires scope customers:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
firstname	string(100)	The portal user’s first name.
lastname	string(100)	The portal user’s last name.
loginname	string(100)	Login name for the B2B portal. Customers and vendors sign in to the portal with this, not with a NolaPro user account.
usertype	integer	What kind of portal user this is: 1 = customer contact, 2 = vendor contact, 0 = self-registered appointments login (no linked record). Legacy values 3 and 4 are treated as vendor.
referenceid	integer	The customer id (`usertype` 1) or vendor id (`usertype` 2) this login belongs to. Polymorphic, so there is no code sibling - send the id.
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`.
email	string(255)	Email address. Password resets and portal notifications go here.
viewedprivacypolicymessageread-only	integer	Set to 1 when the portal user dismisses the privacy-policy notice. It records the user’s own acknowledgment, so it cannot be written through the API.
wpemailconfirmedread-only	string(255)	Email address the appointments (external WordPress) login flow has verified. Set only when the user completes the emailed verification link, so it cannot be written through the API.
wpemailunconfirmedread-only	string(255)	Address awaiting verification in the appointments login flow. Moves to `wpemailconfirmed` when the user clicks the emailed link.
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/b2busers' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "loginname": "Example loginname",
    "usertype": 1,
    "referenceid": 104,
    "email": "Example email"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/b2busers');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'firstname' => 'Example firstname',
    'lastname' => 'Example lastname',
    'loginname' => 'Example loginname',
    'usertype' => 1,
    'referenceid' => 104,
    'email' => 'Example email',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/b2busers",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "firstname": "Example firstname",
        "lastname": "Example lastname",
        "loginname": "Example loginname",
        "usertype": 1,
        "referenceid": 104,
        "email": "Example email",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/b2busers',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      firstname: "Example firstname",
      lastname: "Example lastname",
      loginname: "Example loginname",
      usertype: 1,
      referenceid: 104,
      email: "Example email",
    }),
  }
);
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 {
    firstname = "Example firstname",
    lastname = "Example lastname",
    loginname = "Example loginname",
    usertype = 1,
    referenceid = 104,
    email = "Example email",
};

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

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

Response 201

{
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "loginname": "Example loginname",
    "usertype": 1,
    "referenceid": 104,
    "email": "Example email"
}

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

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

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

Response 200

{
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "loginname": "Example loginname",
    "usertype": 1,
    "referenceid": 104,
    "email": "Example email"
}

PATCH/b2busers/{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.
firstname	string(100)	The portal user’s first name.
lastname	string(100)	The portal user’s last name.
loginname	string(100)	Login name for the B2B portal. Customers and vendors sign in to the portal with this, not with a NolaPro user account.
usertype	integer	What kind of portal user this is: 1 = customer contact, 2 = vendor contact, 0 = self-registered appointments login (no linked record). Legacy values 3 and 4 are treated as vendor.
referenceid	integer	The customer id (`usertype` 1) or vendor id (`usertype` 2) this login belongs to. Polymorphic, so there is no code sibling - send the id.
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`.
email	string(255)	Email address. Password resets and portal notifications go here.
viewedprivacypolicymessageread-only	integer	Set to 1 when the portal user dismisses the privacy-policy notice. It records the user’s own acknowledgment, so it cannot be written through the API.
wpemailconfirmedread-only	string(255)	Email address the appointments (external WordPress) login flow has verified. Set only when the user completes the emailed verification link, so it cannot be written through the API.
wpemailunconfirmedread-only	string(255)	Address awaiting verification in the appointments login flow. Moves to `wpemailconfirmed` when the user clicks the emailed link.
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/b2busers/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "loginname": "Example loginname",
    "usertype": 1,
    "referenceid": 104,
    "email": "Example email"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/b2busers/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'firstname' => 'Example firstname',
    'lastname' => 'Example lastname',
    'loginname' => 'Example loginname',
    'usertype' => 1,
    'referenceid' => 104,
    'email' => 'Example email',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/b2busers/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "firstname": "Example firstname",
        "lastname": "Example lastname",
        "loginname": "Example loginname",
        "usertype": 1,
        "referenceid": 104,
        "email": "Example email",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/b2busers/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      firstname: "Example firstname",
      lastname: "Example lastname",
      loginname: "Example loginname",
      usertype: 1,
      referenceid: 104,
      email: "Example email",
    }),
  }
);
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 {
    firstname = "Example firstname",
    lastname = "Example lastname",
    loginname = "Example loginname",
    usertype = 1,
    referenceid = 104,
    email = "Example email",
};

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

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

Response 200

{
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "loginname": "Example loginname",
    "usertype": 1,
    "referenceid": 104,
    "email": "Example email"
}

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

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

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

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

Response 200

{
    "firstname": "Example firstname",
    "lastname": "Example lastname",
    "loginname": "Example loginname",
    "usertype": 1,
    "referenceid": 104,
    "email": "Example email"
}

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.

Order lines →

Lines on an order. Normally sent nested inside the order. arorderdetail has no cancel column, so DELETE removes the row and renumbers its siblings rather than cancelling it.