Draws

Construction draws against a job.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(255)	Name of the construction loan draw.
status	integer	Draw status code.
drawtotalmoney	string(6dp)	Stored as `decimal(19,6)`.
drawdate	string	Date of the draw.
retainagemoney	string(2dp)	Stored as `decimal(6,2)`.
retainagetotalmoney	string(6dp)	Stored as `decimal(19,6)`.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
invoiceid	integer	Invoiceid. Id only.
invoice	string(30)	The `invoicenumber` of the referenced invoices, instead of the id. Send this or `invoiceid`, not both unless they agree.
entrydate	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
jobsondraw	text	Jobsondraw. Stored as `text`, no practical length limit.
changeorderaddmoney	string(6dp)	Stored as `decimal(19,6)`.
changeorderdedmoney	string(6dp)	Stored as `decimal(19,6)`.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/draws/batch 207

Create many.

Requires scope jobs:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(255)	Name of the construction loan draw.
status	integer	Draw status code.
drawtotalmoney	string(6dp)	Stored as `decimal(19,6)`.
drawdate	string	Date of the draw.
retainagemoney	string(2dp)	Stored as `decimal(6,2)`.
retainagetotalmoney	string(6dp)	Stored as `decimal(19,6)`.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
invoiceid	integer	Invoiceid. Id only.
invoice	string(30)	The `invoicenumber` of the referenced invoices, instead of the id. Send this or `invoiceid`, not both unless they agree.
entrydate	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
jobsondraw	text	Jobsondraw. Stored as `text`, no practical length limit.
changeorderaddmoney	string(6dp)	Stored as `decimal(19,6)`.
changeorderdedmoney	string(6dp)	Stored as `decimal(19,6)`.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/draws/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "name": "Example name",
        "status": 1,
        "drawtotal": "125.0000",
        "drawdate": "2026-08-01",
        "retainage": "125.0000",
        "retainagetotal": "125.0000"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/draws/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'name' => 'Example name',
      'status' => 1,
      'drawtotal' => '125.0000',
      'drawdate' => '2026-08-01',
      'retainage' => '125.0000',
      'retainagetotal' => '125.0000',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/draws/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "name": "Example name",
            "status": 1,
            "drawtotal": "125.0000",
            "drawdate": "2026-08-01",
            "retainage": "125.0000",
            "retainagetotal": "125.0000",
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/draws/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        name: "Example name",
        status: 1,
        drawtotal: "125.0000",
        drawdate: "2026-08-01",
        retainage: "125.0000",
        retainagetotal: "125.0000",
      },
    ]),
  }
);
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 {
        name = "Example name",
        status = 1,
        drawtotal = "125.0000",
        drawdate = "2026-08-01",
        retainage = "125.0000",
        retainagetotal = "125.0000",
    },
};

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

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

GET/draws 200403

List draws.

Requires scope jobs:read.

Parameters

Name	In	Type	Notes
status	query	string	Restrict to one status.
customerid	query	string	Restrict to one customerid.
invoiceid	query	string	Restrict to one invoiceid.
name	query	string	name. 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/draws' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/draws 201400

Create.

Requires scope jobs:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(255)	Name of the construction loan draw.
status	integer	Draw status code.
drawtotalmoney	string(6dp)	Stored as `decimal(19,6)`.
drawdate	string	Date of the draw.
retainagemoney	string(2dp)	Stored as `decimal(6,2)`.
retainagetotalmoney	string(6dp)	Stored as `decimal(19,6)`.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
invoiceid	integer	Invoiceid. Id only.
invoice	string(30)	The `invoicenumber` of the referenced invoices, instead of the id. Send this or `invoiceid`, not both unless they agree.
entrydate	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
jobsondraw	text	Jobsondraw. Stored as `text`, no practical length limit.
changeorderaddmoney	string(6dp)	Stored as `decimal(19,6)`.
changeorderdedmoney	string(6dp)	Stored as `decimal(19,6)`.
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/draws' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "name": "Example name",
    "status": 1,
    "drawtotal": "125.0000",
    "drawdate": "2026-08-01",
    "retainage": "125.0000",
    "retainagetotal": "125.0000"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/draws');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'name' => 'Example name',
    'status' => 1,
    'drawtotal' => '125.0000',
    'drawdate' => '2026-08-01',
    'retainage' => '125.0000',
    'retainagetotal' => '125.0000',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/draws",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "name": "Example name",
        "status": 1,
        "drawtotal": "125.0000",
        "drawdate": "2026-08-01",
        "retainage": "125.0000",
        "retainagetotal": "125.0000",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/draws',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      name: "Example name",
      status: 1,
      drawtotal: "125.0000",
      drawdate: "2026-08-01",
      retainage: "125.0000",
      retainagetotal: "125.0000",
    }),
  }
);
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 {
    name = "Example name",
    status = 1,
    drawtotal = "125.0000",
    drawdate = "2026-08-01",
    retainage = "125.0000",
    retainagetotal = "125.0000",
};

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

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

Response 201

{
    "name": "Example name",
    "status": 1,
    "drawtotal": "125.0000",
    "drawdate": "2026-08-01",
    "retainage": "125.0000",
    "retainagetotal": "125.0000"
}

GET/draws/{id} 200404

Retrieve one record.

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

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

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

Response 200

{
    "name": "Example name",
    "status": 1,
    "drawtotal": "125.0000",
    "drawdate": "2026-08-01",
    "retainage": "125.0000",
    "retainagetotal": "125.0000"
}

PATCH/draws/{id} 200404

Update.

Requires scope jobs:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(255)	Name of the construction loan draw.
status	integer	Draw status code.
drawtotalmoney	string(6dp)	Stored as `decimal(19,6)`.
drawdate	string	Date of the draw.
retainagemoney	string(2dp)	Stored as `decimal(6,2)`.
retainagetotalmoney	string(6dp)	Stored as `decimal(19,6)`.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
invoiceid	integer	Invoiceid. Id only.
invoice	string(30)	The `invoicenumber` of the referenced invoices, instead of the id. Send this or `invoiceid`, not both unless they agree.
entrydate	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
jobsondraw	text	Jobsondraw. Stored as `text`, no practical length limit.
changeorderaddmoney	string(6dp)	Stored as `decimal(19,6)`.
changeorderdedmoney	string(6dp)	Stored as `decimal(19,6)`.
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/draws/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "name": "Example name",
    "status": 1,
    "drawtotal": "125.0000",
    "drawdate": "2026-08-01",
    "retainage": "125.0000",
    "retainagetotal": "125.0000"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/draws/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'name' => 'Example name',
    'status' => 1,
    'drawtotal' => '125.0000',
    'drawdate' => '2026-08-01',
    'retainage' => '125.0000',
    'retainagetotal' => '125.0000',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/draws/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "name": "Example name",
        "status": 1,
        "drawtotal": "125.0000",
        "drawdate": "2026-08-01",
        "retainage": "125.0000",
        "retainagetotal": "125.0000",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/draws/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      name: "Example name",
      status: 1,
      drawtotal: "125.0000",
      drawdate: "2026-08-01",
      retainage: "125.0000",
      retainagetotal: "125.0000",
    }),
  }
);
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 {
    name = "Example name",
    status = 1,
    drawtotal = "125.0000",
    drawdate = "2026-08-01",
    retainage = "125.0000",
    retainagetotal = "125.0000",
};

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

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

Response 200

{
    "name": "Example name",
    "status": 1,
    "drawtotal": "125.0000",
    "drawdate": "2026-08-01",
    "retainage": "125.0000",
    "retainagetotal": "125.0000"
}

DELETE/draws/{id} 200404

Cancel.

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

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

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

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

Response 200

{
    "name": "Example name",
    "status": 1,
    "drawtotal": "125.0000",
    "drawdate": "2026-08-01",
    "retainage": "125.0000",
    "retainagetotal": "125.0000"
}

Service order statuses →

Custom service order statuses ("In Progress", "Waiting for Parts", "Order Complete"...). Referenced by statusid on a service order; complete marks the statuses that mean the work is done.

Bank accounts →

Read-only. Bank accounts carry accountnumber, positive-pay SFTP credentials and private keys. Those are never returned, and the account is not writable through the API - changing where money moves is not an integration operation.