Customer groups

Customer groups, the target of customer.groupid. Not to be confused with customergroup, which is a customer-to-group join table and is not exposed.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
groupcode	string(20)	The code this resource is keyed by. Matching is case insensitive.
groupname	string(255)	Full group name.
multipliernumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this customer groups. Scoped to your company.
lastchangedateread-only	string	Last modification (`lastchangedate`). Drives `modifiedsince`.

Endpoints#

POST/igroups/batch 207

Create many.

Always answers 207, one result per item.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
groupcode	string(20)	The code this resource is keyed by. Matching is case insensitive.
groupname	string(255)	Full group name.
multipliernumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this customer groups. Scoped to your company.
lastchangedateread-only	string	Last modification (`lastchangedate`). Drives `modifiedsince`.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/igroups/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "id": 4,
        "groupcode": "DIM",
        "groupname": "Dimension Insurance",
        "multiplier": "1.0000",
        "cancel": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/igroups/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'id' => 4,
      'groupcode' => 'DIM',
      'groupname' => 'Dimension Insurance',
      'multiplier' => '1.0000',
      'cancel' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/igroups/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "id": 4,
            "groupcode": "DIM",
            "groupname": "Dimension Insurance",
            "multiplier": "1.0000",
            "cancel": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/igroups/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        id: 4,
        groupcode: "DIM",
        groupname: "Dimension Insurance",
        multiplier: "1.0000",
        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 = 4,
        groupcode = "DIM",
        groupname = "Dimension Insurance",
        multiplier = "1.0000",
        cancel = false,
    },
};

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

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

GET/igroups 200403

List customer groups.

Requires scope setup:read.

Parameters

Name	In	Type	Notes
groupcode	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` for cancelled only, 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. Scoped to your company.
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 `igroups:read`.

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

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

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

POST/igroups 201400409

Create.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
groupcode	string(20)	The code this resource is keyed by. Matching is case insensitive.
groupname	string(255)	Full group name.
multipliernumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this customer groups. Scoped to your company.
lastchangedateread-only	string	Last modification (`lastchangedate`). Drives `modifiedsince`.

When it fails

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

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/igroups' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 4,
    "groupcode": "DIM",
    "groupname": "Dimension Insurance",
    "multiplier": "1.0000",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/igroups');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 4,
    'groupcode' => 'DIM',
    'groupname' => 'Dimension Insurance',
    'multiplier' => '1.0000',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/igroups",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 4,
        "groupcode": "DIM",
        "groupname": "Dimension Insurance",
        "multiplier": "1.0000",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/igroups',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 4,
      groupcode: "DIM",
      groupname: "Dimension Insurance",
      multiplier: "1.0000",
      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 = 4,
    groupcode = "DIM",
    groupname = "Dimension Insurance",
    multiplier = "1.0000",
    cancel = false,
};

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

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

Response 201

{
    "id": 4,
    "groupcode": "DIM",
    "groupname": "Dimension Insurance",
    "multiplier": "1.0000",
    "cancel": false
}

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

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

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

Response 200

{
    "id": 4,
    "groupcode": "DIM",
    "groupname": "Dimension Insurance",
    "multiplier": "1.0000",
    "cancel": false
}

PATCH/igroups/{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.
groupcode	string(20)	The code this resource is keyed by. Matching is case insensitive.
groupname	string(255)	Full group name.
multipliernumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this customer groups. Scoped to your company.
lastchangedateread-only	string	Last modification (`lastchangedate`). 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/igroups/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 4,
    "groupcode": "DIM",
    "groupname": "Dimension Insurance",
    "multiplier": "1.0000",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/igroups/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 4,
    'groupcode' => 'DIM',
    'groupname' => 'Dimension Insurance',
    'multiplier' => '1.0000',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/igroups/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 4,
        "groupcode": "DIM",
        "groupname": "Dimension Insurance",
        "multiplier": "1.0000",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/igroups/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 4,
      groupcode: "DIM",
      groupname: "Dimension Insurance",
      multiplier: "1.0000",
      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 = 4,
    groupcode = "DIM",
    groupname = "Dimension Insurance",
    multiplier = "1.0000",
    cancel = false,
};

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

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

Response 200

{
    "id": 4,
    "groupcode": "DIM",
    "groupname": "Dimension Insurance",
    "multiplier": "1.0000",
    "cancel": false
}

DELETE/igroups/{id} 200403404

Cancel.

Sets the cancel flag. Nothing is removed.

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 `igroups:cancel`.
404	not_found	No record with that id.

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

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

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

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

Response 200

{
    "id": 4,
    "groupcode": "DIM",
    "groupname": "Dimension Insurance",
    "multiplier": "1.0000",
    "cancel": false
}

Areas →

Geographic or sales areas. Empty on many installs.

Assets →

Fixed assets.