Assets
Fixed assets.
The object#
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| name | string(255) | Asset name. |
| description | text | Description. Stored as text, no practical length limit. |
| notes | text | Notes. Stored as text, no practical length limit. |
| assetcategoryid | integer | Assetcategoryid. Id only. |
| manufacturervendorid | integer | Reference to vendors, by id. Write either this or manufacturervendor. |
| manufacturervendor | string(30) | The vendorcode of the referenced vendors, instead of the id. Send this or manufacturervendorid, not both unless they agree. |
| inventorylocationid | integer | Inventorylocationid. Id only. |
| inventorylocation | string(20) | The locationcode of the referenced inventorylocations, instead of the id. Send this or inventorylocationid, not both unless they agree. |
| itemid | integer | Reference to items, by id. Write either this or item. |
| item | string(255) | The sku of the referenced items, instead of the id. Send this or itemid, not both unless they agree. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| entrydateread-only | string | When the record was created. |
| lastchangedateread-only | string | Last modification. Drives modifiedsince. |
| cancel | boolean | Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable. |
| costmoney | string(6dp) | Stored as decimal(19,6). |
| currency | string(10) | Currency the asset was purchased in. |
| purchasedate | string | Date the asset was purchased. |
| disposeddate | string | Date the asset was disposed of. |
| serialnumber | string(255) | Serial number of the asset. |
| manufacturedate | string | Date the asset was manufactured. |
| shiptoid | integer | Shiptoid. Id only. |
| ownertype | integer | Who owns the asset: 0 = company, 1 = customer, 2 = vendor. Only company-owned fixed assets depreciate. |
| vendorid | integer | Reference to vendors, by id. Write either this or vendor. |
| vendor | string(30) | Code for the referenced vendor, instead of the id. |
| modelnumber | string(255) | Model number of the asset. |
| assettype | integer | Asset class: 0 = fixed asset, 1 = current asset, 2 = intangible asset, 3 = investment. Only fixed assets depreciate. |
| salvagevaluemoney | string(6dp) | Stored as decimal(19,6). |
| usefullifeinyearsmoney | string(6dp) | Stored as decimal(19,6). |
| assetglaccountid | integer | Reference to glaccounts, by id. Write either this or assetglaccount. |
| assetglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or assetglaccountid, not both unless they agree. |
| accumulateddepreciationglaccountid | integer | Reference to glaccounts, by id. Write either this or accumulateddepreciationglaccount. |
| accumulateddepreciationglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or accumulateddepreciationglaccountid, not both unless they agree. |
| expenseglaccountid | integer | Reference to glaccounts, by id. Write either this or expenseglaccount. |
| expenseglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or expenseglaccountid, not both unless they agree. |
| parentassetid | integer | Parentassetid. Id only. |
| invpoid | integer | Invpoid. Id only. |
| invpodetailid | integer | Invpodetailid. Id only. |
| apbillid | integer | Apbillid. Id only. |
| apbilldetailid | integer | Apbilldetailid. Id only. |
| arinvoiceid | integer | Arinvoiceid. Id only. |
| arinvoice | string(30) | The invoicenumber of the referenced invoices, instead of the id. Send this or arinvoiceid, not both unless they agree. |
| arinvoicedetailid | integer | Arinvoicedetailid. Id only. |
| arorderid | integer | Arorderid. Id only. |
| arorderdetailid | integer | Arorderdetailid. Id only. |
| clonedfromassetid | integer | Clonedfromassetid. Id only. |
| invreceiveitemtransactionid | integer | Invreceiveitemtransactionid. Id only. |
| assetitemtransactionid | integer | Assetitemtransactionid. Id only. |
| returnassetitemtransactionid | integer | Returnassetitemtransactionid. Id only. |
| jobid | integer | Jobid. Id only. |
| costcodeid | integer | Cost code. |
| costcode | string(20) | Code for the referenced costcode, instead of the id. |
| glcategoryid | integer | Glcategoryid. Id only. |
| glcategory | string(20) | The code of the referenced glcategories, instead of the id. Send this or glcategoryid, not both unless they agree. |
| depreciationcalculationmethod | integer | Depreciation method: 0 = straight line, 1 = double declining balance, 2 = units of production. |
| depreciationcalculatedasofread-only | string | Date depreciation has been calculated through. Maintained by the depreciation run, so it cannot be written through the API. |
| usefullifeinproductionunitsmoney | string(6dp) | Stored as decimal(18,6). |
| inventoryglaccountid | integer | Reference to glaccounts, by id. Write either this or inventoryglaccount. |
| inventoryglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or inventoryglaccountid, not both unless they agree. |
| expensedepreciationglaccountid | integer | Reference to glaccounts, by id. Write either this or expensedepreciationglaccount. |
| expensedepreciationglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or expensedepreciationglaccountid, not both unless they agree. |
| assetvoucherid | integer | Assetvoucherid. Id only. |
| assetvoucher | string(50) | The voucher of the referenced gltransactions, instead of the id. Send this or assetvoucherid, not both unless they agree. |
| manufacturer | string(255) | Manufacturer of the asset. |
| externalid | string(100) | Your own key. Scoped to your company. |
Endpoints#
POST/assets/batch
207
Create many.
Requires scope assets:write.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
Body array
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| name | string(255) | Asset name. |
| description | text | Description. Stored as text, no practical length limit. |
| notes | text | Notes. Stored as text, no practical length limit. |
| assetcategoryid | integer | Assetcategoryid. Id only. |
| manufacturervendorid | integer | Reference to vendors, by id. Write either this or manufacturervendor. |
| manufacturervendor | string(30) | The vendorcode of the referenced vendors, instead of the id. Send this or manufacturervendorid, not both unless they agree. |
| inventorylocationid | integer | Inventorylocationid. Id only. |
| inventorylocation | string(20) | The locationcode of the referenced inventorylocations, instead of the id. Send this or inventorylocationid, not both unless they agree. |
| itemid | integer | Reference to items, by id. Write either this or item. |
| item | string(255) | The sku of the referenced items, instead of the id. Send this or itemid, not both unless they agree. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| entrydateread-only | string | When the record was created. |
| lastchangedateread-only | string | Last modification. Drives modifiedsince. |
| cancel | boolean | Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable. |
| costmoney | string(6dp) | Stored as decimal(19,6). |
| currency | string(10) | Currency the asset was purchased in. |
| purchasedate | string | Date the asset was purchased. |
| disposeddate | string | Date the asset was disposed of. |
| serialnumber | string(255) | Serial number of the asset. |
| manufacturedate | string | Date the asset was manufactured. |
| shiptoid | integer | Shiptoid. Id only. |
| ownertype | integer | Who owns the asset: 0 = company, 1 = customer, 2 = vendor. Only company-owned fixed assets depreciate. |
| vendorid | integer | Reference to vendors, by id. Write either this or vendor. |
| vendor | string(30) | Code for the referenced vendor, instead of the id. |
| modelnumber | string(255) | Model number of the asset. |
| assettype | integer | Asset class: 0 = fixed asset, 1 = current asset, 2 = intangible asset, 3 = investment. Only fixed assets depreciate. |
| salvagevaluemoney | string(6dp) | Stored as decimal(19,6). |
| usefullifeinyearsmoney | string(6dp) | Stored as decimal(19,6). |
| assetglaccountid | integer | Reference to glaccounts, by id. Write either this or assetglaccount. |
| assetglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or assetglaccountid, not both unless they agree. |
| accumulateddepreciationglaccountid | integer | Reference to glaccounts, by id. Write either this or accumulateddepreciationglaccount. |
| accumulateddepreciationglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or accumulateddepreciationglaccountid, not both unless they agree. |
| expenseglaccountid | integer | Reference to glaccounts, by id. Write either this or expenseglaccount. |
| expenseglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or expenseglaccountid, not both unless they agree. |
| parentassetid | integer | Parentassetid. Id only. |
| invpoid | integer | Invpoid. Id only. |
| invpodetailid | integer | Invpodetailid. Id only. |
| apbillid | integer | Apbillid. Id only. |
| apbilldetailid | integer | Apbilldetailid. Id only. |
| arinvoiceid | integer | Arinvoiceid. Id only. |
| arinvoice | string(30) | The invoicenumber of the referenced invoices, instead of the id. Send this or arinvoiceid, not both unless they agree. |
| arinvoicedetailid | integer | Arinvoicedetailid. Id only. |
| arorderid | integer | Arorderid. Id only. |
| arorderdetailid | integer | Arorderdetailid. Id only. |
| clonedfromassetid | integer | Clonedfromassetid. Id only. |
| invreceiveitemtransactionid | integer | Invreceiveitemtransactionid. Id only. |
| assetitemtransactionid | integer | Assetitemtransactionid. Id only. |
| returnassetitemtransactionid | integer | Returnassetitemtransactionid. Id only. |
| jobid | integer | Jobid. Id only. |
| costcodeid | integer | Cost code. |
| costcode | string(20) | Code for the referenced costcode, instead of the id. |
| glcategoryid | integer | Glcategoryid. Id only. |
| glcategory | string(20) | The code of the referenced glcategories, instead of the id. Send this or glcategoryid, not both unless they agree. |
| depreciationcalculationmethod | integer | Depreciation method: 0 = straight line, 1 = double declining balance, 2 = units of production. |
| depreciationcalculatedasofread-only | string | Date depreciation has been calculated through. Maintained by the depreciation run, so it cannot be written through the API. |
| usefullifeinproductionunitsmoney | string(6dp) | Stored as decimal(18,6). |
| inventoryglaccountid | integer | Reference to glaccounts, by id. Write either this or inventoryglaccount. |
| inventoryglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or inventoryglaccountid, not both unless they agree. |
| expensedepreciationglaccountid | integer | Reference to glaccounts, by id. Write either this or expensedepreciationglaccount. |
| expensedepreciationglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or expensedepreciationglaccountid, not both unless they agree. |
| assetvoucherid | integer | Assetvoucherid. Id only. |
| assetvoucher | string(50) | The voucher of the referenced gltransactions, instead of the id. Send this or assetvoucherid, not both unless they agree. |
| manufacturer | string(255) | Manufacturer of the asset. |
| externalid | string(100) | Your own key. Scoped to your company. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/assets/batch' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '[ { "name": "Example name", "description": "Example description", "notes": "Example notes", "assetcategoryid": 104, "manufacturervendorid": 104, "manufacturervendor": "Example manufacturervendor" } ]'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/assets/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', 'description' => 'Example description', 'notes' => 'Example notes', 'assetcategoryid' => 104, 'manufacturervendorid' => 104, 'manufacturervendor' => 'Example manufacturervendor', ], ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/assets/batch", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json=[ { "name": "Example name", "description": "Example description", "notes": "Example notes", "assetcategoryid": 104, "manufacturervendorid": 104, "manufacturervendor": "Example manufacturervendor", }, ], ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/assets/batch', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify([ { name: "Example name", description: "Example description", notes: "Example notes", assetcategoryid: 104, manufacturervendorid: 104, manufacturervendor: "Example manufacturervendor", }, ]), } ); 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", description = "Example description", notes = "Example notes", assetcategoryid = 104, manufacturervendorid = 104, manufacturervendor = "Example manufacturervendor", }, }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/assets/batch") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
GET/assets
200403
List assets.
Requires scope assets:read.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| customerid | query | string | Restrict to one customerid. |
| vendorid | query | string | Restrict to one vendorid. |
| itemid | query | string | Restrict to one itemid. |
| inventorylocationid | query | string | Restrict to one inventorylocationid. |
| jobid | query | string | Restrict to one jobid. |
| arinvoiceid | query | string | Restrict to one arinvoiceid. |
| invpoid | query | string | Restrict to one invpoid. |
| name | query | string | name. Partial match, case-insensitive. |
| 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/assets' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/assets'); 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/assets", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/assets', { 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/assets"); res.EnsureSuccessStatusCode();
POST/assets
201400
Create.
Requires scope assets:write.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
Body
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| name | string(255) | Asset name. |
| description | text | Description. Stored as text, no practical length limit. |
| notes | text | Notes. Stored as text, no practical length limit. |
| assetcategoryid | integer | Assetcategoryid. Id only. |
| manufacturervendorid | integer | Reference to vendors, by id. Write either this or manufacturervendor. |
| manufacturervendor | string(30) | The vendorcode of the referenced vendors, instead of the id. Send this or manufacturervendorid, not both unless they agree. |
| inventorylocationid | integer | Inventorylocationid. Id only. |
| inventorylocation | string(20) | The locationcode of the referenced inventorylocations, instead of the id. Send this or inventorylocationid, not both unless they agree. |
| itemid | integer | Reference to items, by id. Write either this or item. |
| item | string(255) | The sku of the referenced items, instead of the id. Send this or itemid, not both unless they agree. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| entrydateread-only | string | When the record was created. |
| lastchangedateread-only | string | Last modification. Drives modifiedsince. |
| cancel | boolean | Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable. |
| costmoney | string(6dp) | Stored as decimal(19,6). |
| currency | string(10) | Currency the asset was purchased in. |
| purchasedate | string | Date the asset was purchased. |
| disposeddate | string | Date the asset was disposed of. |
| serialnumber | string(255) | Serial number of the asset. |
| manufacturedate | string | Date the asset was manufactured. |
| shiptoid | integer | Shiptoid. Id only. |
| ownertype | integer | Who owns the asset: 0 = company, 1 = customer, 2 = vendor. Only company-owned fixed assets depreciate. |
| vendorid | integer | Reference to vendors, by id. Write either this or vendor. |
| vendor | string(30) | Code for the referenced vendor, instead of the id. |
| modelnumber | string(255) | Model number of the asset. |
| assettype | integer | Asset class: 0 = fixed asset, 1 = current asset, 2 = intangible asset, 3 = investment. Only fixed assets depreciate. |
| salvagevaluemoney | string(6dp) | Stored as decimal(19,6). |
| usefullifeinyearsmoney | string(6dp) | Stored as decimal(19,6). |
| assetglaccountid | integer | Reference to glaccounts, by id. Write either this or assetglaccount. |
| assetglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or assetglaccountid, not both unless they agree. |
| accumulateddepreciationglaccountid | integer | Reference to glaccounts, by id. Write either this or accumulateddepreciationglaccount. |
| accumulateddepreciationglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or accumulateddepreciationglaccountid, not both unless they agree. |
| expenseglaccountid | integer | Reference to glaccounts, by id. Write either this or expenseglaccount. |
| expenseglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or expenseglaccountid, not both unless they agree. |
| parentassetid | integer | Parentassetid. Id only. |
| invpoid | integer | Invpoid. Id only. |
| invpodetailid | integer | Invpodetailid. Id only. |
| apbillid | integer | Apbillid. Id only. |
| apbilldetailid | integer | Apbilldetailid. Id only. |
| arinvoiceid | integer | Arinvoiceid. Id only. |
| arinvoice | string(30) | The invoicenumber of the referenced invoices, instead of the id. Send this or arinvoiceid, not both unless they agree. |
| arinvoicedetailid | integer | Arinvoicedetailid. Id only. |
| arorderid | integer | Arorderid. Id only. |
| arorderdetailid | integer | Arorderdetailid. Id only. |
| clonedfromassetid | integer | Clonedfromassetid. Id only. |
| invreceiveitemtransactionid | integer | Invreceiveitemtransactionid. Id only. |
| assetitemtransactionid | integer | Assetitemtransactionid. Id only. |
| returnassetitemtransactionid | integer | Returnassetitemtransactionid. Id only. |
| jobid | integer | Jobid. Id only. |
| costcodeid | integer | Cost code. |
| costcode | string(20) | Code for the referenced costcode, instead of the id. |
| glcategoryid | integer | Glcategoryid. Id only. |
| glcategory | string(20) | The code of the referenced glcategories, instead of the id. Send this or glcategoryid, not both unless they agree. |
| depreciationcalculationmethod | integer | Depreciation method: 0 = straight line, 1 = double declining balance, 2 = units of production. |
| depreciationcalculatedasofread-only | string | Date depreciation has been calculated through. Maintained by the depreciation run, so it cannot be written through the API. |
| usefullifeinproductionunitsmoney | string(6dp) | Stored as decimal(18,6). |
| inventoryglaccountid | integer | Reference to glaccounts, by id. Write either this or inventoryglaccount. |
| inventoryglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or inventoryglaccountid, not both unless they agree. |
| expensedepreciationglaccountid | integer | Reference to glaccounts, by id. Write either this or expensedepreciationglaccount. |
| expensedepreciationglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or expensedepreciationglaccountid, not both unless they agree. |
| assetvoucherid | integer | Assetvoucherid. Id only. |
| assetvoucher | string(50) | The voucher of the referenced gltransactions, instead of the id. Send this or assetvoucherid, not both unless they agree. |
| manufacturer | string(255) | Manufacturer of the asset. |
| 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/assets' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "name": "Example name", "description": "Example description", "notes": "Example notes", "assetcategoryid": 104, "manufacturervendorid": 104, "manufacturervendor": "Example manufacturervendor" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/assets'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ 'name' => 'Example name', 'description' => 'Example description', 'notes' => 'Example notes', 'assetcategoryid' => 104, 'manufacturervendorid' => 104, 'manufacturervendor' => 'Example manufacturervendor', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/assets", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "name": "Example name", "description": "Example description", "notes": "Example notes", "assetcategoryid": 104, "manufacturervendorid": 104, "manufacturervendor": "Example manufacturervendor", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/assets', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ name: "Example name", description: "Example description", notes: "Example notes", assetcategoryid: 104, manufacturervendorid: 104, manufacturervendor: "Example manufacturervendor", }), } ); 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", description = "Example description", notes = "Example notes", assetcategoryid = 104, manufacturervendorid = 104, manufacturervendor = "Example manufacturervendor", }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/assets") { 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",
"description": "Example description",
"notes": "Example notes",
"assetcategoryid": 104,
"manufacturervendorid": 104,
"manufacturervendor": "Example manufacturervendor"
}
GET/assets/{id}
200404
Retrieve one record.
Requires scope assets: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/assets/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/assets/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/assets/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/assets/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/assets/104"); res.EnsureSuccessStatusCode();
Response 200
{
"name": "Example name",
"description": "Example description",
"notes": "Example notes",
"assetcategoryid": 104,
"manufacturervendorid": 104,
"manufacturervendor": "Example manufacturervendor"
}
PATCH/assets/{id}
200404
Update.
Requires scope assets:write.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The record id. |
Body
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| name | string(255) | Asset name. |
| description | text | Description. Stored as text, no practical length limit. |
| notes | text | Notes. Stored as text, no practical length limit. |
| assetcategoryid | integer | Assetcategoryid. Id only. |
| manufacturervendorid | integer | Reference to vendors, by id. Write either this or manufacturervendor. |
| manufacturervendor | string(30) | The vendorcode of the referenced vendors, instead of the id. Send this or manufacturervendorid, not both unless they agree. |
| inventorylocationid | integer | Inventorylocationid. Id only. |
| inventorylocation | string(20) | The locationcode of the referenced inventorylocations, instead of the id. Send this or inventorylocationid, not both unless they agree. |
| itemid | integer | Reference to items, by id. Write either this or item. |
| item | string(255) | The sku of the referenced items, instead of the id. Send this or itemid, not both unless they agree. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| entrydateread-only | string | When the record was created. |
| lastchangedateread-only | string | Last modification. Drives modifiedsince. |
| cancel | boolean | Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable. |
| costmoney | string(6dp) | Stored as decimal(19,6). |
| currency | string(10) | Currency the asset was purchased in. |
| purchasedate | string | Date the asset was purchased. |
| disposeddate | string | Date the asset was disposed of. |
| serialnumber | string(255) | Serial number of the asset. |
| manufacturedate | string | Date the asset was manufactured. |
| shiptoid | integer | Shiptoid. Id only. |
| ownertype | integer | Who owns the asset: 0 = company, 1 = customer, 2 = vendor. Only company-owned fixed assets depreciate. |
| vendorid | integer | Reference to vendors, by id. Write either this or vendor. |
| vendor | string(30) | Code for the referenced vendor, instead of the id. |
| modelnumber | string(255) | Model number of the asset. |
| assettype | integer | Asset class: 0 = fixed asset, 1 = current asset, 2 = intangible asset, 3 = investment. Only fixed assets depreciate. |
| salvagevaluemoney | string(6dp) | Stored as decimal(19,6). |
| usefullifeinyearsmoney | string(6dp) | Stored as decimal(19,6). |
| assetglaccountid | integer | Reference to glaccounts, by id. Write either this or assetglaccount. |
| assetglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or assetglaccountid, not both unless they agree. |
| accumulateddepreciationglaccountid | integer | Reference to glaccounts, by id. Write either this or accumulateddepreciationglaccount. |
| accumulateddepreciationglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or accumulateddepreciationglaccountid, not both unless they agree. |
| expenseglaccountid | integer | Reference to glaccounts, by id. Write either this or expenseglaccount. |
| expenseglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or expenseglaccountid, not both unless they agree. |
| parentassetid | integer | Parentassetid. Id only. |
| invpoid | integer | Invpoid. Id only. |
| invpodetailid | integer | Invpodetailid. Id only. |
| apbillid | integer | Apbillid. Id only. |
| apbilldetailid | integer | Apbilldetailid. Id only. |
| arinvoiceid | integer | Arinvoiceid. Id only. |
| arinvoice | string(30) | The invoicenumber of the referenced invoices, instead of the id. Send this or arinvoiceid, not both unless they agree. |
| arinvoicedetailid | integer | Arinvoicedetailid. Id only. |
| arorderid | integer | Arorderid. Id only. |
| arorderdetailid | integer | Arorderdetailid. Id only. |
| clonedfromassetid | integer | Clonedfromassetid. Id only. |
| invreceiveitemtransactionid | integer | Invreceiveitemtransactionid. Id only. |
| assetitemtransactionid | integer | Assetitemtransactionid. Id only. |
| returnassetitemtransactionid | integer | Returnassetitemtransactionid. Id only. |
| jobid | integer | Jobid. Id only. |
| costcodeid | integer | Cost code. |
| costcode | string(20) | Code for the referenced costcode, instead of the id. |
| glcategoryid | integer | Glcategoryid. Id only. |
| glcategory | string(20) | The code of the referenced glcategories, instead of the id. Send this or glcategoryid, not both unless they agree. |
| depreciationcalculationmethod | integer | Depreciation method: 0 = straight line, 1 = double declining balance, 2 = units of production. |
| depreciationcalculatedasofread-only | string | Date depreciation has been calculated through. Maintained by the depreciation run, so it cannot be written through the API. |
| usefullifeinproductionunitsmoney | string(6dp) | Stored as decimal(18,6). |
| inventoryglaccountid | integer | Reference to glaccounts, by id. Write either this or inventoryglaccount. |
| inventoryglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or inventoryglaccountid, not both unless they agree. |
| expensedepreciationglaccountid | integer | Reference to glaccounts, by id. Write either this or expensedepreciationglaccount. |
| expensedepreciationglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or expensedepreciationglaccountid, not both unless they agree. |
| assetvoucherid | integer | Assetvoucherid. Id only. |
| assetvoucher | string(50) | The voucher of the referenced gltransactions, instead of the id. Send this or assetvoucherid, not both unless they agree. |
| manufacturer | string(255) | Manufacturer of the asset. |
| 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/assets/104' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "name": "Example name", "description": "Example description", "notes": "Example notes", "assetcategoryid": 104, "manufacturervendorid": 104, "manufacturervendor": "Example manufacturervendor" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/assets/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', 'description' => 'Example description', 'notes' => 'Example notes', 'assetcategoryid' => 104, 'manufacturervendorid' => 104, 'manufacturervendor' => 'Example manufacturervendor', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.patch( "https://acme.nolapro.com/!/api/v2/assets/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "name": "Example name", "description": "Example description", "notes": "Example notes", "assetcategoryid": 104, "manufacturervendorid": 104, "manufacturervendor": "Example manufacturervendor", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/assets/104', { method: 'PATCH', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ name: "Example name", description: "Example description", notes: "Example notes", assetcategoryid: 104, manufacturervendorid: 104, manufacturervendor: "Example manufacturervendor", }), } ); 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", description = "Example description", notes = "Example notes", assetcategoryid = 104, manufacturervendorid = 104, manufacturervendor = "Example manufacturervendor", }; var req = new HttpRequestMessage(HttpMethod.Patch, "https://acme.nolapro.com/!/api/v2/assets/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",
"description": "Example description",
"notes": "Example notes",
"assetcategoryid": 104,
"manufacturervendorid": 104,
"manufacturervendor": "Example manufacturervendor"
}
DELETE/assets/{id}
200404
Cancel.
Requires scope assets: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/assets/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/assets/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/assets/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/assets/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/assets/104"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
Response 200
{
"name": "Example name",
"description": "Example description",
"notes": "Example notes",
"assetcategoryid": 104,
"manufacturervendorid": 104,
"manufacturervendor": "Example manufacturervendor"
}