Finance · Accounting · Dimensions
Create dimension
Creates an accounting dimension for an organization using a label, receipt types, required setting, and optional options. Returns the new dimension’s _id.
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.editpermission.
Request
Path parameters
-
organizationIdidrequired
Body
Content-Type: application/json
-
labelstringrequired1–64 characters
-
receiptTypesstring[]requiredat least 1 items
expenserevenueinvoicedepositdonationofferconfirmation -
requiredbooleanrequired -
optionsobject[]default
[]4 properties
-
keystringrequired1–64 characters
-
labelstringrequired1–64 characters
-
activebooleanrequired -
restrictionstringnullabledonor
-
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST '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: "POST",
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' => 'POST',
'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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
_idid
Response200
{
"_id": "000000000000000000000001"
}
What else happens
- On success, the endpoint creates an active custom dimension for the organization.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | Dimensions are not available for this product | If dimensions are not available for the product, the endpoint returns HTTP 400 with key finance.accounting.dimension.notSupportedByProduct. Only region eu |
| 400 | Only options of fund dimensions can be restricted | If any option has a non-null restriction, the endpoint returns HTTP 400 with key finance.accounting.dimension.restrictionRequiresFund. Only region us |
| 400 | An organization can have at most {{max, number}} dimensions | If the organization has reached the dimension limit, the endpoint returns HTTP 400 with key finance.accounting.dimension.limitReached. Only region us |
| 400 | Fill this dimension in the following automatic sources first: sources | If the dimension is required and automatic sources are missing a valid selection, the endpoint returns HTTP 400 with key finance.accounting.dimension.requiredBlocked. Only region us |
Marked words such as sources are filled in with the actual value when the error happens.
Errors nearly every request can meet are listed under Errors.