Finance · Accounting · Dimensions
List dimensions
Lists active and inactive accounting dimensions and their options for an organization. Pass the organization ID to receive an array of dimensions.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access and the
accountingPlan.readpermission.
Request
Path parameters
-
organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/finance/accounting/dimensions' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/finance/accounting/dimensions", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/finance/accounting/dimensions', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
A list of object.
-
_idid -
labelstring1–64 characters
-
rolestringfundcustom -
receiptTypesstring[]at least 1 items
expenserevenueinvoicedepositdonationofferconfirmation -
requiredboolean -
activeboolean -
builtInboolean -
optionsobject[]4 properties
-
keystring1–64 characters
-
labelstring1–64 characters
-
activeboolean -
restrictionstringnullabledonor
-
Response200
[
{
"_id": "000000000000000000000001",
"label": "string",
"role": "fund",
"receiptTypes": [
"expense"
],
"required": true,
"active": true,
"builtIn": true,
"options": [
{
"key": "string",
"label": "string",
"active": true,
"restriction": null
}
]
}
]
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.