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#

FieldTypeDescription
idread-onlyintegerNolaPro id.
ratemoneystring(4dp)Interest rate.
cancelbooleanTrue once cancelled. Cancelled rows stay referenced by history.
lastchangedateread-onlystringLast modification (lastchangedate). Drives modifiedsince.

Endpoints#

GET/interestchargeoptions 200403

List interest charge options.

Requires scope setup:read.

Parameters
NameInTypeNotes
cancelquerystringDefaults to false. Pass true for cancelled only, or any.
includequerystringComma-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
StatusCodeMeaning
403insufficient_scopeToken lacks interestchargeoptions:read.
curl \
  'https://acme.nolapro.com/!/api/v2/interestchargeoptions' \
  -H 'Authorization: Bearer $NP_TOKEN'
GET/interestchargeoptions/{id} 200404

Retrieve one record.

Requires scope setup:read.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
includequerystringComma-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
StatusCodeMeaning
404not_foundNo record with that id.
curl \
  'https://acme.nolapro.com/!/api/v2/interestchargeoptions/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "id": 1,
    "rate": "1.5000",
    "cancel": false
}