Countries
Countries, with the number formatting NolaPro uses for each. The formatting columns are worth reading if you display amounts - they explain why a total renders differently per country.
The object#
| Field | Type | Description |
|---|---|---|
| countries_idread-only | integer | Identifier. |
| countries_name | string(64) | Country name. |
| countries_iso_code_2 | string(2) | ISO 3166-1 alpha-2. |
| countries_iso_code_3 | string(3) | ISO 3166-1 alpha-3. |
| calling_code | string(3) | International dialling prefix. |
| decimalplaces | integer | Decimal places used when displaying money. |
| decimalsymbol | string(6) | Decimal separator. |
| thousandssymbol | string(6) | Thousands separator. |
| currency_symbol | string(6) | Currency symbol shown for amounts in this country’s currency. |
| symbolafter | string(6) | Symbol goes after the amount when set. |
Endpoints#
GET/countries
200403
List countries.
Requires scope reference:read.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| 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 countries:read. |
curl \ 'https://acme.nolapro.com/!/api/v2/countries' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/countries'); 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/countries", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/countries', { 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/countries"); res.EnsureSuccessStatusCode();
GET/countries/{id}
200404
Retrieve one record.
Requires scope reference: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/countries/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/countries/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/countries/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/countries/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/countries/104"); res.EnsureSuccessStatusCode();
Response 200
{
"countries_id": 223,
"countries_name": "United States",
"countries_iso_code_2": "US",
"countries_iso_code_3": "USA",
"calling_code": "1",
"decimalplaces": 2,
"decimalsymbol": ".",
"thousandssymbol": ",",
"currency_symbol": "$",
"symbolafter": ""
}