GL account types

The account types behind glaccounts.accounttypeid - asset, liability, income and so on. Fixed by double-entry accounting rather than by configuration, so read-only.

The object#

FieldTypeDescription
idread-onlyintegerNolaPro id.
descriptionstring(30)Name of the account type (asset, liability, income, ...).

Endpoints#

GET/glaccounttypes 200403

List gl account types.

Requires scope glaccounts:read.

Parameters
NameInTypeNotes
descriptionquerystringdescription. Partial match, case-insensitive.
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 read scope.
curl \
  'https://acme.nolapro.com/!/api/v2/glaccounttypes' \
  -H 'Authorization: Bearer $NP_TOKEN'
GET/glaccounttypes/{id} 200404

Retrieve one record.

Requires scope glaccounts: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/glaccounttypes/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "description": "Example description"
}