Finance · Accounting · Budgets
Get monthly budget amounts
Returns planned and booked amounts per month for an organization, a mandate or all mandates, and a requested range. Only months covered by a budget are returned, with bookings counted for the mandate that owns the budget. The response also counts the mandates with a budget in the range.
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.
- The caller needs
mandate.read. - The caller needs
budget.read.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
rangeobjectrequired2 properties
-
fromobjectrequired2 properties
-
yearintegerrequired2000–3000
-
monthIndexintegerrequired1–12
-
-
toobjectrequired2 properties
-
yearintegerrequired2000–3000
-
monthIndexintegerrequired1–12
-
-
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/accounting/budgets/months' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/accounting/budgets/months", {
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/YOUR_MANDATE_ID/finance/accounting/budgets/months', 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
-
mandateCountintegerat least 0
-
monthsobject[]6 properties
-
yearinteger -
monthIndexinteger1–12
-
revenueinteger -
expenseinteger -
plannedRevenueinteger -
plannedExpenseinteger
-
Response200
{
"mandateCount": 0,
"months": [
{
"year": 1,
"monthIndex": 1,
"revenue": 1,
"expense": 1,
"plannedRevenue": 1,
"plannedExpense": 1
}
]
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | Accounting plan is missing. Please make sure you have setup your finances app properly. | If the accounting plan is missing, the endpoint returns HTTP 404 with key finance.accounting.getAccountingPlan.notFound. |
| 404 | Finances settings are missing | If finances settings are missing, the endpoint returns HTTP 404 with key finance.settings.getFinancesSettings.notFound. |
Errors nearly every request can meet are listed under Errors.