Vendor order-from addresses

Alternate addresses a vendor is ordered from.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
vendorid	integer	Reference to `vendors`, by id. Write either this or `vendor`.
vendor	string(30)	Code for the referenced vendor, instead of the id.
companyname	string(100)	Company name on this Order From address.
contactname	string(100)	Ordering contact at this address.
address	string(100)	Address. Stored as `text`, no practical length limit.
address2	string(100)	Second address line.
city	string(50)	City of the address.
state	string(20)	State of the address.
zip	string(15)	Postal code.
country	string(20)	Country of the address.
phone	string(20)	Phone number of the ordering contact.
fax	string(20)	Fax number purchase orders are sent to.
email	string(50)	Email address.
mailstop	string(20)	Mail stop line printed with the address.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
addressverifiedread-only	string(32)	Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/vendororderfroms/batch 207

Create many.

Requires scope vendors:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
vendorid	integer	Reference to `vendors`, by id. Write either this or `vendor`.
vendor	string(30)	Code for the referenced vendor, instead of the id.
companyname	string(100)	Company name on this Order From address.
contactname	string(100)	Ordering contact at this address.
address	string(100)	Address. Stored as `text`, no practical length limit.
address2	string(100)	Second address line.
city	string(50)	City of the address.
state	string(20)	State of the address.
zip	string(15)	Postal code.
country	string(20)	Country of the address.
phone	string(20)	Phone number of the ordering contact.
fax	string(20)	Fax number purchase orders are sent to.
email	string(50)	Email address.
mailstop	string(20)	Mail stop line printed with the address.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
addressverifiedread-only	string(32)	Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/vendororderfroms/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "vendorid": 104,
        "vendor": "Example vendor",
        "companyname": "Example companyname",
        "contactname": "Example contactname",
        "address": "Example address",
        "address2": "Example address2"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/vendororderfroms/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'vendorid' => 104,
      'vendor' => 'Example vendor',
      'companyname' => 'Example companyname',
      'contactname' => 'Example contactname',
      'address' => 'Example address',
      'address2' => 'Example address2',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/vendororderfroms/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "vendorid": 104,
            "vendor": "Example vendor",
            "companyname": "Example companyname",
            "contactname": "Example contactname",
            "address": "Example address",
            "address2": "Example address2",
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/vendororderfroms/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        vendorid: 104,
        vendor: "Example vendor",
        companyname: "Example companyname",
        contactname: "Example contactname",
        address: "Example address",
        address2: "Example address2",
      },
    ]),
  }
);
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 {
        vendorid = 104,
        vendor = "Example vendor",
        companyname = "Example companyname",
        contactname = "Example contactname",
        address = "Example address",
        address2 = "Example address2",
    },
};

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

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

GET/vendororderfroms 200403

List vendor order-from addresses.

Requires scope vendors:read.

Parameters

Name	In	Type	Notes
vendorid	query	string	Restrict to one vendorid.
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/vendororderfroms' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/vendororderfroms 201400

Create.

Requires scope vendors:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
vendorid	integer	Reference to `vendors`, by id. Write either this or `vendor`.
vendor	string(30)	Code for the referenced vendor, instead of the id.
companyname	string(100)	Company name on this Order From address.
contactname	string(100)	Ordering contact at this address.
address	string(100)	Address. Stored as `text`, no practical length limit.
address2	string(100)	Second address line.
city	string(50)	City of the address.
state	string(20)	State of the address.
zip	string(15)	Postal code.
country	string(20)	Country of the address.
phone	string(20)	Phone number of the ordering contact.
fax	string(20)	Fax number purchase orders are sent to.
email	string(50)	Email address.
mailstop	string(20)	Mail stop line printed with the address.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
addressverifiedread-only	string(32)	Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API.
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/vendororderfroms' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "vendorid": 104,
    "vendor": "Example vendor",
    "companyname": "Example companyname",
    "contactname": "Example contactname",
    "address": "Example address",
    "address2": "Example address2"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/vendororderfroms');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'vendorid' => 104,
    'vendor' => 'Example vendor',
    'companyname' => 'Example companyname',
    'contactname' => 'Example contactname',
    'address' => 'Example address',
    'address2' => 'Example address2',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/vendororderfroms",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "vendorid": 104,
        "vendor": "Example vendor",
        "companyname": "Example companyname",
        "contactname": "Example contactname",
        "address": "Example address",
        "address2": "Example address2",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/vendororderfroms',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      vendorid: 104,
      vendor: "Example vendor",
      companyname: "Example companyname",
      contactname: "Example contactname",
      address: "Example address",
      address2: "Example address2",
    }),
  }
);
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 {
    vendorid = 104,
    vendor = "Example vendor",
    companyname = "Example companyname",
    contactname = "Example contactname",
    address = "Example address",
    address2 = "Example address2",
};

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

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

Response 201

{
    "vendorid": 104,
    "vendor": "Example vendor",
    "companyname": "Example companyname",
    "contactname": "Example contactname",
    "address": "Example address",
    "address2": "Example address2"
}

GET/vendororderfroms/{id} 200404

Retrieve one record.

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

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

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

Response 200

{
    "vendorid": 104,
    "vendor": "Example vendor",
    "companyname": "Example companyname",
    "contactname": "Example contactname",
    "address": "Example address",
    "address2": "Example address2"
}

PATCH/vendororderfroms/{id} 200404

Update.

Requires scope vendors:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
vendorid	integer	Reference to `vendors`, by id. Write either this or `vendor`.
vendor	string(30)	Code for the referenced vendor, instead of the id.
companyname	string(100)	Company name on this Order From address.
contactname	string(100)	Ordering contact at this address.
address	string(100)	Address. Stored as `text`, no practical length limit.
address2	string(100)	Second address line.
city	string(50)	City of the address.
state	string(20)	State of the address.
zip	string(15)	Postal code.
country	string(20)	Country of the address.
phone	string(20)	Phone number of the ordering contact.
fax	string(20)	Fax number purchase orders are sent to.
email	string(50)	Email address.
mailstop	string(20)	Mail stop line printed with the address.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
addressverifiedread-only	string(32)	Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API.
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/vendororderfroms/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "vendorid": 104,
    "vendor": "Example vendor",
    "companyname": "Example companyname",
    "contactname": "Example contactname",
    "address": "Example address",
    "address2": "Example address2"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/vendororderfroms/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'vendorid' => 104,
    'vendor' => 'Example vendor',
    'companyname' => 'Example companyname',
    'contactname' => 'Example contactname',
    'address' => 'Example address',
    'address2' => 'Example address2',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/vendororderfroms/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "vendorid": 104,
        "vendor": "Example vendor",
        "companyname": "Example companyname",
        "contactname": "Example contactname",
        "address": "Example address",
        "address2": "Example address2",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/vendororderfroms/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      vendorid: 104,
      vendor: "Example vendor",
      companyname: "Example companyname",
      contactname: "Example contactname",
      address: "Example address",
      address2: "Example address2",
    }),
  }
);
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 {
    vendorid = 104,
    vendor = "Example vendor",
    companyname = "Example companyname",
    contactname = "Example contactname",
    address = "Example address",
    address2 = "Example address2",
};

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

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

Response 200

{
    "vendorid": 104,
    "vendor": "Example vendor",
    "companyname": "Example companyname",
    "contactname": "Example contactname",
    "address": "Example address",
    "address2": "Example address2"
}

DELETE/vendororderfroms/{id} 200404

Cancel.

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

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

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

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

Response 200

{
    "vendorid": 104,
    "vendor": "Example vendor",
    "companyname": "Example companyname",
    "contactname": "Example contactname",
    "address": "Example address",
    "address2": "Example address2"
}

Purchase orders →

Purchase orders to a vendor. A proposal is status: "proposal", the same shape as an AR quote. ponumber is assigned under a lock when omitted.

PO lines →

Lines on a purchase order. Normally sent nested inside the PO.