Interest charge options
This table has no name, code or label - it is an id and a rate. There is therefore no code sibling anywhere that references it, permanently. Read-only.
The object#
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| ratemoney | string(4dp) | Interest rate. |
| cancel | boolean | True once cancelled. Cancelled rows stay referenced by history. |
| lastchangedateread-only | string | Last modification (lastchangedate). Drives modifiedsince. |
Endpoints#
GET/interestchargeoptions
200403
List interest charge options.
Requires scope setup:read.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| cancel | query | string | Defaults to false. Pass true for cancelled only, or any. |
| 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 interestchargeoptions:read. |
curl \ 'https://acme.nolapro.com/!/api/v2/interestchargeoptions' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/interestchargeoptions'); 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/interestchargeoptions", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/interestchargeoptions', { 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/interestchargeoptions"); res.EnsureSuccessStatusCode();
GET/interestchargeoptions/{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/interestchargeoptions/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/interestchargeoptions/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/interestchargeoptions/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/interestchargeoptions/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/interestchargeoptions/104"); res.EnsureSuccessStatusCode();
Response 200
{
"id": 1,
"rate": "1.5000",
"cancel": false
}